Skip to main content
DELETE
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
{call_uuid}
/
Play
Stop audio playback on a call
curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Play/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Play/
Stop audio playback that is currently playing on an active call. Useful for ending hold music when an agent becomes available, stopping looping audio, or interrupting announcements based on user input.
If no audio is currently playing on the call, this endpoint returns success without performing any action.

​
Path parameters

ParameterTypeRequiredDescription
auth_idstringYesYour Vobiz authentication ID
call_uuidstringYesUnique identifier of the active call

​
Request body

No request body is required. Send an empty JSON object {} or omit the body entirely.

​
Example request

cURL
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"

​
Response

204 No Content
HTTP Status Code: 204
A 204 status code indicates audio playback was stopped successfully. There is no response body.

​
Common use cases

  • Stop hold music when an agent becomes available.
  • End looping audio based on user DTMF input.
  • Interrupt announcements when a call is answered.
  • Stop IVR prompts when a user makes a selection.
  • End audio playback before transferring a call.
Use this endpoint together with Play Audio to create dynamic audio experiences that respond to user actions or call events.

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

​
call_uuid
string
required

Response

204

Playback stopped