Stop Speaking Text During a Call

Stop text-to-speech that is currently being spoken on an active call.

This endpoint allows you to stop text-to-speech playback that is currently active on a call. This is 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.

Note: If no text-to-speech 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}/Speak/

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 text-to-speech has been stopped successfully. There is no response body.

Example Request

Stop Text-to-Speech

cURL Example

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"

Use Cases

•Stop looping queue messages when an agent answers
•End IVR menu announcements when user presses a DTMF key
•Interrupt speech when transferring to a live agent
•Stop welcome messages when call is answered
•End promotional announcements based on user action

Tip: Use this endpoint in conjunction with the Speak Text endpoint to create dynamic TTS experiences that respond to user input or call events in real-time.

Speak Text on a Call

Call Management Overview