# Whatsapp

```json
{
  "name": "Whatsapp",
  "slug": "whatsapp",
  "url": "https://composio.dev/toolkits/whatsapp",
  "markdown_url": "https://composio.dev/toolkits/whatsapp.md",
  "logo_url": "https://logos.composio.dev/api/whatsapp",
  "categories": [
    "collaboration & communication"
  ],
  "is_composio_managed": true,
  "updated_at": "2026-05-12T10:30:18.573Z"
}
```

![Whatsapp logo](https://logos.composio.dev/api/whatsapp)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Whatsapp MCP or direct API to send messages, fetch conversations, automate replies, and manage contacts through natural language.

## Summary

WhatsApp is a business messaging platform for secure, automated customer communication. It streamlines chat workflows and customer outreach using the WhatsApp Business API.

## Categories

- collaboration & communication

## Toolkit Details

- Tools: 17
- Triggers: 1
- Managed auth: Managed by Composio

## Images

- Logo: https://logos.composio.dev/api/whatsapp

## Authentication

- **Oauth2**
  - Type: `oauth2`
  - Description: Oauth2 authentication for WhatsApp.
  - Setup:
    - Configure Oauth2 credentials for WhatsApp.
    - Use the credentials when creating an auth config in Composio.
- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for WhatsApp.
  - Setup:
    - Configure Api Key credentials for WhatsApp.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Send contact card to new lead
- Get business profile details for support
- List all approved message templates
- Download media from latest customer message

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `WHATSAPP_CREATE_MESSAGE_TEMPLATE` | Create message template | Create a new message template for the WhatsApp Business Account. Templates must be approved by WhatsApp before they can be used. Templates are required for marketing messages and messages sent outside the 24-hour window. |
| `WHATSAPP_DELETE_MESSAGE_TEMPLATE` | Delete message template | Delete a message template from the WhatsApp Business Account by name. This permanently removes the template and it cannot be recovered. When you delete a template by name, all templates with that name across all languages will be deleted. Names of deleted templates cannot be reused for 30 days. Important: Only delete templates that are no longer needed, as this operation is irreversible. |
| `WHATSAPP_GET_BUSINESS_PROFILE` | Get business profile | Get the business profile information for a WhatsApp Business phone number. This includes business details like description, address, website, and contact info. |
| `WHATSAPP_GET_MEDIA_INFO` | Get media info | Get metadata and download URL for uploaded WhatsApp media. Returns media ID, download URL (valid for 5 minutes), MIME type, SHA256 hash, and file size. The download URL can be used to retrieve the actual media file. |
| `WHATSAPP_GET_MESSAGE_TEMPLATES` | Get message templates | Get all message templates for the WhatsApp Business Account. Templates are required for sending messages outside the 24-hour window and for marketing/utility messages. |
| `WHATSAPP_GET_PHONE_NUMBER` | Get phone number | Retrieve detailed information about a specific WhatsApp Business phone number. Returns phone number details including verification status, quality rating, display number, verified business name, throughput limits, and webhook configuration. Use this to check phone number status, settings, and capabilities. To get available phone number IDs, first call WHATSAPP_GET_PHONE_NUMBERS. |
| `WHATSAPP_GET_PHONE_NUMBERS` | Get phone numbers | Retrieve all phone numbers registered to your WhatsApp Business Account. Returns phone number IDs, display numbers, verification status, quality ratings, and messaging throughput limits. Use the phone number ID from the response to send WhatsApp messages via other API actions. |
| `WHATSAPP_GET_TEMPLATE_STATUS` | Get template status | Get the status and details of a specific message template. This is useful for checking if a template has been approved, rejected, or is still pending review. |
| `WHATSAPP_SEND_CONTACTS` | Send contacts | Send contacts WhatsApp number. Note: The message will be delivered to the recipient only if they have initiated a conversation first. |
| `WHATSAPP_SEND_INTERACTIVE_BUTTONS` | Send interactive buttons | Send an interactive button message with up to 3 reply buttons to a WhatsApp user. Interactive button messages allow recipients to quickly respond by tapping predefined buttons. Perfect for yes/no questions, multiple choice selections, quick actions, or call-to-action scenarios. IMPORTANT REQUIREMENTS: - The recipient must be a registered WhatsApp user - The recipient must have messaged your business first within the last 24 hours (WhatsApp's customer service window) - You can include 1-3 buttons per message - Each button can have a title (max 20 chars) and unique ID (max 256 chars) Use cases: Customer service menus, appointment confirmations, feedback collection, product selections. |
| `WHATSAPP_SEND_INTERACTIVE_LIST` | Send interactive list | Send an interactive list message to a WhatsApp number. List messages display a menu of options organized into sections. Users tap a button to view the list and select one option. Perfect for product catalogs, service menus, or guided workflows. Supports up to 10 sections with up to 10 items per section (100 total options). Note: Recipients must have messaged you first within the last 24 hours to receive this message. |
| `WHATSAPP_SEND_LOCATION` | Send location | Send a location message with coordinates, name, and address to a WhatsApp user. This action allows you to share location information through WhatsApp Business API. The location message includes latitude/longitude coordinates, a location name, and address. Important: The recipient must have an active WhatsApp account. Additionally, you can only send free-form messages (like location messages) within the 24-hour customer service window after the recipient has initiated contact with your business. Outside this window, you must use approved message templates. Common error codes: - 133010: Recipient's phone number doesn't have a WhatsApp account - 131026: Message undeliverable (recipient may have blocked your business number) - 131047: Re-engagement message (outside 24-hour window, need to use template) |
| `WHATSAPP_SEND_MEDIA` | Send media | Send a media message to a WhatsApp number. Note: The media will be delivered to the recipient only if they have texted first. |
| `WHATSAPP_SEND_MEDIA_BY_ID` | Send media by | Send media using a media ID from previously uploaded media. This is more efficient than sending media by URL as the media is already on WhatsApp servers. Use upload_media action first to get the media ID. Note: The media will be delivered to the recipient only if they have texted first. |
| `WHATSAPP_SEND_MESSAGE` | Send message | Send a text message to a WhatsApp user. Important: The recipient phone number must be registered on WhatsApp and must have initiated a conversation with your business within the last 24 hours, OR you must use a template message (see WHATSAPP_SEND_TEMPLATE_MESSAGE) for the first message outside the 24-hour window. For test accounts, recipient numbers must be added to the test recipient list in Meta Business Suite before sending messages. |
| `WHATSAPP_SEND_TEMPLATE_MESSAGE` | Send template message | Send a template message to a WhatsApp number. |
| `WHATSAPP_UPLOAD_MEDIA` | Upload media | Upload media files (images, videos, audio, documents, stickers) to WhatsApp servers. The uploaded media gets a media ID that can be used in send_media or other messaging actions. Supported formats: - Images: JPEG, PNG (max 5MB) - Videos: MP4, 3GPP (max 16MB) - Audio: AAC, M4A, AMR, MP3, OGG (max 16MB) - Documents: PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX (max 100MB) - Stickers: WebP (max 500KB, 512x512 pixels) |

## Supported Triggers

| Trigger slug | Name | Description |
|---|---|---|
| `WHATSAPP_MESSAGE_STATUS_UPDATED_TRIGGER` | Message Status Updated | Triggers when a WhatsApp message status changes. IMPORTANT LIMITATION: WhatsApp Cloud API does not provide a native polling endpoint for message status. Status updates are ONLY delivered via webhooks in real-time. This trigger cannot directly poll the WhatsApp API for status updates. This trigger will return empty results as WhatsApp does not support this operation. To track message status updates, you must: 1. Set up a webhook endpoint to receive status notifications from WhatsApp 2. Store the webhook data in your own database 3. Use a different mechanism to query your stored webhook data For more information, see: - https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks |

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Whatsapp Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Whatsapp actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Send a welcome message to new customers via WhatsApp Business'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Send a welcome message to new customers via WhatsApp Business'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Whatsapp tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Send a WhatsApp message to +1234567890 saying Hello!')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Send a WhatsApp message to +1234567890 saying Hello!' }],
  stopWhen: stepCountIs(5)
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Whatsapp Integration

