WhatsApp

Returns the current health status of the MCP server.

Inputs:

None

Output:

{
  "status": "ok",
  "server": "CL WhatsApp MCP Server"
}

usage Example:

curl -X POST http://localhost:8000/tools/health_check

Send a plain text message to a WhatsApp contact using the 24-hour customer service window or an active conversation 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 (e.g., 917823846641)
• message_text (string, required) — Text content of the message

Output:

{
  "messaging_product": "whatsapp",
  "contacts": [{

Send a template message that has been pre-approved by WhatsApp. Templates have no delivery restrictions and work for cold outreach.

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
• template_name (string, required) — Name of the approved template (e.g., hello_world)
• template_language_code (string, optional, default: en_US) — Template language code (e.g., en_US, es_ES)

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
• template_language_code (string, optional, default: en_US) — Template language code (e.g., en_US, )

Test your WhatsApp Cloud API connection and phone number configuration. Retrieves phone number details and quality rating.

Inputs:

• api_key (string, required) — WhatsApp Cloud API access token
• phone_number_id (string, required) — Your WhatsApp Business Account phone number ID

Output:

{
  "id": "1077755395418019",
  "display_phone_number": "+1 (555) 555-1234",
  "quality_rating": "GREEN"
}

usage Example:

Fetch the download URL for media attachments from received messages (images, videos, documents, audio).

Inputs:

• api_key (string, required) — WhatsApp Cloud API access token
• media_id (string, required) — ID of the media attachment

Output:

{
  "id": "media_id",
  "url": "https://media.graph.facebook.com/...",
  "media_product_type": "MESSAGES"
}

usage Example:

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

Output:

{
  "messaging_product": "whatsapp",
  "permission": {
    "status": "granted",
    "expiration_time": 1234567890

Manage WhatsApp calls with actions to connect, accept, reject, or terminate. Supports session description protocol (SDP) for call setup.

Inputs:

• api_key (string, required) — WhatsApp Cloud API access token
• phone_number_id (string, required) — Your WhatsApp Business Account phone number ID
• action (string, required) — Call action: connect, pre_accept, accept, reject, or terminate
• 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_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.
• template_language_code (string, optional, default ) — Template locale code.

Phone Number ID:

numeric string
Example: 1077755395418019

whatsapp Business Account ID:

numeric string
Example: 215589313241560883

recipient Phone Number:

country code + subscriber number (digits only)
Example: 14155552671

media ID:

This server requires three values:

• api_key (system user access token)
• phone_number_id
• whatsapp_business_account_id

Prerequisites

1. You have a Facebook account or a managed Meta account.
2. You are registered as a Meta developer.
3. You have access to a device with WhatsApp installed for test messaging.

If you are not registered as a developer, register at: https://developers.facebook.com/async/registration/

Step 1: Create a Meta App with WhatsApp Use Case

1. Open the App Dashboard in Meta for Developers.
2. If you already have an app:

• Select the app.
• Click Add use cases.
• Choose Connect with customers through WhatsApp.

3. If you do not have an app:

• Create a new app.
• Choose Connect with customers through WhatsApp use case.

Error: "Object with ID does not exist"

• Cause: Wrong phone_number_id or not linked to your access token
• Solution:
  1. Verify phone_number_id in WhatsApp Business Manager
  2. Confirm phone number is verified
  3. Check token has whatsapp_business_messaging scope

Message Accepted but Not Delivered

• Cause: Outside 24-hour customer service window
• Solution:
  1. Ask user to message you first OR
  2. Use a template message instead
  3. Use send_template_message tool (unrestricted)

"Invalid Access Token" Error

• Cause: Token expired or invalid
• Solution:
  1. Regenerate token in Business Manager
  2. Verify token has required scopes
  3. Check token is not revoked

• WhatsApp Cloud API Docs — Official API reference
• Getting Started Guide — Setup and first message
• Message Templates — Template management
• Error Codes Reference — API error codes
• FastMCP Docs — MCP framework specification