Skip to main content
WEBHOOK
TexmlRecordingInProgressWebhook
{
  "AccountSid": "cb6cfbbc-eb00-41af-a3f3-0d7b32009e4b",
  "CallSid": "v2:qiaymU9Ij90xJRRkYGWHOIx_41EVJPrzlny2zC67hwL1wVIUnnMrqQ",
  "CallSidLegacy": "v2:qiaymU9Ij90xJRRkYGWHOIx_41EVJPrzlny2zC67hwL1wVIUnnMrqQ",
  "ConnectionId": "1234567890",
  "RecordingChannels": 1,
  "RecordingSource": "DialVerb",
  "RecordingStatus": "in-progress",
  "RecordingSid": "35094891-3290-4142-b2c2-b2eda57534cf"
}

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 starts during a TeXML call (triggered by recordingStatusCallbackEvent).

​
AccountSid
string
required

The unique identifier of the account (user_id).

Example:

"cb6cfbbc-eb00-41af-a3f3-0d7b32009e4b"

​
CallSid
string
required

The unique identifier of the call (call_control_id).

Example:

"v2:qiaymU9Ij90xJRRkYGWHOIx_41EVJPrzlny2zC67hwL1wVIUnnMrqQ"

​
CallSidLegacy
string
required

Legacy call identifier, same as CallSid.

Example:

"v2:qiaymU9Ij90xJRRkYGWHOIx_41EVJPrzlny2zC67hwL1wVIUnnMrqQ"

​
ConnectionId
string
required

The unique identifier of the connection.

Example:

"1234567890"

​
RecordingChannels
enum<integer>
required

The number of channels in the recording (1 for mono, 2 for dual-channel).

Available options:
1,
2
Example:

1

​
RecordingSource
string
required

The source of the recording.

Example:

"DialVerb"

​
RecordingStatus
enum<string>
required

The status of the recording.

Available options:
in-progress
Example:

"in-progress"

​
RecordingSid
string

A unique identifier for the recording, generated by Telnyx (conditional, only present if recording_id is available).

Example:

"35094891-3290-4142-b2c2-b2eda57534cf"

Response

200

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