Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Voice Call Events

Retrieve a voice call event

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

Path parameters

idinteger required

The ID of the voice event to retrieve.

Response

The requested voice call event.

idinteger

ID of the event.

type'phone-call-answered' | 'phone-call-ringing' | 'phone-call-dial-failed' | 'phone-call-agent-dialed' | 'incoming-phone-call' | 'outgoing-phone-call' | 'completed-phone-call' | 'call-recording' | 'missed-phone-call' | 'declined-phone-call' | 'call-ending-triggered' | 'voicemail-recording' | 'phone-call-conversation-started' | 'phone-call-forwarded-to-external-number' | 'phone-call-forwarded-to-gorgias-number' | 'phone-call-forwarded' | 'message-played' | 'outgoing-phone-call-connected' | 'child-call-not_answered' | 'phone-call-transfer-initiated' | 'phone-call-transfer-failed' | 'phone-call-enqueued' | 'phone-call-enqueue-skipped' | 'phone-call-dequeued' | 'phone-call-wrap-up-started' | 'phone-call-wrap-up-ended' | 'ivr-menu-presented' | 'ivr-option-selected' | 'phone-call-deflected-to-sms' | 'customer-field-conditional-evaluated' | 'monitoring-started' | 'monitoring-ended' | 'monitoring-updated'

The voice call event type.

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.

Example response

{
  "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"
}