Skip to main content
DELETE
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
{call_uuid}
/
Speak
Stop text-to-speech on a call
curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/ \
  --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}/Speak/
Stop text-to-speech playback currently active on a call. Useful for ending looping messages when a user makes a selection, stopping announcements when an agent becomes available, or interrupting speech based on DTMF input.
If no text-to-speech is currently playing, 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.

​
Example request

cURL
curl -X DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/ \
  -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 the text-to-speech has been stopped successfully. There is no response body.

​
Common use cases

  • Stop looping queue messages when an agent answers.
  • End IVR menu announcements when a user presses a DTMF key.
  • Interrupt speech when transferring to a live agent.
  • Stop welcome messages when a call is answered.
  • End promotional announcements based on user action.
Use this endpoint with Speak Text to create dynamic TTS experiences that respond to user input or call events in real-time.

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

TTS stopped