Voice Broadcast

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

Send a voice broadcast to a list of numbers, poll its per-number outcomes, and check your billing balance.

• Voice Broadcast GET/POST /api/voice/v1/broadcast Sends a broadcast to a list of numbers from one of your account's DIDs. Requires a key scoped to voice.broadcast or all. This endpoint accepts a request; it does not bill or deliver synchronously.
• Voice Broadcast with Text to Speech GET/POST /api/voice/v1/broadcast/tts Sends a broadcast whose audio is spoken from text. Two modes — send exactly one: (1) template_id + variables: an approved TTS template from your account, with a value for each of its variables; open to every voice.broadcast key. (2) text: free text; only for keys with audio auto-approval. Asynchronous: the response is 202 "preparing" — poll Broadcast with TTS Status. Every different message is a new audio: it costs TTS credits and takes a few seconds (up to about 30 for some voices) before dialling starts.
• Voice Broadcast with TTS Status 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.
• TTS Templates GET/POST /api/voice/v1/tts/templates Lists your account's text-to-speech templates — the ids and variables you send to Voice Broadcast with Text to Speech in template mode. Templates are created in the web app (Voice › Text To Speech › Templates) and approved by the platform before use; only approved templates can be sent.
• Voice Broadcast Number Status GET/POST /api/voice/v1/broadcast/status Look up a broadcast's progress and per-number outcomes. Requires a key scoped to voice.broadcast or all. This is the endpoint you should poll after sending a broadcast.
• Balance Check GET/POST /api/account/v1/balance Your current credit/plan balance. Unlike every other endpoint in this API, this one is not restricted to a specific module — it's available to any key, and shows exactly the scope(s) that key's own module covers.