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
Update a phone number
ModelsExpand Collapse
PhoneNumberListResponse object { phone_numbers }
phone_numbers: array of object { id, health_status, phone_number, 2 more } List of phone numbers assigned to the partner
List of phone numbers assigned to the partner
Deprecatedhealth_status: object { 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.
[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.
Deep-link to the relevant section of the Phone Reputation guide for this status.
status: "HEALTHY" or "AT_RISK" or "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.
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.
reputation: object { 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.
[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.
Deep-link to the relevant section of the Phone Reputation guide for this status.
status: "HEALTHY" or "AT_RISK" or "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.
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.