Send media files to a WhatsApp contact using direct URLs (within 24-hour window or active thread).
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
phone_number_id (string, required) — Your WhatsApp Business Account phone number ID
recipient_phone (string, required) — Recipient's phone number with country code
media_type (string, required) — Type of media: image, video, audio, or document
media_url (string, required) — Public URL of the media file
(string, optional) — Caption text (image and video only)
Send pre-approved marketing template messages with optional policy controls and activity sharing settings. Marketing templates are not subject to the 24-hour message window restrictions.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
phone_number_id (string, required) — Your WhatsApp Business Account phone number ID
recipient_phone (string, required) — Recipient's phone number with country code (e.g., 917823846641)
template_name (string, required) — Name of the approved marketing template
Retrieve paginated delivery status events for messages using the WhatsApp Message History API. Supports filtering by status and pagination.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
message_history_id (string, required) — WhatsApp Business Message History ID
status_filter (string, optional) — Filter by status: ACCEPTED, DELIVERED, ERROR, READ, SENT
fields (string, optional) — Comma-separated fields to include (e.g., )
Configure conversational automation settings for a WhatsApp Business Account phone number, including welcome messages, conversation prompts, and bot commands.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
phone_number_id (string, required) — Your WhatsApp Business Account phone number ID
enable_welcome_message (boolean, optional) — Enable/disable welcome messages for new conversations
prompts (array, optional) — List of conversation prompts (ice breakers) to guide customer interactions
commands (array, optional) — List of bot commands with command_name and command_description keys
Output:
Fetch WhatsApp Business Bot configuration including id, prompts, commands, and welcome message settings.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
bot_id (string, required) — WhatsApp Business Bot ID
fields (string, optional) — Comma-separated fields to include (e.g., id,prompts,commands,enable_welcome_message)
Output:
{ "id": "123456789", "enable_welcome_message": true, "prompts": ["How can I help you?"
Check whether you have permission to call a WhatsApp user and retrieve available actions and rate limits.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
phone_number_id (string, required) — Your WhatsApp Business Account phone number ID
user_wa_id (string, required) — The WhatsApp ID of the user to check call permissions for
to (string, optional) — The WhatsApp number being called (required for connect/pre_accept/accept/reject)
(string, optional) — The WhatsApp call ID (required for terminate action)
Retrieve details for a WhatsApp Message QR code including the image URL for use in marketing materials.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
phone_number_id (string, required) — Your WhatsApp Business Account phone number ID
qr_code_id (string, required) — The unique 14-character identifier of the QR code
fields (string, optional) — Comma-separated fields to include (e.g., code,prefilled_message,deep_link_url,qr_image_url.format(SVG))
Output:
{ "data": [ { "code":
Permanently delete a WhatsApp Message QR code. Once deleted, the QR code and associated deep link become invalid. This action cannot be undone.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
phone_number_id (string, required) — Your WhatsApp Business Account phone number ID
qr_code_id (string, required) — The unique 14-character identifier of the QR code to delete
Output:
{ "success": true}
usage Example:
Retrieve comprehensive information about your WhatsApp Business Profile including account name, description, contact details, business vertical, websites, and profile picture.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
business_profile_id (string, required) — Your WhatsApp Business Profile ID
fields (string, optional) — Comma-separated fields to include (e.g., id,account_name,description,email,about,address,vertical,websites,profile_picture_url)
Output:
{ "id": "123456789", "account_name": "My Business",
Update your WhatsApp Business Profile with current business information, contact details, and configuration. All fields are optional.
Inputs:
api_key (string, required) — WhatsApp Cloud API access token
business_profile_id (string, required) — Your WhatsApp Business Profile ID
account_name (string, optional) — Name of the business account
description (string, optional) — Business description text
email (string, optional) — Contact email address
about (string, optional) — About section text
address (string, optional) — Physical address of the business
vertical (string, optional) — Industry vertical classification
API Parameters Reference
api_key (string, required) — System user access token used as Authorization: Bearer <token>.
phone_number_id (string, required for send/test tools) — WhatsApp Business phone number ID used in Graph API paths.
recipient_phone (string, required for send tools) — WhatsApp user phone number in international format, digits only, include country code (no +, spaces, or leading zero).
media_id (string, required for attachment tool) — Media object ID returned by WhatsApp.
message_text (string, required for text messages) — Text body to send.
template_name (string, required for template messages) — Approved template name in your WhatsApp Business Account.
curl -X POST http://localhost:8000/tools/configure_conversational_automation \ -H "Content-Type: application/json" \ -d '{ "api_key": "YOUR_API_KEY", "phone_number_id": "1077755395418019", "enable_welcome_message": true, "prompts": ["How can I help you?", "What do you need?"], "commands": [ { "command_name": "help", "command_description": "Get help with your order" }, { "command_name": "status", "command_description": "Check your order status" } ] }'