Texml stream

Webhook sent for media streaming status updates. This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.

WEBHOOK TexmlStreamWebhook

Example

{
  "AccountSid": "f5586561-8ff0-4291-a51b-c7dfe4139ff9",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "StreamError": "Connection timeout",
  "StreamEvent": "stream-started",
  "StreamName": "my_stream",
  "StreamSid": "stream-abc123",
  "Timestamp": "2024-01-15T10:30:00Z"
}

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 for media streaming status updates.

AccountSid · string · required

The unique identifier of the account (user_id).

Example:

"f5586561-8ff0-4291-a51b-c7dfe4139ff9"

CallSid · string · required

The unique identifier of the call (call_control_id).

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

CallSidLegacy · string · required

Legacy call identifier, same as CallSid.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

StreamEvent · enum<string> · required

The event type for the media stream.

Available options: stream-started, stream-stopped, stream-error

Example:

"stream-started"

StreamName · string · required

The name of the stream.

Example:

"my_stream"

StreamSid · string · required

A unique identifier for the stream.

Example:

"stream-abc123"

Timestamp · string<date-time> · required

The timestamp when the event occurred.

Example:

"2024-01-15T10:30:00Z"

StreamError · string

Error message if the stream failed (conditional, only present when StreamEvent is stream-error).

Example:

"Connection timeout"

Response

200

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