- Supports both Whatsapp MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Whatsapp data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Whatsapp access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Whatsapp
- Scoped, least privilege access to Whatsapp resources
- Full audit trail of agent actions to support review and compliance

## Use Whatsapp with any AI Agent Framework

Choose a framework you want to connect Whatsapp with:

- [ChatGPT](https://composio.dev/toolkits/whatsapp/framework/chatgpt)
- [OpenAI Agents SDK](https://composio.dev/toolkits/whatsapp/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/whatsapp/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/whatsapp/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/whatsapp/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/whatsapp/framework/codex)
- [Cursor](https://composio.dev/toolkits/whatsapp/framework/cursor)
- [VS Code](https://composio.dev/toolkits/whatsapp/framework/vscode)
- [OpenCode](https://composio.dev/toolkits/whatsapp/framework/opencode)
- [OpenClaw](https://composio.dev/toolkits/whatsapp/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/whatsapp/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/whatsapp/framework/cli)
- [Google ADK](https://composio.dev/toolkits/whatsapp/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/whatsapp/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/whatsapp/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/whatsapp/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/whatsapp/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/whatsapp/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/whatsapp/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/whatsapp/framework/autogen)

## Related Toolkits

- [Gmail](https://composio.dev/toolkits/gmail) - Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable.
- [Outlook](https://composio.dev/toolkits/outlook) - Outlook is Microsoft's email and calendaring platform for unified communications and scheduling. It helps users stay organized with powerful email, contacts, and calendar management.
- [Slack](https://composio.dev/toolkits/slack) - Slack is a channel-based messaging platform for teams and organizations. It helps people collaborate in real time, share files, and connect all their tools in one place.
- [Gong](https://composio.dev/toolkits/gong) - Gong is a platform for video meetings, call recording, and team collaboration. It helps teams capture conversations, analyze calls, and turn insights into action.
- [Microsoft teams](https://composio.dev/toolkits/microsoft_teams) - Microsoft Teams is a collaboration platform that combines chat, meetings, and file sharing within Microsoft 365. It keeps distributed teams connected and productive through seamless virtual communication.
- [Slackbot](https://composio.dev/toolkits/slackbot) - Slackbot is a conversational automation tool for Slack that handles reminders, notifications, and automated responses. It boosts team productivity by streamlining onboarding, answering FAQs, and managing timely alerts—all right inside Slack.
- [2chat](https://composio.dev/toolkits/_2chat) - 2chat is an API platform for WhatsApp and multichannel text messaging. It streamlines chat automation, group management, and real-time messaging for developers.
- [Agent mail](https://composio.dev/toolkits/agent_mail) - Agent mail provides AI agents with dedicated email inboxes for sending, receiving, and managing emails. It empowers agents to communicate autonomously with people, services, and other agents—no human intervention needed.
- [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place.
- [Chatwork](https://composio.dev/toolkits/chatwork) - Chatwork is a team communication platform with group chats, file sharing, and task management. It helps businesses boost collaboration and streamline productivity.
- [Clickmeeting](https://composio.dev/toolkits/clickmeeting) - ClickMeeting is a cloud-based platform for running online meetings and webinars. It helps businesses and individuals host, manage, and engage virtual audiences with ease.
- [Confluence](https://composio.dev/toolkits/confluence) - Confluence is Atlassian's team collaboration and knowledge management platform. It helps your team organize, share, and update documents and project content in one secure workspace.
- [Dailybot](https://composio.dev/toolkits/dailybot) - DailyBot streamlines team collaboration with chat-based standups, reminders, and polls. It keeps work flowing smoothly in your favorite messaging platforms.
- [Dialmycalls](https://composio.dev/toolkits/dialmycalls) - Dialmycalls is a mass notification service for sending voice and text messages to contacts. It helps teams and organizations quickly broadcast urgent alerts and updates.
- [Dialpad](https://composio.dev/toolkits/dialpad) - Dialpad is a cloud-based business phone and contact center system for teams. It unifies voice, video, messaging, and meetings across your devices.
- [Discord](https://composio.dev/toolkits/discord) - Discord is a real-time messaging and VoIP platform for communities and teams. It lets users chat, share media, and collaborate across public and private channels.
- [Discordbot](https://composio.dev/toolkits/discordbot) - Discordbot is an automation tool for Discord servers that handles moderation, messaging, and user engagement. It helps communities run smoothly by automating routine and complex tasks.
- [Echtpost](https://composio.dev/toolkits/echtpost) - Echtpost is a secure digital communication platform for encrypted document and message exchange. It ensures confidential data stays private and protected during transmission.
- [Egnyte](https://composio.dev/toolkits/egnyte) - Egnyte is a cloud-based platform for secure file sharing, storage, and governance. It helps teams collaborate efficiently while maintaining data compliance and security.
- [Google Meet](https://composio.dev/toolkits/googlemeet) - Google Meet is a secure video conferencing platform for virtual meetings, chat, and screen sharing. It helps teams connect, collaborate, and communicate seamlessly from anywhere.

## Frequently Asked Questions

### Do I need my own developer credentials to use Whatsapp with Composio?

No, you can get started immediately using Composio's built-in Whatsapp app. For production, we recommend configuring your own OAuth credentials.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)