call.ringing

POST

The far end is ringing.

Authorizations

• bearerAuth

Parameters

Header Parameters

webhook-id

required

string

The event ID (evt_…); the same on every retry. Deduplicate on it.

Example

evt_3fT9kq2ZpLr8YwVbN1cX0a

webhook-timestamp

required

string

Unix seconds of this delivery attempt. Reject deliveries more than 5 minutes old.

Example

1762161262

webhook-signature

required

string

Space-separated v1,<base64 HMAC-SHA256> signatures of <webhook-id>.<webhook-timestamp>.<body> with the endpoint secret (two while a secret rotates).

Example

v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4=

Request Body^required

Media typeapplication/json

The far end is ringing.

object

api_version

required

The API version the payload is rendered in (the endpoint’s pinned version).

string

created

required

An ISO-8601 timestamp in UTC.

string format: date-time

data

required

object is the object the call.ringing event is about.

object

object

required

object

agent_id

Any of:

string

string

>= 1 characters /^usr_[0-9A-Za-z]+$/

null

null

answered_at

string | null

answered_by

Any of:

string

string

Allowed values: human machine unknown

null

null

assistant_id

Any of:

string

string

>= 1 characters /^asst_[0-9A-Za-z]+$/

null

null

campaign_id

Any of:

string

string

>= 1 characters /^cmp_[0-9A-Za-z]+$/

null

null

contact_id

Any of:

string

string

>= 1 characters /^ctc_[0-9A-Za-z]+$/

null

null

direction

Any of:

string

string

Allowed values: inbound outbound browser

null

null

duration_ms

Any of:

integer

integer

<= 9007199254740991

null

null

end_reason

string | null

ended_at

string | null

flow_id

Any of:

string

string

>= 1 characters /^flow_[0-9A-Za-z]+$/

null

null

from

string | null

id

string

>= 1 characters /^call_[0-9A-Za-z]+$/

metadata

object

key

additional properties

object

string

Allowed value: call

queue_id

Any of:

string

string

>= 1 characters /^q_[0-9A-Za-z]+$/

null

null

started_at

string | null

status

string

to

string | null

key

additional properties

previous_attributes

For *.updated-style events: the changed attributes’ previous values.

object

key

additional properties

id

required

The event ID. Receivers deduplicate on it (it is also the webhook-id header).

string

/^evt_[0-9A-Za-z]+$/

livemode

required

true in live mode, false in test mode.

boolean

object

required

string

Allowed value: event

org_id

required

The organisation the event belongs to.

string

/^org_[0-9A-Za-z]+$/

request

object

id

required

Any of:

string

The API request that caused the event (its X-Request-Id), if any.

string

/^req_[0-9A-Za-z]+$/

null

null

idempotency_key

required

That request’s Idempotency-Key, if any.

string | null

type

required

string

Allowed value: call.ringing

Responses

2XX

Acknowledge the event with any 2xx status within 15 seconds. Anything else, or a timeout, is retried for up to 72 hours.