Callbacks

TeXML Transcription

Webhook sent when a recording transcription is completed. 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.

postWebhookTexmlTranscriptionWebhook

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).

CallSidstring required

The unique identifier of the call (call_control_id).

CallSidLegacystring required

Legacy call identifier, same as CallSid.

CallStatusstring required

The status of the call.

Fromstring required

The phone number or SIP address of the caller.

RecordingSidstring required

A unique identifier for the recording that was transcribed.

RecordingUrlstring required

The URL where the recording can be accessed.

Tostring required

The phone number or SIP address that was called.

TranscriptionSidstring required

A unique identifier for the transcription.

TranscriptionStatusstring required

The status of the transcription.

TranscriptionTextstring required

The transcribed text from the recording.

Example payload

{
  "AccountSid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallStatus": "in-progress",
  "From": "+35319605860",
  "RecordingSid": "35094891-3290-4142-b2c2-b2eda57534cf",
  "RecordingUrl": "https://api.telnyx.com/v2/recordings/abc123.wav",
  "To": "+13129457420",
  "TranscriptionSid": "b08f0fa1-a32c-4218-b3b5-9cf78941ccac",
  "TranscriptionStatus": "completed",
  "TranscriptionText": "Good morning, how may I help you?"
}

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.