Skip to content
LinqCopy agent prompt

Phonenumbers

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).

List phone numbers (deprecated)
Deprecated
phonenumbers.list() -> PhonenumberListResponse
GET/v3/phonenumbers
ModelsExpand Collapse
class PhonenumberListResponse:
phone_numbers: List[PhoneNumber]

List of phone numbers assigned to the partner

id: str

Unique identifier for the phone number

formatuuid
phone_number: str

Phone number in E.164 format

capabilities: Optional[PhoneNumberCapabilities]
mms: bool

Whether MMS messaging is supported

sms: bool

Whether SMS messaging is supported

voice: bool

Whether voice calls are supported

country_code: Optional[str]

Deprecated. Always null.

type: Optional[str]

Deprecated. Always null.