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

Conference Recording Saved · 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:

conference.recording.saved

Example:

"conference.recording.saved"

data.id

string<uuid>

Identifies the type of resource.

Example:

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

data.payload

object

Show child attributes

data.payload.call_control_id

string

Participant's call ID used to issue commands via Call Control API.

Example:

"v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"

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

enum<string>

Whether recording was recorded in single or dual channel.

Available options:

single,

dual

Example:

"single"

data.payload.conference_id

string<uuid>

ID of the conference that is being recorded.

Example:

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

data.payload.connection_id

string

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

Example:

"7267xxxxxxxxxxxxxx"

data.payload.format

enum<string>

The audio file format used when storing the call recording. Can be either mp3 or wav.

Available options:

wav,

mp3

Example:

"mp3"

data.payload.public_recording_urls

object

Recording URLs in requested format. The URL is valid for as long as the file exists. For security purposes, this feature is activated on a per request basis. Please contact customer support with your Account ID to request activation.

Show child attributes

data.payload.public_recording_urls.mp3

string | null

Recording URL in requested mp3 format.

Example:

"http://example.com/recording.mp3"

data.payload.public_recording_urls.wav

string | null

Recording URL in requested wav format.

Example:

"http://example.com/recording.wav"

data.payload.recording_ended_at

string<date-time>

ISO 8601 datetime of when recording ended.

Example:

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

data.payload.recording_id

string<uuid>

ID of the conference recording.

Example:

"4577f9a2-cf0e-44f3-ac57-9f95fb03fa47"

data.payload.recording_started_at

string<date-time>

ISO 8601 datetime of when recording started.

Example:

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

data.payload.recording_urls

object

Recording URLs in requested format. These URLs are valid for 10 minutes. After 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings documentation, or via Mission Control under Reporting -> Recordings.

Show child attributes

data.payload.recording_urls.mp3

string | null

Recording URL in requested mp3 format.

Example:

"http://example.com/recording.mp3"

data.payload.recording_urls.wav

string | null

Recording URL in requested wav format.

Example:

"http://example.com/recording.wav"

Example:

{
  "record_type": "event",
  "event_type": "conference.recording.saved",
  "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "occurred_at": "2018-02-02T22:25:27.521992Z",
  "payload": {
    "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "channels": "single",
    "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "format": "mp3",
    "public_recording_urls": {
      "mp3": "http://example.com/recording.mp3",
      "wav": "http://example.com/recording.wav"
    },
    "recording_ended_at": "2018-02-02T22:20:27.521992Z",
    "recording_id": "4577f9a2-cf0e-44f3-ac57-9f95fb03fa47",
    "recording_started_at": "2021-05-11T10:17:03.692107Z",
    "recording_urls": {
      "mp3": "http://example.com/recording.mp3",
      "wav": "http://example.com/recording.wav"
    }
  }
}

Response

200

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

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Conference recording saved

Authorizations

Headers

Body

Response