younifyd
Menu

Get Voice Call Event

Retrieve a voice call event

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

Use it in a workflow

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

Request

Path parameters

idintegerrequired

The ID of the voice event to retrieve.

Response

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

idinteger

ID of the event.

typestring

The voice call event type.

One ofphone-call-answeredphone-call-ringingphone-call-dial-failedphone-call-agent-dialedincoming-phone-calloutgoing-phone-callcompleted-phone-callcall-recordingmissed-phone-calldeclined-phone-callcall-ending-triggeredvoicemail-recordingphone-call-conversation-startedphone-call-forwarded-to-external-numberphone-call-forwarded-to-gorgias-numberphone-call-forwardedmessage-playedoutgoing-phone-call-connectedchild-call-not_answeredphone-call-transfer-initiatedphone-call-transfer-failedphone-call-enqueuedphone-call-enqueue-skippedphone-call-dequeuedphone-call-wrap-up-startedphone-call-wrap-up-endedivr-menu-presentedivr-option-selectedphone-call-deflected-to-smscustomer-field-conditional-evaluatedmonitoring-startedmonitoring-endedmonitoring-updated

account_idinteger

ID of the account the event belongs to.

call_idinteger

ID of the call for which the event happened.

user_idinteger

ID of the agent related to the event.

customer_idinteger

ID of the customer related to the event.

created_datetimestring (date-time)

When the event was created.

metaobject

Data associated to the event.

json
{
  "id": 123,
  "type": "completed-phone-call",
  "account_id": 234,
  "call_id": 345,
  "user_id": 456,
  "customer_id": 567,
  "created_datetime": "2023-08-31T00:00:00.000000+00:00",
  "meta": "{}"
}

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