Get Voice Call Recording

Retrieve a voice call recording

GET/api/phone/voice-call-recordings/{id}

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the Get Voice Call Recording action (under Voice Call Recordings).
Fill in the fields below, then reference the result from later steps as {{getVoiceCallRecording.response.data}}.

Request

Path parameters

idintegerrequired

The ID of the voice call recording to retrieve.

Response

Returns 200 with an object. Read it in later steps with {{getVoiceCallRecording.response.data.<field>}}.

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.

typestring

Whether this is a voicemail or a call recording.

One ofcall-recordingvoicemail

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_codestring

Reason why the URL could not be provided.

One ofRECORDING_IS_PRIVATE

transcription_statusstring

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

One ofrequestedcompletedfailedrecording_too_shortrecording_too_longnulllow_quality_transcription

json

{
  "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",
  "deleted_by_user_id": 0,
  "error_code": "RECORDING_IS_PRIVATE",
  "transcription_status": "completed"
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?