Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get a call recording

Returns one call recording by the recordingSid carried in webhook payloads and list responses. status: ready means the audio is fetchable through the signed-URL operation now; processing means it is still landing after the call — retry shortly. A voicemail’s recordingSid does not resolve here (the voicemail operations represent it); its audio still flows through the signed-URL operation. Requires the recordings scope.

GET/customer/phone-systems/{phoneSystemId}/recordings/{recordingSid}
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.
recordingSidstringrequired
Recording identifier from a webhook payload or a list response.
matches ^RE[0-9a-fA-F]{32}$
Responses
200The call recording, including its readiness status.
callSidstringrequired
Call identifier of the recorded call, as delivered in webhook payloads.
createdAtstring<date-time>required
When the recording was created; lists are ordered by this, descending.
durationinteger | anyrequired
Recording duration in seconds, or null while the recording is still processing and its length is not yet known.
Show properties
Any of:
integer
integer
any
any
fromstringrequired
Calling party.
phoneSystemIdstring<uuid>required
Phone system this recording belongs to.
recordingSidstringrequired
Recording identifier, as delivered in webhook payloads.
statusstringrequired
Whether the audio is fetchable yet via the signed-URL operation.
Allowed:readyprocessing
tostringrequired
Called party.
400Validation failure: recordingSid is not a valid recording identifier.
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 recordings: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 recording in this phone system — a nonexistent identifier, permanently unavailable audio, and an identifier 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/recordings/string" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "callSid": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "duration": 0,
  "from": "string",
  "phoneSystemId": "<uuid>",
  "recordingSid": "string",
  "status": "ready",
  "to": "string"
}