Voice Broadcast with TTS Status

Base URL for your account: https://cpaas.studio

GET POST /api/voice/v1/broadcast/tts/status

Shows whether a Broadcast with TTS request is still preparing, has been submitted as a broadcast, or failed.

Parameters

Param	Type	Required	Notes
`id`	string	one of id/reference	The id returned by Voice Broadcast with Text to Speech.
`reference`	string	one of id/reference	Your reference — resolves to your most recent request with it.

Request example

curl "https://cpaas.studio/api/voice/v1/broadcast/tts/status?id=TTB4M8Q2ZK7RX" \
  -H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Success response (`data`)

{
    "id": "TTB4M8Q2ZK7RX",
    "reference": "order-4471",
    "status": "submitted",
    "tts": {
        "language": "en",
        "gender": "female",
        "speed": 1
    },
    "credits_estimated": {
        "voice.broadcast": 2,
        "voice.tts": 12
    },
    "template": null,
    "audio": {
        "audio_uid": "AUD9F3K7Q2MXA",
        "reused": false
    },
    "items": {
        "total": 1,
        "ready": 1,
        "failed": 0
    },
    "broadcast": {
        "id": "BCQVCUU6YTAA",
        "reference": "order-4471",
        "status": "queued",
        "total_numbers": 2,
        "summary": {
            "accepted": 2,
            "duplicate": 0,
            "invalid": 0
        },
        "credits_estimated": 2,
        "audio_uid": "AUD9F3K7Q2MXA"
    },
    "error": null,
    "created_at": "2026-09-29T13:10:00+00:00",
    "completed_at": "2026-09-29T13:10:07+00:00"
}

Errors

Code	Status	When
`TTS_BROADCAST_NOT_FOUND`	404	No Broadcast with TTS request with that id/reference on your account.
`REQ_VALIDATION_FAILED`	422	Neither id nor reference supplied.
`TTS_GENERATION_FAILED`	200	Not an HTTP error — returned in error.code with status "failed": the audio could not be generated from the text. No TTS credits are charged.
`AUDIO_DELIVERY_FAILED`	200	Not an HTTP error — returned in error.code with status "failed": the audio could not be delivered to the voice operator.
`TTS_TEMPLATE_NOT_APPROVED`	200	Not an HTTP error — returned in error.code with status "failed": the template was edited or is no longer approved, and no message could be prepared.
`TTS_UNAVAILABLE`	200	Not an HTTP error — returned in error.code with status "failed": text to speech stopped being available for the language while the request was being prepared.

Notes

status: preparing → submitted | failed. A failed request never becomes a broadcast; send a new request.
broadcast is null until submitted. Its numbers[] list is included in full, same as the Voice Broadcast response.
template is {id, name} for a template request (and audio is then null); items is {total, ready, failed} — one item per different message.

Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.

Get In Touch