Phone Numbers

The sending numbers behind your chats, with their live health: quality rating, messaging tier, and display-name status.

GET/v1/phone_numbers

PhoneNumber object { id, channel_account_id, messaging_tier, 4 more }

One sending number and its live channel health.

id: string

The number’s id — chats pin to it via phone_number_id.

channel_account_id: string

The channel account this number is registered under. Opaque; compare literally and never parse it.

messaging_tier: string

The channel’s messaging-tier token for this number, e.g. TIER_1K. Values are relayed as reported and may grow.

name_status: string

The display-name review state for this number, as reported by the channel.

phone_number: string

The number itself, in display form.

quality: string

The channel’s quality rating for this number, e.g. green, yellow, red. Values are relayed as reported and may grow.

quality_band: optional "green" or "yellow" or "red"

This service’s placed band for the current quality token. Absent when the token is empty or this build cannot place it.

One of the following:

"green"

"yellow"

"red"

PhoneNumberList object { data }

The sending numbers visible to this key’s brand.

data: array of PhoneNumber { id, channel_account_id, messaging_tier, 4 more }