Skip to main content
WEBHOOK
TexmlReferStatusWebhook
{
  "AccountSid": "f5586561-8ff0-4291-a51b-c7dfe4139ff9",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "ReferCallStatus": "in-progress",
  "Timestamp": "2024-01-15T10:30:00Z",
  "NotifySipResponseCode": "200",
  "ReferSipResponseCode": "202"
}

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 SIP REFER status updates.

​
AccountSid
string
required

The unique identifier of the account (user_id).

Example:

"f5586561-8ff0-4291-a51b-c7dfe4139ff9"

​
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"

​
ReferCallStatus
enum<string>
required

The status of the SIP REFER operation.

Available options:
failed,
in-progress,
busy,
canceled
Example:

"in-progress"

​
Timestamp
string<date-time>
required

The timestamp when the event occurred.

Example:

"2024-01-15T10:30:00Z"

​
NotifySipResponseCode
string

The SIP response code from the NOTIFY message (conditional, only present on success).

Example:

"200"

​
ReferSipResponseCode
string

The SIP response code from the REFER message (conditional, only present on success).

Example:

"202"

Response

200

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