younifyd
Menu

Get Voice Call

Retrieve a voice call

GET/api/phone/voice-calls/{id}

Use it in a workflow

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

Request

Path parameters

idintegerrequired

The ID of the voice call to retrieve.

Response

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

idinteger

ID of the voice call.

integration_idinteger

ID of the voice integration that managed the voice call.

ticket_idinteger

ID of the ticket the voice call belongs to.

phone_number_idinteger

ID of the phone number that received or performed the voice call.

external_idstring

ID of the voice call on the provider side (Twilio, etc...).

providerstring

The voice solutions provider handling the voice call. It provides the `external_id`.

statusstring

The current status of the voice call.

One ofansweredconnectedin-progressinitiatedqueuedringingendingbusycanceledcompletedfailedno-answermissed

directionstring

Whether the voice call is received from a customer (inbound) or addressed to a customer (outbound).

One ofinboundoutbound

phone_number_sourcestring

The phone number performing the voice call.

country_sourcestring

The country code of the phone number performing the voice call.

phone_number_destinationstring

The phone number receiving the voice call.

country_destinationstring

The country code of the phone number receiving the voice call.

durationinteger

Duration in seconds of the voice call.

started_datetimestring (date-time)

When the voice call started on the provider side.

created_datetimestring (date-time)

When the voice call was created in Gorgias.

updated_datetimestring (date-time)

When the voice call was last updated.

initiated_by_agent_idinteger

The agent that initiated the voice call, only for outbound calls.

last_answered_by_agent_idinteger

The last agent that answered the voice call.

customer_idinteger

For inbound calls, the customer that initiated the voice call.For outbound calls, the customer that received the voice call.

last_rang_agent_idinteger

The last agent that received the voice call.

has_voicemailboolean

Whether the voice call has a voicemail attached.

has_call_recordingboolean

Whether the voice call has a call recording attached.

summariesarray<object>

Summaries generated of the recordings of the voice call.

idintegerrequired

ID of the voice call.

recording_idintegerrequired

ID of the recording associated to the summary.

summarystringrequired

Summary of the voice call.

created_datetimestring (date-time)required

When the summary was created.

termination_statusstring

The termination status of the voice call.

One ofansweredcancelledmissedabandonedcallback-requested

queue_idinteger

ID of the voice queue that managed the voice call.

status_in_queuestring

Sub-status of the voice call when status is Queued

answered_by_external_numberstring

The external phone number that answered the voice call when forwarded externally.

answered_by_external_customer_idinteger

The customer associated with the external number that answered the voice call.

monitoring_statusstring | null

Which type of monitoring is being currently performed on the call, if any.

One oflisteningwhisperingnone

last_monitoring_agent_idinteger | null

The id of the last agent that was monitoring the call.

json
{
  "id": 123,
  "integration_id": 234,
  "external_id": "CA777a8b2bfef8cdf709896080fe94cd10",
  "provider": "twilio",
  "status": "completed",
  "direction": "inbound",
  "created_datetime": "2023-08-31T00:00:00.000000+00:00",
  "ticket_id": 345,
  "phone_number_id": 456,
  "phone_number_source": "+14791234567",
  "country_source": "US",
  "phone_number_destination": "+17201234567"
}

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