v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Voice Call Recordings

List voice call recordings

List voice call recordings matching the given parameters, paginated, and ordered.

get/api/phone/voice-call-recordings

Query parameters

cursorstring

Example:cHJldl9fNl9fMjAyMS0wMy0wMyAwNjowMDowMA==

Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.

limitinteger

Maximum number of items to return.

call_idinteger

Response

List of voice call recordings according to the given criteria.

idinteger

ID of the voicemail or call recording.

call_idinteger

ID of the voice call the voicemail or call recording belongs to.

external_idstring

ID of the voicemail or call recording on the provider side (Twilio, etc...).

urlstring

Voicemail or call recording direct access URL.

durationinteger

Duration in seconds of the voicemail or call recording.

type'call-recording' | 'voicemail'

Whether this is a voicemail or a call recording.

created_datetimestring date-time

When the voicemail or call recording was created.

deleted_datetimestring date-time

When the voicemail or call recording was deleted, if deleted.

deleted_by_user_idinteger

Which agent deleted the voicemail or call recording, if deleted.

error_code'RECORDING_IS_PRIVATE' nullable

Reason why the URL could not be provided.

transcription_statusstring

The status of the transcription of the voicemail or call recording.

Example response

[
  {
    "id": 123,
    "call_id": 234,
    "external_id": "REe51e36db1c44458d8a173959d4affc71",
    "url": "https://uploads.gorgias.io/GRO7iuEcV1WHfQvm/phone-REe51e36db1c44458d8a173959d4affc71-2fee010d-489b-473f-851c-b50eb3182b2e.mp3",
    "duration": 20,
    "type": "voicemail",
    "created_datetime": "2023-08-31T00:00:00.000000+00:00",
    "deleted_datetime": "2023-08-31T00:00:00.000000+00:00",
    "error_code": "RECORDING_IS_PRIVATE",
    "transcription_status": "completed"
  }
]