API Reference

The VoiceCall object

A voice call represents a phone call received from a customer (inbound) or addressed to a customer (outbound).

VoiceCall properties

integer

ID of the voice call.

integer

ID of the voice integration that managed the voice call.

integer

ID of the ticket the voice call belongs to.

integer

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

string

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

string

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

string

The current status of the voice call.

string

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

string

The phone number performing the voice call.

string

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

string

The phone number receiving the voice call.

string

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

integer

Duration in seconds of the voice call.

ISO 8601 datetime

When the voice call started on the provider side.

ISO 8601 datetime

When the voice call was created in Gorgias.

ISO 8601 datetime

When the voice call was last updated.

integer

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

integer

The last agent that answered the voice call, only for inbound calls.

integer

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

boolean

Whether the voice call has a voicemail attached.

boolean

Whether the voice call has a call recording attached.

VoiceCall example object

{
  "id": 123,
  "integration_id": 234,
  "ticket_id": 345,
  "phone_number_id": 456,
  "external_id": "CA777a8b2bfef8cdf709896080fe94cd10",
  "provider": "twilio",
  "status": "completed",
  "direction": "inbound",
  "phone_number_source": "+14791234567",
  "country_source": "US",
  "phone_number_destination": "+17201234567",
  "country_destination": "US",
  "duration": 60,
  "started_datetime": "2023-08-31T00:00:00.000000+00:00",
  "created_datetime": "2023-08-31T00:00:00.000000+00:00",
  "updated_datetime": "2023-08-31T00:00:00.000000+00:00",
  "initiated_by_agent_id": 567,
  "last_answered_by_agent_id": 678,
  "customer_id": 789,
  "has_voicemail": true,
  "has_call_recording": false
}