Telnyx

POST

transcription

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/json

data

Transcription · object

Show child attributes

data.record_type

enum<string>

Identifies the type of the resource.

Available options:

event

Example:

"event"

data.event_type

enum<string>

The type of event being delivered.

Available options:

call.transcription

Example:

"call.transcription"

data.id

string<uuid>

Identifies the type of resource.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.occurred_at

string<date-time>

ISO 8601 datetime of when the event occurred.

Example:

"2018-02-02T22:25:27.521992Z"

data.payload

object

Show child attributes

data.payload.call_control_id

string

Unique identifier and token for controlling the call.

Example:

"v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"

data.payload.call_leg_id

string

ID that is unique to the call and can be used to correlate webhook events.

Example:

"428c31b6-7af4-4bcb-b7f5-5013ef9657c1"

data.payload.call_session_id

string

ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.

Example:

"428c31b6-abf3-3bc1-b7f4-5013ef9657c1"

data.payload.client_state

string

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

data.payload.connection_id

string

Call Control App ID (formerly Telnyx connection ID) used in the call.

Example:

"7267xxxxxxxxxxxxxx"

data.payload.transcription_data

object

Show child attributes

data.payload.transcription_data.confidence

number<double>

Speech recognition confidence level.

Example:

0.977219

data.payload.transcription_data.is_final

boolean

When false, it means that this is an interim result.

Example:

true

data.payload.transcription_data.transcript

string

Recognized text.

Example:

"hello this is a test speech"

data.payload.transcription_data.transcription_track

enum<string>

Indicates which leg of the call has been transcribed. This is only available when transcription_engine is set to B.

Available options:

inbound,

outbound

Example:

"inbound"

Example:

{
  "record_type": "event",
  "event_type": "call.transcription",
  "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "occurred_at": "2018-02-02T22:25:27.521992Z",
  "payload": {
    "call_control_id": "v2:7subYr8fLrXmaAXm8egeAMpoSJ72J3SGPUuome81-hQuaKRf9b7hKA",
    "call_leg_id": "5ca81340-5beb-11eb-ae45-02420a0f8b69",
    "call_session_id": "5ca81eee-5beb-11eb-ba6c-02420a0f8b69",
    "connection_id": "1240401930086254526",
    "transcription_data": {
      "confidence": 0.977219,
      "is_final": true,
      "transcript": "hello this is a test speech"
    }
  }
}

Response

200

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

Streaming stopped Dial

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Transcription

Authorizations

Headers

Body

Response