Skip to content
Linq Copy 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).

Published vs unpublished. A published number is available for your account to use. Only published numbers appear in GET /v3/phone_numbers.

Unpublished numbers allow GET requests. POST, PUT, PATCH, and DELETE requests that change a chat return 403 with error code 2033 (Phone number is unpublished).

A number’s existing data is preserved when its status changes to unpublished. Unpublished status alone does not block reads, blocked-handle management, or deletion of your data. Existing authorization, retention, and endpoint rules still apply.

Webhook events are suppressed for affected numbers when their publication status is known to be unpublished.

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.