Streaming stop

Stop streaming a call to a WebSocket.

Expected Webhooks:

• streaming.stopped

POST /calls/{call_control_id}/actions/streaming_stop

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.calls.actions.stopStreaming('call_control_id');

console.log(response.data);

200

Example

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

call_control_id · string · required

Unique identifier and token for controlling the call

Body

application/json

Stop streaming media request

client_state · string

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

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

command_id · string

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

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

stream_id · string<uuid>

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

Example:

"1edb94f9-7ef0-4150-b502-e0ebadfd9491"

Response

200

application/json

Successful response upon making a call control command.

data · Call Control Command Result · object

Show child attributes

Example:

{ "result": "ok" }