Speak text on a call

POST

api

Account

{auth_id}

Call

{call_uuid}

Speak

Speak text on a call

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "text": "Hello, your appointment is confirmed for tomorrow at 3 PM."
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/"

payload = { "text": "Hello, your appointment is confirmed for tomorrow at 3 PM." }
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({text: 'Hello, your appointment is confirmed for tomorrow at 3 PM.'})
};

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));

POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/

Convert text to speech and play it during an active call. Choose from 29 languages and multiple voice options (WOMAN and MAN) to deliver dynamic messages without pre-recording audio files.

Default language is English (US) with WOMAN voice. Voice availability varies by language - see the table below.

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 parameters

Field	Type	Required	Description
`text`	string	Yes	The text to convert to speech
`voice`	string	No	Voice type. Values: `WOMAN`, `MAN`, `Polly`. Default: `WOMAN`
`language`	string	No	Language code (e.g., `en-US`, `es-ES`). Default: `en-US`
`legs`	string	No	Which leg(s) to speak on. Values: `aleg`, `bleg`, `both`. Default: `aleg`
`loop`	boolean	No	Whether to loop the speech. Default: `false`
`mix`	boolean	No	Whether to mix with call audio. Default: `true`

Keep text under 500 characters for optimal speech quality.
Use periods and commas to control pacing and natural pauses.
Set mix=false for important announcements so the caller hears them clearly.

Supported languages

Language	Code	Voices
Arabic	`arb`	WOMAN
Chinese Mandarin	`cmn-CN`	WOMAN
Danish	`da-DK`	WOMAN, MAN
Dutch	`nl-NL`	WOMAN, MAN
English (Australia)	`en-AU`	WOMAN, MAN
English (India)	`en-IN`	WOMAN
English (UK)	`en-GB`	WOMAN, MAN
English (US)	`en-US`	WOMAN, MAN
English (Wales)	`en-GB-WLS`	WOMAN, MAN
French	`fr-FR`	WOMAN, MAN
French (Canadian)	`fr-CA`	WOMAN
German	`de-DE`	WOMAN, MAN
Hindi	`hi-IN`	WOMAN
Icelandic	`is-IS`	WOMAN, MAN
Italian	`it-IT`	WOMAN, MAN
Japanese	`ja-JP`	WOMAN, MAN
Korean	`ko-KR`	WOMAN, MAN
Norwegian	`nb-NO`	WOMAN
Polish	`pl-PL`	WOMAN, MAN
Portuguese (Brazilian)	`pt-BR`	WOMAN, MAN
Portuguese (European)	`pt-PT`	WOMAN, MAN
Romanian	`ro-RO`	WOMAN
Russian	`ru-RU`	WOMAN, MAN
Spanish (European)	`es-ES`	WOMAN, MAN
Spanish (US)	`es-US`	WOMAN, MAN
Swedish	`sv-SE`	WOMAN
Turkish	`tr-TR`	WOMAN
Welsh	`cy-GB`	WOMAN, MAN
Yue Chinese	`yue-CN`	WOMAN

If you request MAN voice for a language that only supports WOMAN, the API automatically falls back to WOMAN.

Example requests

{
  "text": "Hello, this is a test message from the text-to-speech system.",
  "voice": "WOMAN",
  "language": "en-US",
  "legs": "both",
  "loop": false,
  "mix": true
}

curl -X POST 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" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello, this is a test message.",
    "voice": "WOMAN",
    "language": "en-US"
  }'

Response

202 Accepted

{
  "api_id": "uuid-here",
  "message": "speak started"
}

Field	Description
`api_id`	Unique identifier for this API request
`message`	Confirmation that text-to-speech has started

Error responses

Status	Meaning	How to handle
`400 Bad Request`	`text` is missing/empty, or an unsupported `language`/`voice` combination was sent.	Send non-empty `text`; pick a `language` code from the table. Unsupported `MAN` voices fall back to `WOMAN` automatically.
`401 Unauthorized`	Missing/incorrect auth headers or a lowercase path.	Use both auth headers and the PascalCase path.
`404 Not Found`	The `call_uuid` is not an active call.	The call must be in-progress; confirm with Retrieve a Live Call.

Combine the Speak Text API with DTMF input capture to create interactive voice response systems that respond to user selections in real-time. Use legs=bleg to address only the callee, or both for everyone.

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

Body

application/json

text

string

required

Example:

"Hello, your appointment is confirmed."

voice

string

default:WOMAN

language

string

default:en-US

legs

enum<string>

default:aleg

Available options:

aleg,

bleg,

both

Response

200

TTS started

Speak text on a call

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "text": "Hello, your appointment is confirmed for tomorrow at 3 PM."
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/"

payload = { "text": "Hello, your appointment is confirmed for tomorrow at 3 PM." }
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({text: 'Hello, your appointment is confirmed for tomorrow at 3 PM.'})
};

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));

​Path parameters

​Request parameters

​Supported languages

​Example requests

​Response

​Error responses

Authorizations

Path Parameters

Body

Response

Path parameters

Request parameters

Supported languages

Example requests

Response

Error responses