Phone Numbers

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.

List phone numbers

client.phoneNumbers.list(?): PhoneNumberListResponse { phone_numbers }

GET/v3/phone_numbers

Update a phone number

client.phoneNumbers.update(, , ?): PhoneNumberUpdateResponse { id, forwarding_number, phone_number }

PUT/v3/phone_numbers/{phoneNumberId}

ModelsExpand Collapse

PhoneNumberListResponse { phone_numbers }

phone_numbers: Array<PhoneNumber>

List of phone numbers assigned to the partner

id: string

Unique identifier for the phone number

formatuuid

Deprecatedhealth_status: HealthStatus { doc_url, status }

[BETA] Current reputation for a phone line. Always present — lines start at HEALTHY and may shift based on aggregate engagement and delivery signals across all conversations on the line.

Unlike chat health, line reputation does not include opted_out — opt-out applies to individual recipients, not the whole line.

See the Phone Reputation guide for what each status means and how to react.

doc_url: string

Deep-link to the relevant section of the Phone Reputation guide for this status.

formaturi

status: "HEALTHY" | "AT_RISK" | "CRITICAL"

Current reputation of this phone line as assessed by risk-service.

HEALTHY — No elevated risk detected.
AT_RISK — Elevated risk indicators present; consider reducing send volume or reviewing messaging patterns.
CRITICAL — High risk; further sending may result in line flagging or restriction.

Defaults to HEALTHY for lines that have not yet been scored.

One of the following:

"HEALTHY"

"AT_RISK"

"CRITICAL"

phone_number: string

Phone number in E.164 format

reputation: Reputation { doc_url, status }