Stop audio on a live call
stop_audioStops audio playback started by play_audio on a live call while the call stays connected. Use it to halt prompts or hold music; use stop_speaking to end text-to-speech instead.
Instructions
Stop audio started by play_audio on a LIVE call (DELETE /Call/{uuid}/Play/); the call itself continues. It does not stop text-to-speech (use stop_speaking), a recording (stop_recording) or an audio stream (stop_audio_stream). A call that is not live fails with call_not_active.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| call_uuid | Yes | UUID of the live call whose play_audio playback should stop. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`. | |
| playing | No | False once Vobiz accepted the stop request. | |
| call_uuid | No | The call UUID the action was applied to, echoed from the request. | |
| http_status | No | HTTP status Vobiz answered with: 202 when an action was accepted, 204 when one was stopped. |