TEteam-telnyx
Call Commands

Streaming stop

Stop streaming a call to a WebSocket.

Expected Webhooks:

  • streaming.stopped
post/calls/{call_control_id}/actions/streaming_stop

Request

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

client_statestring

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

command_idstring

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

stream_idstring uuid

Identifies the stream. If the stream_id is not provided the command stops all streams associated with a given call_control_id.

Example request

{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "stream_id": "1edb94f9-7ef0-4150-b502-e0ebadfd9491"
}

Response

Successful response upon making a call control command.

Example response

{
  "data": {
    "result": "ok"
  }
}

Changes

No recorded changes to this operation across all 108 revisions of this API.