Callbacks

TeXML Call DTMF

Webhook sent when a DTMF digit is received during a TeXML call. 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.

postWebhookTexmlCallDtmfWebhook

Headers

telnyx-timestampinteger required

Unix timestamp for replay attack prevention

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

telnyx-signature-ed25519string required

Ed25519 signature of timestamp|payload for verification

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature

Payload application/x-www-form-urlencoded

AccountSidstring required

The unique identifier of the account (user_id).

CallInitiatedAtstring date-time required

The timestamp when the call was initiated.

CallSidstring required

The unique identifier of the call (call_control_id).

CallSidLegacystring required

Legacy call identifier, same as CallSid.

CallStatus'dtmf' required

The status of the call.

CallbackSource'call-progress-events' required

The source of the callback.

CallerIdstring

The display name of the caller.

ConnectionIdstring required

The unique identifier of the connection.

Digitstring required

The DTMF digit that was pressed (0-9, *,

ErrorCodestring

Error code if an error occurred (conditional).

ErrorMessagestring

Error message if an error occurred (conditional).

Fromstring required

The phone number or SIP address of the caller.

ParentCallSidstring

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

ParentCallSidLegacystring

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

SequenceNumberinteger required

The sequence number of the event.

ShakenStirAttestationstring

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

ShakenStirValidatedboolean

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

Timestampstring date-time required

The UTC timestamp when the webhook was generated.

Tostring required

The phone number or SIP address that was called.

Example payload

{
  "AccountSid": "f5586561-8ff0-4291-a51b-c7dfe4139ff9",
  "CallInitiatedAt": "2024-01-15T10:30:26.028Z",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallStatus": "dtmf",
  "CallbackSource": "call-progress-events",
  "CallerId": "John Doe",
  "ConnectionId": "1234567890",
  "Digit": "5",
  "ErrorCode": "10001",
  "ErrorMessage": "Call failed",
  "From": "+35319605860",
  "ParentCallSid": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "ParentCallSidLegacy": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "ShakenStirAttestation": "A",
  "Timestamp": "2024-01-15T10:30:00Z",
  "To": "+13129457420"
}

Response

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

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.