Deploy
Phone numbers
Every number of the account is in GET
/v1/phones, whichever way it came in: a SIP trunk, or an import from Twilio or Telnyx.The phone object
| Field | Meaning |
|---|---|
id | The phoneId campaigns and updates use |
phoneNumber | E.164 |
provider | sip, twilio or telnyx |
isOutboundAllowed | Whether a campaign can dial from it |
agent | The agent answering inbound calls (id, name) |
entityId | Its entity, or null when shared |
Choose who answers
PATCH/v1/phones/{phoneId} sets the agent that answers inbound calls on a number, whatever its provider; null unassigns it. The same request moves the number to an entity.
{ "agentId": "550e8400-e29b-41d4-a716-446655440000" }Connect a provider
- Twilio: connect the account and import its numbers in the dashboard.
- Your carrier over SIP: through the API, see Bring your own SIP trunk.
- Your current line: forward it to the agent's number on no answer and on busy, see Call forwarding.
GET/v1/phones/sip lists the SIP numbers only, and PATCH/v1/phones/sip/{phoneId} is an alias of the update above.