Texml gather

Webhook sent when a Gather command completes (sent to the action URL). 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 TexmlGatherWebhook

Example

{
  "AccountSid": "cb6cfbbc-eb00-41af-a3f3-0d7b32009e4b",
  "CallSid": "v2:DPNqxVjTNtQYaKdcKbU0QgRFrQ3YzuAQrVYC4Ggcuq7zTpDkUB7A4w",
  "CallSidLegacy": "v2:DPNqxVjTNtQYaKdcKbU0QgRFrQ3YzuAQrVYC4Ggcuq7zTpDkUB7A4w",
  "Confidence": 0.95,
  "Digits": "1",
  "From": "[e-mail]",
  "SpeechResult": "Please connect me to sales",
  "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 Gather command completes (sent to the action URL).

AccountSid · string · required

The unique identifier of the account (user_id).

Example:

"cb6cfbbc-eb00-41af-a3f3-0d7b32009e4b"

CallSid · string · required

The unique identifier of the call (call_control_id).

Example:

"v2:DPNqxVjTNtQYaKdcKbU0QgRFrQ3YzuAQrVYC4Ggcuq7zTpDkUB7A4w"

CallSidLegacy · string · required

Legacy call identifier, same as CallSid.

Example:

"v2:DPNqxVjTNtQYaKdcKbU0QgRFrQ3YzuAQrVYC4Ggcuq7zTpDkUB7A4w"

From · string · required

The phone number or SIP address of the caller.

Example:

"[e-mail]"

To · string · required

The phone number or SIP address that was called.

Example:

"[phone]"

Confidence · number

The average confidence score of the speech transcription (conditional, only present when input is speech).

Example:

"0.95"

Digits · string

The DTMF digits collected by the Gather command (conditional, only present when input is dtmf).

Example:

"1"

SpeechResult · string

The transcribed text from speech input (conditional, only present when input is speech).

Example:

"Please connect me to sales"

Response

200

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