Skip to main content
WEBHOOK
TexmlTranscriptionWebhook
{
  "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?"
}

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 recording transcription is completed.

​
AccountSid
string
required

The unique identifier of the account (user_id).

Example:

"61bf923e-5e4d-4595-a110-56190ea18a1b"

​
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
string
required

The status of the call.

Example:

"in-progress"

​
From
string
required

The phone number or SIP address of the caller.

Example:

"+35319605860"

​
RecordingSid
string
required

A unique identifier for the recording that was transcribed.

Example:

"35094891-3290-4142-b2c2-b2eda57534cf"

​
RecordingUrl
string
required

The URL where the recording can be accessed.

Example:

"https://api.telnyx.com/v2/recordings/abc123.wav"

​
To
string
required

The phone number or SIP address that was called.

Example:

"+13129457420"

​
TranscriptionSid
string
required

A unique identifier for the transcription.

Example:

"b08f0fa1-a32c-4218-b3b5-9cf78941ccac"

​
TranscriptionStatus
string
required

The status of the transcription.

Example:

"completed"

​
TranscriptionText
string
required

The transcribed text from the recording.

Example:

"Good morning, how may I help you?"

Response

200

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