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

application/json

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

application/json

• Schema
• Example (from schema)

Schema

result stringrequired

{
  "result": "ok"
}

422: Error response

application/json

• Schema
• Example (from schema)

Schema

code stringrequired
title stringrequired
detail stringrequired

{
  "code": "90015",
  "title": "Invalid Call Control ID",
  "detail": "The call_control_id provided was not valid."
}

Loading...