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

MethodPathDescription
GET/whatsapp-channelsList WhatsApp numbers
GET/whatsapp-channels/:idGet 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.

FieldTypeDescription
idintegerUnique ID. This is the whatsapp_channel_id used by conversations and Start a WhatsApp conversation.
organization_idintegerOrganization.
statusstringpending, active or inactive. Only active numbers send messages.
labelstring | nullInternal name of the number (e.g. "Ventas"), max 100 characters.
display_phone_numberstring | nullPhone number as shown by WhatsApp. From Meta.
verified_namestring | nullBusiness display name approved by WhatsApp. From Meta.
is_defaultbooleanLegacy flag. When a request does not pick a number, the API uses the oldest active number (lowest id).
wa_ba_idstring | nullWhatsApp Business Account (WABA) ID. Numbers of the same WABA share templates. From Meta.
wa_phone_number_idstring | nullWhatsApp phone number ID. From Meta.
waba_namestring | nullWABA name. From Meta.
waba_currencystring | nullWABA billing currency. From Meta.
waba_timezonestring | nullWABA time zone. From Meta.
waba_verification_statusstring | nullWABA verification status. From Meta.
message_template_namespacestring | nullWABA template namespace. From Meta.
business_namestring | nullMeta Business portfolio name. From Meta.
business_idstring | nullMeta Business portfolio ID. From Meta.
business_statusstring | nullBusiness portfolio status. From Meta.
business_verification_statusstring | nullBusiness verification status. From Meta.
can_send_messagestring | nullWhether 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_ratingstring | nullNumber quality rating (e.g. GREEN, YELLOW, RED). From Meta.
phone_quality_scorestring | nullQuality score of the number. From Meta.
code_verification_statusstring | nullPhone verification status. From Meta.
phone_number_statusstring | nullNumber status (e.g. CONNECTED). From Meta.
registration_statusstring | nullCloud API registration status of the number.
wa_name_statusstring | nullDisplay name review status. From Meta.
whatsapp_business_manager_messaging_limitstring | nullDaily conversation limit tier. From Meta.
throughput_levelstring | nullMessages-per-second level. From Meta.
webhook_statusstring | nullStatus of the webhook subscription that delivers incoming messages.
is_business_app_onboardingboolean | nullThe number was connected while staying on the WhatsApp Business app (coexistence).
created_atstring (date-time)When the number was connected.
updated_atstring (date-time)Last update.
deleted_atstring (date-time) | nullSet 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.