Speak text
Stop speaking text during a call
Halt active text-to-speech playback on a Vobiz call - interrupt looping messages on DTMF input or when an agent joins, without affecting the call session.
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>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/
If no text-to-speech is currently playing, this endpoint returns success without performing any action.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
auth_id | string | Yes | Your Vobiz authentication ID |
call_uuid | string | Yes | Unique 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
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.
Was this page helpful?
⌘I
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>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));