Available Number

Phone Numbers represent the phone numbers assigned to your partner account.

Use the list phone numbers endpoint to discover which phone numbers are available for sending messages.

When creating chats, listing chats, or sending a voice memo, use one of your assigned phone numbers in the from field.

Ineligible numbers. A number can temporarily lose the ability to deliver messages. While it is in that state, requests that would produce new activity on it — sending a message, creating a chat, reacting, typing, group actions — are rejected with 403 (error code 2027) before anything is created. Reads keep working, so your existing chats, messages, and history stay available. Omit from on POST /v3/messages and we pick an eligible number for you, skipping ineligible ones; if none of your assigned numbers are eligible, you get 409 (no from number was ever chosen, so there’s no specific number to blame with a 403).

Get an available sending number

GET/v3/available_number

ModelsExpand Collapse

AvailableNumberRetrieveResponse object { phone_number, vcf_url }

The line smart number assignment selected, plus a shareable vCard.

phone_number: string

The selected sending line in E.164 format.

vcf_url: string

Time-limited link to a vCard (.vcf) for the selected line. The card carries the line’s contact details with the selected number as the primary TEL and the partner’s other available lines as backups. The link expires; re-call this endpoint to mint a fresh one.

formaturi