Skip to main content

WhatsApp Business

WhatsApp Business Platform Cloud API connector for sending messages, managing message templates and media, administering business profiles and blocked users, and querying conversation analytics.

Categories: Messaging, Customer Communication

What you can ask​

  • Send an approved order-confirmation template to a customer's phone number
  • Create a new message template for appointment reminders
  • Report conversation analytics for the last 30 days by phone number

Set up​

WhatsApp Business connects with credentials from your WhatsApp Business account. Have these values ready:

  • WhatsApp Business Account ID
  • Phone number ID
  • Access token
  1. Go to Organization > Connectors and find WhatsApp Business.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

WhatsApp Business offers 36 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (13)​

View and search information without changing it.

ToolWhat it does
get_business_profileGet the WhatsApp business profile for the credential's phone number.
get_conversation_analyticsGet WhatsApp conversation analytics (volume and cost per category/direction/type) for a time range. start and end are Unix timestamps in seconds; start must be within the past 365 days.
get_media_urlGet a signed download URL and metadata for a WhatsApp media ID.
get_message_templateGet a single WhatsApp message template by ID.
get_phone_numberGet details of a WhatsApp phone number.
get_pricing_analyticsGet WhatsApp pricing analytics (cost and volume per pricing category and type) for a time range.
get_wabaGet WhatsApp Business Account details: name, currency, timezone, status, template namespace, verification status, country, and ownership type.
list_blocked_usersList WhatsApp users blocked from messaging the credential's phone number.
list_business_accountsList WhatsApp Business Accounts owned by or shared with a Meta business.
list_message_templatesList message templates on the WhatsApp Business Account.
list_phone_numbersList all WhatsApp phone numbers on the WhatsApp Business Account.
list_subscribed_appsList apps subscribed to webhooks on the WhatsApp Business Account.
validate_credentialValidate WhatsApp credentials by reading the WhatsApp Business Account and confirming the phone number ID is one of its numbers.

Write (15)​

Create or send data.

ToolWhat it does
add_phone_numberAdd a phone number to the WhatsApp Business Account to begin Cloud API onboarding.
block_usersBlock one or more WhatsApp users from messaging the credential's phone number.
create_message_templateCreate a WhatsApp message template (AUTHENTICATION, MARKETING, or UTILITY).
mark_message_as_readMark an incoming WhatsApp message as read.
send_contacts_messageSend one or more vCard-style contacts as a WhatsApp message.
send_interactive_messageSend a WhatsApp interactive message (reply buttons, list picker, CTA URL button, flow, catalog, product).
send_location_messageSend a location pin as a WhatsApp message.
send_media_messageSend a WhatsApp media message (image, video, audio, document, or sticker).
send_reactionReact to an incoming WhatsApp message with a single emoji.
send_template_messageSend an approved WhatsApp template message.
send_text_messageSend a plain-text WhatsApp message.
send_verification_codeRequest an SMS or voice verification code for a phone number being onboarded.
subscribe_webhookSubscribe the Meta app to this WhatsApp Business Account's webhooks, using the callback URL already configured on the app.
upload_mediaUpload a media file (image/video/audio/document/sticker, up to 100MB) to WhatsApp.
verify_phone_numberVerify a phone number using its SMS or voice code.

Delete or overwrite (8)​

Remove or replace existing data.

ToolWhat it does
delete_mediaDelete a WhatsApp media object by ID.
delete_message_templateDelete a WhatsApp message template.
deregister_phone_numberUse to offboard a registered phone number.
register_phone_numberRegister a verified phone number for WhatsApp Cloud API messaging and set its six-digit two-step verification PIN.
unblock_usersUnblock one or more previously-blocked WhatsApp users on the credential's phone number.
unsubscribe_webhookUnsubscribe the Meta app from this WhatsApp Business Account's webhooks when delivery should stop.
update_business_profileUpdate the WhatsApp business profile (about, address, description, email, websites, vertical).
update_message_templateEdit an existing WhatsApp message template.
⌘J