Skip to main content

Stop audio playback

POST 
/calls/:call_control_id/actions/playback_stop

Stops audio being played on the call.

Expected Webhooks:

  • Either Playback ended](/docs/api/v1/call-control/Call%20Webhooks#playback-ended) or [Speak ended

Request ​

Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call

Body

required

    stop string

    Default value: all

    Use 'current' to stop only the current audio or 'all' to stop all audios in the queue.

    client_state string

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

    command_id string

    Use this field to avoid duplicate commands. Telnyx will ignore commands with the same "command_id".

Responses ​

200: Successful response

Schema

    result stringrequired

422: Error response

Schema

    code stringrequired
    title stringrequired
    detail stringrequired

Request samples

curl -L 'https://api.telnyx.com/calls/:call_control_id/actions/playback_stop' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "stop": "current",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}'

Response samples

{
  "result": "ok"
}