Stop Playing Audio on a Call

Stop audio that is currently being played during an active call.

This endpoint allows you to stop audio playback that is currently playing on an active call. This is useful for ending hold music when an agent becomes available, stopping looping audio, or interrupting announcements based on user input.

Note: If no audio is currently playing on the call, this endpoint will return success without performing any action.

HTTP Request

DELETEhttps://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Play/

Path Parameters

auth_idstringRequired

Your Vobiz authentication ID

call_uuidstringRequired

Unique identifier of the call

No Request Body: This endpoint does not require any request body parameters.

Request Body

JSON

{}

No request body parameters required. Send an empty JSON object.

Response

Returns HTTP 204 No Content on success.

Response - 204 No Content

HTTP Status Code: 204

Success: A 204 status code indicates the audio playback has been stopped successfully. There is no response body.

Example Request

Stop Audio Playback

cURL Example

curl -X DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Play/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Use Cases

•Stop hold music when an agent becomes available
•End looping audio based on user DTMF input
•Interrupt announcements when call is answered
•Stop IVR prompts when user makes a selection
•End audio playback before transferring the call

Tip: Use this endpoint in conjunction with the Play Audio endpoint to create dynamic audio experiences that respond to user actions or call events.

Play Audio on a Call

Speak Text Overview