Channels
List WhatsApp numbers
Return the connected WhatsApp Business numbers this workspace can send from.
Returns each connected WhatsApp number with its display number, verified name and quality rating. Use it to pick a whatsapp_phone_number_id before messages.send when the workspace has more than one number. Read-only. Disconnected numbers are omitted.
List WhatsApp numbers › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successList Instagram accounts
Return the connected Instagram accounts this workspace can send from.
Returns each connected Instagram account with its username and IG id. Use it to pick an instagram_account_id before messages.send when the workspace has more than one account. Read-only. Disconnected accounts are omitted.
List Instagram accounts › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successList Facebook Pages
Return the connected Facebook Pages this workspace can send Messenger messages from.
Returns each connected Page with its Page id, name and category. Use it to pick a facebook_page_id before messages.send when the workspace has more than one Page. Read-only. Disconnected Pages are omitted.
List Facebook Pages › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successList connected WhatsApp Business Accounts
Return each connected WABA with its phone numbers, quality rating and messaging-limit tier.
Returns the WhatsApp Business Accounts connected to this workspace, each with its connection status, coexistence flag, billing alert and every phone number with its Meta quality rating (GREEN/YELLOW/RED) and messaging-limit tier. Use it BEFORE a broadcast to confirm the sending number is healthy and has headroom under its tier, and to find the wabaId that the other waba.* tools need. Read-only; it reads stored state and does not call Meta. Bounded: follow meta.pagination.nextCursor until hasMore is false.
query Parameters
limitRows to return, 1-100. Defaults to 25.
Rows to return, 1-100. Defaults to 25.
cursorThe meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
The meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
List connected WhatsApp Business Accounts › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRead WABA account health
Return the current Meta restriction or flag on a WhatsApp Business Account, if any.
Returns the active account-level problem Meta reported for this WABA (a restriction, a flagged state, a violation) with when it was detected, or null data when nothing is wrong. Use it before a broadcast: a restricted WABA will fail to send. Per-number quality rating and messaging-limit tier are on waba.accounts. Read-only; it reads the last stored status and does not call Meta — use waba.healthCheck for a live check.
path Parameters
wabaIdThe Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
The Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
Read WABA account health › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRead WABA health history
Return the most recent account-status changes Meta reported for a WABA.
Returns recent account-status records for this WABA, newest first, each with the status, restriction type, Meta error code and message, and when it was detected and resolved. Use it to explain why sending was interrupted or to see whether a restriction is recurring. Read-only. It returns only the newest limit records (1-100, default 25) and has no older pages.
path Parameters
wabaIdThe Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
The Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
query Parameters
limitRows to return, 1-100. Defaults to 25.
Rows to return, 1-100. Defaults to 25.
Read WABA health history › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRun a live WABA health check
Ask Meta for the account status right now and store the result.
Calls the Meta Graph API for this WABA, then records any restriction it finds (or marks the open one resolved). Use it when waba.health looks stale or after you fixed a restriction and want it re-evaluated. It spends a Meta API call and changes the stored health status, so do not poll it; one call per decision is enough. Fails with 400 when the WABA is not connected.
path Parameters
wabaIdThe Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
The Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
Run a live WABA health check › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRead the WABA billing alert
Return the stored Meta billing alert for a WABA, or null when there is none.
Returns the billing problem Meta flagged for this WABA (for example an invalid payment method or an overdue balance) and the phone numbers it affects. Use it when sends fail with a payment-related Meta error. Read-only; reads stored state, no Meta call.
path Parameters
wabaIdThe Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
The Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
Read the WABA billing alert › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successMessage volume per WhatsApp number
Return message, chat, contact and unread counts for every phone number of a WABA.
Returns, keyed by Meta phoneNumberId, the total, sent, received and unread message counts plus the contact and chat counts for each number on this WABA, over all time. Use it to compare how busy the numbers are. Read-only, but it runs several counts per number over the whole message table, so call it sparingly; use the insights tools for date-ranged reporting.
path Parameters
wabaIdThe Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
The Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
Message volume per WhatsApp number › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRead a number's WhatsApp business profile
Fetch the public business profile of one phone number live from Meta.
Returns the WhatsApp business profile customers see for this number (about text, address, description, email, websites, vertical, profile picture) read live from Meta. Use it to audit or quote the public profile. Read-only, but it spends a Meta API call. Fails with 404 when the number does not belong to this WABA.
path Parameters
wabaIdThe Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
The Meta WhatsApp Business Account id (the wabaId field from waba.accounts).
phoneNumberIdThe Meta phone number id (phoneNumberId from waba.accounts), not the digits.
The Meta phone number id (phoneNumberId from waba.accounts), not the digits.
Read a number's WhatsApp business profile › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successList connected TikTok accounts
Return the TikTok accounts connected to this workspace.
Returns each connected TikTok business account with its username, display name, connection status and last event time. Use it to check that TikTok is connected before working with TikTok conversations or comments. Read-only; never returns tokens. Bounded: follow meta.pagination.nextCursor until hasMore is false.
query Parameters
limitRows to return, 1-100. Defaults to 25.
Rows to return, 1-100. Defaults to 25.
cursorThe meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
The meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
List connected TikTok accounts › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successList connected Telegram bots
Return the Telegram bots connected to this workspace.
Returns each connected Telegram bot with its username, connection status, webhook state and conversation count. Use it to find the telegram_bot_id that messages.send expects when the workspace has several bots. Read-only; the bot token is never returned. Bounded: follow meta.pagination.nextCursor until hasMore is false.
query Parameters
limitRows to return, 1-100. Defaults to 25.
Rows to return, 1-100. Defaults to 25.
cursorThe meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
The meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
List connected Telegram bots › Responses
The API key is missing, malformed, expired, or its owner is inactive.
success