Calls
Retrieve a call recording URL
GET/v1/calls/{call_id}/recording-url
Generate a signed URL for the call recording.
Returns a short-lived (1 hour) signed URL for the recording's audio file. With no format the response is exactly {"url": ...}. format=m4a serves an AAC copy that Apple devices can play, made on demand; the response then also carries format. 503 RECORDING_TRANSCODE_FAILED (retryable, the original recording is still available) means the copy could not be made.
If there is no file to serve, 404 RECORDING_NOT_FOUND means the call has no recording and retrying will not help. 404 RECORDING_NOT_READY means a recording is still being processed: retry after Retry-After; partner subscriptions can also wait for call.recording.ready once webhook delivery is live. 503 RECORDING_UNAVAILABLE is a temporary failure: retry after Retry-After.
Headers
AuthorizationstringRequiredApiKey $ENTROVOX_KEY. Keys are issued per organization.Path parameters
call_idstringRequiredQuery parameters
formatstring or nullOptionalogg (the default, and what every client that omits this gets) or m4a (AAC in MP4, for iOS). The response names the format actually served; an m4a request is answered with ogg for a recording over the size cap.One ofoggm4a
Returns
200 OKSuccessful Response
formatstringMay be absentOne ofoggm4a
urlstringAlways presentErrors
- 404
CALL_NOT_FOUNDNo call with that id in your organization.
Retrying will fail the same way. Fix the request, or contact us.
- 404
RECORDING_NOT_FOUNDThe call has no recording, or its file is missing.
Retrying will fail the same way. Fix the request, or contact us.
- 404
RECORDING_NOT_READYThe call has a recording that is still being processed. Retry after Retry-After, or wait for call.recording.ready (partner subscriptions, once webhook delivery is live).
Retry after the time in details.next_attempt_local when present. Otherwise retry when the blocking condition ends, as the meaning says.
- 422
VALIDATION_ERRORA field is missing or invalid, such as a bad E.164 phone or a missing external_id. param names the field.
Retrying will fail the same way. Fix the request, or contact us.
- 503
RECORDING_TRANSCODE_FAILEDThe recording could not be prepared as m4a. Retry after Retry-After, or use the Ogg recording.
Safe to retry after Retry-After when present, otherwise back off. On a POST, resend the same Idempotency-Key and body.
- 503
RECORDING_UNAVAILABLEThe recording exists but a signed link could not be made right now. Retry after Retry-After.
Safe to retry after Retry-After when present, otherwise back off. On a POST, resend the same Idempotency-Key and body.
Any request can also return AUTHENTICATION_REQUIRED, TOKEN_INVALID, API_KEY_EXPIRED, RATE_LIMIT_EXCEEDED or INTERNAL_ERROR.