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

Call Hangup · 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.hangup

Example:

"call.hangup"

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

Call ID used to issue commands via Call Control API.

Example:

"v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"

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:

"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

State received from a command.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

data.payload.custom_headers

Custom SIP Header · object[]

Custom headers set on answer command

Show child attributes

data.payload.custom_headers.name

string

required

The name of the header to add.

Example:

"head_1"

data.payload.custom_headers.value

string

required

The value of the header.

Example:

"val_1"

Example:

[
  { "name": "head_1", "value": "val_1" },
  { "name": "head_2", "value": "val_2" }
]

data.payload.sip_headers

SIP Header · object[]

User-to-User and Diversion headers from sip invite.

Show child attributes

data.payload.sip_headers.name

enum<string>

required

The name of the header to add.

Available options:

User-to-User

Example:

"User-to-User"

data.payload.sip_headers.value

string

required

The value of the header.

Example:

"value"

Example:

[
  { "name": "User-to-User", "value": "1234" },
  {
    "name": "Diversion",
    "value": "<sip:111@192.168.1.1>"
  }
]

data.payload.from

string

Number or SIP URI placing the call.

Example:

"+35319605860"

data.payload.to

string

Destination number or SIP URI of the call.

Example:

"+13129457420"

data.payload.start_time

string<date-time>

ISO 8601 datetime of when the call started.

Example:

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

data.payload.state

enum<string>

State received from a command.

Available options:

hangup

Example:

"hangup"

data.payload.tags

string[]

Array of tags associated to number.

Example:

["tag-01", "tag-02"]

data.payload.hangup_cause

enum<string>

The reason the call was ended (call_rejected, normal_clearing, originator_cancel, timeout, time_limit, user_busy, not_found or unspecified).

Available options:

call_rejected,

normal_clearing,

originator_cancel,

timeout,

time_limit,

user_busy,

not_found,

unspecified

Example:

"call_rejected"

data.payload.hangup_source

enum<string>

The party who ended the call (callee, caller, unknown).

Available options:

caller,

callee,

unknown

Example:

"caller"

data.payload.sip_hangup_cause

string

The reason the call was ended (SIP response code). If the SIP response is unavailable (in inbound calls for example) this is set to unspecified.

Example:

"603"

data.payload.call_quality_stats

object

Call quality statistics aggregated from the CHANNEL_HANGUP_COMPLETE event. Only includes metrics that are available (filters out nil values). Returns nil if no metrics are available.

Show child attributes

data.payload.call_quality_stats.inbound

object

Inbound call quality statistics.

Show child attributes

data.payload.call_quality_stats.inbound.jitter_max_variance

string

Maximum jitter variance for inbound audio.

Example:

"2.74"

data.payload.call_quality_stats.inbound.jitter_packet_count

string

Number of packets used for jitter calculation on inbound audio.

Example:

"0"

data.payload.call_quality_stats.inbound.mos

string

Mean Opinion Score (MOS) for inbound audio quality.

Example:

"4.50"

data.payload.call_quality_stats.inbound.packet_count

string

Total number of inbound audio packets.

Example:

"591"

data.payload.call_quality_stats.inbound.skip_packet_count

string

Number of skipped inbound packets (packet loss).

Example:

"9"

data.payload.call_quality_stats.outbound

object

Outbound call quality statistics.

Show child attributes

data.payload.call_quality_stats.outbound.packet_count

string

Total number of outbound audio packets.

Example:

"0"

data.payload.call_quality_stats.outbound.skip_packet_count

string

Number of skipped outbound packets (packet loss).

Example:

"0"

Example:

{
  "inbound": {
    "jitter_max_variance": "2.74",
    "jitter_packet_count": "0",
    "mos": "4.50",
    "packet_count": "591",
    "skip_packet_count": "9"
  },
  "outbound": {
    "packet_count": "0",
    "skip_packet_count": "0"
  }
}

Example:

{
  "record_type": "event",
  "event_type": "call.hangup",
  "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "occurred_at": "2018-02-02T22:25:27.521992Z",
  "payload": {
    "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "from": "+35319605860",
    "to": "+35319605860",
    "start_time": "2018-02-02T22:20:27.521992Z",
    "state": "hangup",
    "hangup_cause": "call_rejected",
    "hangup_source": "caller",
    "sip_hangup_cause": "603",
    "call_quality_stats": {
      "inbound": {
        "jitter_max_variance": "2.74",
        "jitter_packet_count": "0",
        "mos": "4.50",
        "packet_count": "591",
        "skip_packet_count": "9"
      },
      "outbound": {
        "packet_count": "0",
        "skip_packet_count": "0"
      }
    }
  }
}

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