Texml call ringing

Webhook sent when a TeXML call is ringing. This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.

WEBHOOK TexmlCallRingingWebhook

Example

{
  "AccountSid": "f5586561-8ff0-4291-a51b-c7dfe4139ff9",
  "CallDuration": "10",
  "CallInitiatedAt": "2024-01-15T10:30:26.028Z",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallStatus": "ringing",
  "CallbackSource": "call-progress-events",
  "CallerId": "John Doe",
  "ConnectionId": "1234567890",
  "ErrorCode": "10001",
  "ErrorMessage": "Call failed",
  "From": "[phone]",
  "ParentCallSid": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "ParentCallSidLegacy": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "SequenceNumber": 1,
  "ShakenStirAttestation": "A",
  "ShakenStirValidated": true,
  "Timestamp": "2024-01-15T10:30:00Z",
  "To": "[phone]"
}

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 when a TeXML call is ringing.

AccountSid · string · required

The unique identifier of the account (user_id).

Example:

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

CallInitiatedAt · string<date-time> · required

The timestamp when the call was initiated.

Example:

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

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"

CallStatus · enum<string> · required

The status of the call.

Available options: ringing

Example:

"ringing"

CallbackSource · enum<string> · required

The source of the callback.

Available options: call-progress-events

Example:

"call-progress-events"

ConnectionId · string · required

The unique identifier of the connection.

Example:

"1234567890"

From · string · required

The phone number or SIP address of the caller.

Example:

"[phone]"

SequenceNumber · integer · required

The sequence number of the event.

Example:

"1"

Timestamp · string<date-time> · required

The UTC timestamp when the webhook was generated.

Example:

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

To · string · required

The phone number or SIP address that was called.

Example:

"[phone]"

CallDuration · string

The duration of the call in seconds (conditional, only present if start_time and end_time are available).

Example:

"10"

CallerId · string

The display name of the caller.

Example:

"John Doe"

ErrorCode · string

Error code if an error occurred (conditional).

Example:

"10001"

ErrorMessage · string

Error message if an error occurred (conditional).

Example:

"Call failed"

ParentCallSid · string

The unique identifier of the parent call that initiated this outbound call (conditional, only present for outbound calls initiated via Dial).

Example:

"v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"

ParentCallSidLegacy · string

Legacy parent call identifier, same as ParentCallSid (conditional, only present for outbound calls initiated via Dial).

Example:

"v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"

ShakenStirAttestation · string

SHAKEN/STIR attestation level (conditional, only present if shaken_stir_data is available).

Example:

"A"

ShakenStirValidated · boolean

Whether SHAKEN/STIR validation passed (conditional, only present if shaken_stir_data is available).

Example:

"true"

Response

200

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