Skip to main content
WEBHOOK
TexmlQueueWebhook
{
  "AccountSid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
  "AvgQueueTime": "45",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "ConnectionId": "1234567890",
  "CurrentQueueSize": "3",
  "From": "+35319605860",
  "QueuePosition": "2",
  "QueueSid": "my-queue",
  "QueueTime": "30",
  "To": "+13129457420"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
telnyx-timestamp
integer<int64>
required

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp Unix timestamp for replay attack prevention

​
telnyx-signature-ed25519
string
required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/x-www-form-urlencoded

Webhook sent for queue status events (triggered by Enqueue command waitUrl).

​
AccountSid
string
required

The unique identifier of the account (user_id).

Example:

"4e71926f-8f13-450e-b91c-23c2ef786aa6"

​
AvgQueueTime
string
required

The average wait time in seconds for the queue.

Example:

"45"

​
CallSid
string
required

The unique identifier of the call (call_control_id).

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

​
CallSidLegacy
string
required

Legacy call identifier, same as CallSid.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

​
ConnectionId
string
required

The unique identifier of the connection.

Example:

"1234567890"

​
CurrentQueueSize
string
required

The current number of calls in the queue.

Example:

"3"

​
From
string
required

The phone number or SIP address of the caller.

Example:

"+35319605860"

​
QueuePosition
string
required

The current position of the call in the queue.

Example:

"2"

​
QueueSid
string
required

The unique identifier of the queue.

Example:

"my-queue"

​
QueueTime
string
required

The time in seconds the call has been in the queue.

Example:

"30"

​
To
string
required

The phone number or SIP address that was called.

Example:

"+13129457420"

Response

200

The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.