Skip to main content
Each scope is a door on your key: dial, query, or control the session, open only what you need.
Each scope unlocks one type of Voice operation. Use only what your integration needs.

How to send the key

Recommended
Alternative
The API Key belongs to one workspace. You cannot access another workspace with the same key.

Common combinations

Simple dialer only

voice:call, voice:read

Real-time IVR

voice:call, voice:read, voice:control

Query history only

voice:read

Recordings

voice:read (recording download)
An empty scope list on create = ADMIN access. Always restrict in production.

Available scopes

Originate outbound calls. Requires ACTIVE number and balance or credits. Typical return: 202 with call id.
List workspace calls, query detail and events (includeEvents), and download recording files.
Actions on active session: speak, play, gather, transfer, record-start, record-stop, dtmf, hangup.

Common errors

Check Authorization: Bearer sk_... and that the key was not deleted in the dashboard.
Workspace blocked or no balance for dialing. Resolve in the dashboard.
Verify scope for the operation (Missing scope: voice:call, etc.).
from must be an ACTIVE workspace number (id or E.164).

Next steps