WhatsApp numbers
A WhatsApp channel is one WhatsApp Business number connected to your organization. An organization can connect several numbers; each conversation belongs to one of them (whatsapp_channel_id). Numbers are connected and removed in the AchieveApex app (Settings, WhatsApp) because connecting requires Meta's sign-in; the API reads them.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /whatsapp-channels | List WhatsApp numbers |
GET | /whatsapp-channels/:id | Get a WhatsApp number |
The WhatsApp channel object
json
Fields
All fields are read-only through the API. Values marked "from Meta" are copied from the WhatsApp Business Platform when the number is connected or refreshed, and use Meta's values.
| Field | Type | Description |
|---|---|---|
id | integer | Unique ID. This is the whatsapp_channel_id used by conversations and Start a WhatsApp conversation. |
organization_id | integer | Organization. |
status | string | pending, active or inactive. Only active numbers send messages. |
label | string | null | Internal name of the number (e.g. "Ventas"), max 100 characters. |
display_phone_number | string | null | Phone number as shown by WhatsApp. From Meta. |
verified_name | string | null | Business display name approved by WhatsApp. From Meta. |
is_default | boolean | Legacy flag. When a request does not pick a number, the API uses the oldest active number (lowest id). |
wa_ba_id | string | null | WhatsApp Business Account (WABA) ID. Numbers of the same WABA share templates. From Meta. |
wa_phone_number_id | string | null | WhatsApp phone number ID. From Meta. |
waba_name | string | null | WABA name. From Meta. |
waba_currency | string | null | WABA billing currency. From Meta. |
waba_timezone | string | null | WABA time zone. From Meta. |
waba_verification_status | string | null | WABA verification status. From Meta. |
message_template_namespace | string | null | WABA template namespace. From Meta. |
business_name | string | null | Meta Business portfolio name. From Meta. |
business_id | string | null | Meta Business portfolio ID. From Meta. |
business_status | string | null | Business portfolio status. From Meta. |
business_verification_status | string | null | Business verification status. From Meta. |
can_send_message | string | null | Whether this number can send messages, from the number's own Meta health status: AVAILABLE, LIMITED (connected but restricted, e.g. display name not approved yet) or BLOCKED. |
quality_rating | string | null | Number quality rating (e.g. GREEN, YELLOW, RED). From Meta. |
phone_quality_score | string | null | Quality score of the number. From Meta. |
code_verification_status | string | null | Phone verification status. From Meta. |
phone_number_status | string | null | Number status (e.g. CONNECTED). From Meta. |
registration_status | string | null | Cloud API registration status of the number. |
wa_name_status | string | null | Display name review status. From Meta. |
whatsapp_business_manager_messaging_limit | string | null | Daily conversation limit tier. From Meta. |
throughput_level | string | null | Messages-per-second level. From Meta. |
webhook_status | string | null | Status of the webhook subscription that delivers incoming messages. |
is_business_app_onboarding | boolean | null | The number was connected while staying on the WhatsApp Business app (coexistence). |
created_at | string (date-time) | When the number was connected. |
updated_at | string (date-time) | Last update. |
deleted_at | string (date-time) | null | Set when the number was removed. |
Access tokens and registration PINs are never returned.
Report an issue with this documentation
Please log in to report issues with our documentation.