List phone numbers

GET/v1/phone_numbers

The placed quality band is provisional. It is this service’s current reading of the channel’s quality token published beside it, and may change when the channel vocabulary is settled under V-19.

Lists the currently registered sending numbers behind this brand’s chats with their live channel health — quality rating, messaging tier, and display-name status. Numbers still moving through registration and numbers already released are not part of this sending inventory.

ReturnsExpand Collapse

PhoneNumberList object { data }

The sending numbers visible to this key’s brand.

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

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"

List phone numbers

curl https://whatsapp.messages.api.linqapp.com/v1/phone_numbers \
    -H "Authorization: Bearer $LINQ_WHATSAPP_API_KEY"

{
  "data": [
    {
      "id": "id",
      "channel_account_id": "channel_account_id",
      "messaging_tier": "messaging_tier",
      "name_status": "name_status",
      "phone_number": "phone_number",
      "quality": "quality",
      "quality_band": "green"
    }
  ]
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "channel_account_id": "channel_account_id",
      "messaging_tier": "messaging_tier",
      "name_status": "name_status",
      "phone_number": "phone_number",
      "quality": "quality",
      "quality_band": "green"
    }
  ]
}