API Documentation

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

This is the REST API reference for CPaaS Studio's Audio Library and Voice Broadcast modules. Every example below is built for your account's base URL shown above, so you can copy and run it directly.

New here? Start with Getting started — it covers creating an API key, authentication, the response envelope, and the full error-code reference.

Audio Library

Upload, look up, and enable/disable the voice audio assets a Voice Broadcast can play.

• Audio Upload POST /api/v1/voice/audio/upload Uploads a voice audio file to your Audio Library, ready to select as a Voice Broadcast's message. Requires a key scoped to voice.obd or all.
• Audio Status GET/POST /api/v1/voice/audio/status Look up one audio asset, or list all of them. Requires a key scoped to voice.obd or all.
• Audio Enable / Disable GET/POST /api/v1/voice/audio/toggle Turns an audio asset on or off for selection in a broadcast. This is not approval — it's a usability switch layered on top of the pending/approved/rejected status.

Voice Broadcast

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

• Voice Broadcast GET/POST /api/v1/voice/broadcast Sends a broadcast to a list of numbers from one of your account's DIDs. Requires a key scoped to voice.obd or all. This endpoint accepts a request; it does not bill or deliver synchronously.
• Voice Broadcast Number Status GET/POST /api/v1/voice/broadcast/status Look up a broadcast's progress and per-number outcomes. Requires a key scoped to voice.obd or all. This is the endpoint you should poll after sending a broadcast.
• Balance Check GET/POST /api/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.