Why use them?
Think of the number as your company’s landline, but virtual: you contract it, configure it in the dashboard or API, and use it for voice and SMS without buying a SIM card or SIP trunk. Without a contracted, active number, the voice channel can’t dial and SMS can’t go out with your own sender.When to use?
How it works in practice
- Search and contract a number in the dashboard or with
POST /v1/phone-numbers/orders(PIX or card) - After payment, the number becomes active — webhook
phone_number.activated - Use as origin in
POST /v1/voice/calls(from) orPOST /v1/sms/messages(from) - Configure inbound: when someone calls that number, forward, speak a message, or let your system control via webhook
What each number can do
A number can have voice, SMS, or both — depending on what you contracted.
API v1 — overview
Scopes:
phone_numbers:read, phone_numbers:create, phone_numbers:update, phone_numbers:delete.
OpenAPI spec under Voice → Phone numbers.
When someone calls your number
Configure withPATCH /v1/phone-numbers/:id:
Useful fields:
label (name in dashboard), inboundTtsText / inboundTtsVoice (spoken text), recordingEnabled (recording preference).
Number lifecycle
Webhooks:
phone_number.activated, phone_number.past_due, phone_number.suspended, phone_number.released.
Next steps
- Quick Start: search, contract, and configure
- Scopes
- Webhook events
- Voice — introduction
- SMS — your own number

