Telnyx

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

Streaming Failed · object

Show child attributes

data.record_type

enum<string>

Identifies the resource.

Available options:

event

Example:

"event"

data.event_type

enum<string>

The type of event being delivered.

Available options:

streaming.failed

Example:

"streaming.failed"

data.id

string<uuid>

Identifies the type of resource.

Example:

"25dc3731-e51e-4927-a50d-a61cc25984b1"

data.occurred_at

string<date-time>

ISO 8601 datetime of when the event occurred.

Example:

"2021-12-15T14:11:24.613295Z"

data.payload

object

Show child attributes

data.payload.call_control_id

string

Call ID used to issue commands via Call Control API.

Example:

"31f19208-5db0-11ec-9ea7-02420a0d3a69"

data.payload.connection_id

string

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

Example:

"7267xxxxxxxxxxxxxx"

data.payload.call_leg_id

string

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

Example:

"31f19208-5db0-11ec-9ea7-02420a0d3a69"

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:

"31f19208-5db0-11ec-9ea7-02420a0d3a69"

data.payload.client_state

string

State received from a command.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

data.payload.failure_reason

string

A short description explaning why the media streaming failed.

Example:

"connection_failed"

data.payload.stream_id

string<uuid>

Identifies the streaming.

Example:

"1edb94f9-7ef0-4150-b502-e0ebadfd9491"

data.payload.stream_params

object

Streaming parameters as they were originally given to the Call Control API.

Show child attributes

data.payload.stream_params.stream_url

string

The destination WebSocket address where the stream is going to be delivered.

Example:

"wss://www.example.com/websocket"

data.payload.stream_params.track

enum<string>

default:inbound_track

Specifies which track should be streamed.

Available options:

inbound_track,

outbound_track,

both_tracks

Example:

"inbound_track"

data.payload.stream_type

enum<string>

The type of stream connection the stream is performing.

Available options:

websocket,

dialogflow

Example:

"websocket"

Example:

{
  "record_type": "event",
  "event_type": "streaming.failed",
  "id": "25dc3731-e51e-4927-a50d-a61cc25984b1",
  "occurred_at": "2021-12-15T14:11:24.613295Z",
  "payload": {
    "call_control_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "call_leg_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
    "call_session_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "failure_reason": "connection_failed",
    "stream_id": "1edb94f9-7ef0-4150-b502-e0ebadfd9491",
    "stream_params": {
      "stream_url": "wss://www.example.com/websocket",
      "stream_track": "inbound_track"
    },
    "stream_type": "websocket"
  }
}

Response

200

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

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup