Skip to main content

Stop audio playback


Stop audio being played on the call.

Expected Webhooks:

  • call.playback.ended or call.speak.ended


Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call



Stop audio playback request

    overlay boolean

    When enabled, it stops the audio being played in the overlay queue.

    stop string

    Default value: all

    Use current to stop the current audio being played. Use all to stop the current audio file being played and clear all audio files from 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 any command with the same command_id for the same call_control_id.


200: Successful response upon making a call control command.

default: Unexpected error