Speak text on calls
Play text during a call
This endpoint lets you speak text in an active call.
API Endpoint
POST
Arguments
| Parameter | Type | Required | Description |
|---|---|---|---|
text | string | Yes | The text that needs to be spoken. |
voice | string | No | The voice in which the text should be spoken. Allowed values: MAN, WOMAN. Defaults to WOMAN. |
language | string | No | The language used to speak the text. Default: en-US (US English). |
legs | string | No | The call leg in which the text is to be spoken. Allowed values: aleg, bleg, both. Defaults to aleg. |
loop | boolean | No | If true, the text will be spoken repeatedly unless stopped. Defaults to false. |
mix | boolean | No | Controls audio mixing behavior. If false, participants cannot hear others while text is being spoken. If true, call audio and spoken text are mixed. Defaults to true. |
List of languages supported
| Language | Code | Available Voices |
|---|---|---|
| Arabic | arb | Only WOMAN |
| Chinese Mandarin | cmn-CN | Only WOMAN |
| Danish (Denmark) | da-DK | WOMAN, MAN |
| Dutch (Netherlands) | nl-NL | WOMAN, MAN |
| English (Australia) | en-AU | WOMAN, MAN |
| English (India) | en-IN | Only WOMAN |
| English (UK) | en-GB | WOMAN, MAN |
| English (US) | en-US | WOMAN, MAN |
| English (Welsh) | en-GB-WLS | Only MAN |
| French (Canada) | fr-CA | Only WOMAN |
| French (France) | fr-FR | WOMAN, MAN |
| German (Germany) | de-DE | WOMAN, MAN |
| Hindi (India) | hi-IN | Only WOMAN |
| Icelandic (Iceland) | is-IS | WOMAN, MAN |
| Italian (Italy) | it-IT | WOMAN, MAN |
| Japanese (Japan) | ja-JP | WOMAN, MAN |
| Korean (South Korea) | ko-KR | Only WOMAN |
| Norwegian (Norway) | nb-NO | Only WOMAN |
| Polish (Poland) | pl-PL | WOMAN, MAN |
| Portuguese (Brazil) | pt-BR | WOMAN, MAN |
| Portuguese (Portugal) | pt-PT | WOMAN, MAN |
| Romanian (Romania) | ro-RO | Only WOMAN |
| Russian (Russia) | ru-RU | WOMAN, MAN |
| Spanish (Mexico) | es-MX | Only WOMAN |
| Spanish (Spain) | es-ES | WOMAN, MAN |
| Spanish (US) | es-US | WOMAN, MAN |
| Swedish (Sweden) | sv-SE | Only WOMAN |
| Turkish (Turkey) | tr-TR | Only WOMAN |
| Welsh (Wales) | cy-GB | Only WOMAN |
Returns
If successful, this endpoint returns an acknowledgement that the written text is being spoken in the call