List text-to-speech voices

GET

/domains/{domain}/users/{user}/voices/{language}

Last modified:2026-10-09 00:33:14

OperationId:GetAvailableVoices

Lists the text-to-speech voices the voice service offers for one language. Use a voice's id as text-to-speech-voice-id when you create a greeting, hold message, or music on hold (MoH) file from text.

Needs the read right on audio for the user in the path: every user for itself; Office Manager, Site Manager, Call Center Supervisor, Route Manager, Reseller, and Super User for any user in the domain; Office Manager Read-Only and Super User Read Only as their parent scope. The voice service answers for the user in the path, and its text-to-speech settings must allow it, or the call returns 403. The list is kept for a few minutes on each server, per path user, caller scope, and language.

language must be a BCP 47 tag of letters and hyphens, such as en-US: a tag the router accepts but BCP 47 does not returns 400, and one with a digit (es-419) is not a route and returns 404. Narrow the list with text-to-speech-gender, text-to-speech-name, vendor (matches text-to-speech-type), or id. A filter that matches nothing answers an empty array. A voice-service failure returns 503.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200OK

application/json

The voices for the language.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠404Record not found

🟠403Forbidden

🔴500Internal Server Error

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//voices/en-US?vendor=WaveNet&id=en-US-Wavenet-C&text-to-speech-gender=FEMALE&text-to-speech-name=en-US-Wavenet-C' \
--header 'Authorization: Bearer <token>'

Response Example

200 - English (US) voices

Two voices, filtered to nothing.

[
    {
        "id": "en-US-Wavenet-C",
        "text-to-speech-name": "en-US-Wavenet-C",
        "text-to-speech-gender": "FEMALE",
        "text-to-speech-language": "en-US",
        "text-to-speech-type": "WaveNet",
        "text-to-speech-sub-type": ""
    },
    {
        "id": "en-US-Wavenet-D",
        "text-to-speech-name": "en-US-Wavenet-D",
        "text-to-speech-gender": "MALE",
        "text-to-speech-language": "en-US",
        "text-to-speech-type": "WaveNet",
        "text-to-speech-sub-type": ""
    }
]

Modified at 2026-10-09 00:33:14

Play user hold message

Synthesize speech