Render domain speech words in bulk

POST

/domains/{domain}/speech-words/render

Last modified:2026-10-09 00:58:23

OperationId:RenderSpeechWordsBulkDomain

Records many speech words with text to speech in one call, and reports the outcome of each.

Requires Office Manager, Call Center Supervisor, Route Manager, Reseller, or Super User scope for the domain. A Reseller can change only domains in its own reseller; any other domain returns 403.

Each recording is stored as the domain's override; system speech words are not changed. Each speech word uses its own stored text and voice. A voice or silence field you send applies to every word in the list. Words whose recording is already current are skipped. The text-to-speech calls run in parallel, and the response is sent once every word has finished, so a long list can take a while; send a few dozen names at a time.

A word that fails does not fail the call: the response is 200 with status error and a reason for that word.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The outcome per speech word, in the order sent, with totals.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

cURL

Stored voicesOne voice for all

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//speech-words/render' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "filenames": [
        "hour-10",
        "hour-11",
        "hour-12"
    ]
}'

Response Example

200 - Mixed outcome

{
    "code": 200,
    "message": "Bulk re-record complete",
    "rendered": 1,
    "skipped": 1,
    "failed": 1,
    "results": [
        {
            "filename": "hour-10",
            "status": "rendered",
            "content-hash": "8c1f1046219ddd216a023f792356ddf127fce372",
            "source-type": "tts"
        },
        {
            "filename": "hour-11",
            "status": "skipped",
            "reason": "up-to-date",
            "content-hash": "3f786850e387550fdab836ed7e6dc881de23001b"
        },
        {
            "filename": "hour-99",
            "status": "error",
            "reason": "No script to render for 'hour-99'."
        }
    ]
}

Modified at 2026-10-09 00:58:23

Play domain speech word from signed link

List domain speech word names