Skip to content
Get started

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.

Get an available sending number
available_number.retrieve(AvailableNumberRetrieveParams**kwargs) -> AvailableNumberRetrieveResponse
GET/v3/available_number
ModelsExpand Collapse
class AvailableNumberRetrieveResponse:

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

phone_number: str

The selected sending line in E.164 format.

vcf_url: str

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 healthy lines as backups. The link expires; re-call this endpoint to mint a fresh one.

formaturi