Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get a call log

Returns one call log by the callLogId carried in webhook payloads and list responses, including the transcript when one is currently stored. transcriptionStatus reports whether transcript text is retrievable right now: a transcript removed by retention or explicit deletion reads unavailable even though the transcription itself once finished. Requires the calls scope.

GET/customer/phone-systems/{phoneSystemId}/call-logs/{callLogId}
Authorization
X-API-KeyAPI key · headerrequired
API key (sk_phones_* prefix) for programmatic access
Path parameters
phoneSystemIdstring<uuid>required
Phone system identifier, discoverable via the accessible phone systems operation.
callLogIdstring<uuid>required
Call log identifier from a webhook payload or a list response.
Responses
200The call log, with its transcript when transcription completed.
callSidstringrequired
Call identifier, as delivered in webhook payloads.
createdAtstring<date-time>required
When the row was created; lists are ordered by this, descending.
directionstringrequired
Call direction.
Allowed:inboundoutboundinternal
durationinteger | anyrequired
Call duration in seconds.
Show properties
Any of:
integer
integer
any
any
endTimestring<date-time> | anyrequired
When the call ended.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
fromstringrequired
Calling party.
fromNamestring | anyrequired
Caller name, when known.
Show properties
Any of:
string
string
any
any
idstring<uuid>required
Call log identifier — the callLogId carried by webhook payloads.
outcomestring | anyrequired
Call outcome (answered, missed, abandoned, voicemail, transferred, …).
Show properties
Any of:
string
string
any
any
parentCallSidstring | anyrequired
Parent call identifier when this row is a transferred or forwarded leg.
Show properties
Any of:
string
string
any
any
phoneSystemIdstring<uuid>required
Phone system this call belongs to.
recordingDurationinteger | anyrequired
Recording duration in seconds.
Show properties
Any of:
integer
integer
any
any
recordingSidstring | anyrequired
Recording identifier when the call was recorded — fetch via the recordings operations.
Show properties
Any of:
string
string
any
any
startTimestring<date-time> | anyrequired
When the call started.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
statusstringrequired
Call status (completed, no-answer, busy, failed, canceled).
tostringrequired
Called party.
transcribedTextstring | anyrequired
Call transcript text, or null when no transcript is currently stored.
Show properties
Any of:
string
string
any
any
transcriptionStatusstringrequired
Whether transcript text is retrievable right now: completed, processing (keep polling), failed, or unavailable. A transcript removed by retention or explicit deletion reads unavailable even though the transcription itself once finished.
Allowed:completedprocessingfailedunavailable
400Validation failure: callLogId is not a UUID.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
401The API key is missing, malformed, expired, or revoked.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
403The key lacks the calls:read scope, or is not a tenant API key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
404No such call log in this phone system — a nonexistent id and an id belonging to another phone system are indistinguishable — or the phone system itself is not covered by the key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
Request
curl -X GET "https://api.steerphones.com/v1/customer/phone-systems/%3Cuuid%3E/call-logs/%3Cuuid%3E" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "callSid": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "direction": "inbound",
  "duration": 0,
  "endTime": "2024-01-01T00:00:00Z",
  "from": "string",
  "fromName": "string",
  "id": "<uuid>",
  "outcome": "string",
  "parentCallSid": "string",
  "phoneSystemId": "<uuid>",
  "recordingDuration": 0,
  "recordingSid": "string",
  "startTime": "2024-01-01T00:00:00Z",
  "status": "string",
  "to": "string",
  "transcribedText": "string",
  "transcriptionStatus": "completed"
}