# Maytapi - WhatsApp Unofficial API For Developers

> WhatsApp Unofficial API for developers. Send and receive all message types, manage groups, channels, communities, business catalogs, and statuses via simple REST API. Fixed monthly pricing per number, unlimited messaging, no per-message fees, multi-device support, 99.98% uptime.

## Getting Started

1. Create account at [Console](https://console.maytapi.com/register)
2. Pair your WhatsApp by scanning QR code
3. Get `product_id` and `token` from [Settings](https://console.maytapi.com/settings/token)
4. Make API calls to `https://api.maytapi.com/api/{product_id}/{phone_id}/`
5. Authenticate with header: `x-maytapi-key: YOUR_TOKEN`

## Documentation

- [API Documentation](https://maytapi.com/whatsapp-api-documentation): Full interactive endpoint reference with examples
- [OpenAPI Spec (JSON)](https://maytapi.com/documentations/maytapi_doc.json): Machine-readable API specification
- [Postman Collection](https://maytapi.com/whatsapp-postman-documentation): Ready-to-use API workspace
- [Pricing](https://maytapi.com/whatsapp-api-pricing): Plans and pricing details

## API Capabilities

### Messaging (`POST /{phone_id}/sendMessage`)
Send to any WhatsApp number, group, or channel. Supported types: text, image, video, audio, document, location, contact/vCard, poll, button, list, catalog, product, reaction, reply, forward, edit, delete. Media supports both URL and base64. Built-in spam filter (bypass with `skip_filter: true`).

### Groups
Create groups, list groups, get group info, add/remove participants, promote/demote admins, generate invite links, set group name/description/icon, leave group.

### Channels (Newsletters)
Create channels, list channels, send messages to channels, search public channels, follow/unfollow channels, set channel description/icon, get channel messages.

### Communities
Create communities, list communities, get community info, add/remove groups to community.

### Business Catalog
List/create/edit/delete products, manage collections, list orders, get order details, send product and catalog messages.

### Status / Story (Beta)
Publish story statuses (image/video/text), retrieve contact statuses.

### Webhooks
Set webhook URL to receive: incoming messages (all types), delivery receipts (ack), read receipts, group events, channel events. Configure per-product or per-phone.

### Phone Management
List phones, get QR code/screen status, check connection status, redeploy instance, factory reset, logout, view logs, check/purge message queue.

### Contacts & Conversations
List contacts, get contact info, check if number is on WhatsApp, list conversations, get conversation messages, change profile picture.

## Number Formats
- Individual: `905301234567` or `905301234567@c.us`
- Groups: `XXXXXXXXXX@g.us`
- Channels: `XXXXXXXXXX@newsletter`

## Example Projects

- [Node.js Bot](https://github.com/maytapi-com/whatsapp-api-nodejs-example): Echo bot with media support
- [Python Bot](https://github.com/maytapi-com/whatsapp-api-python-example): Python webhook handler
- [Node.js Dialogflow](https://github.com/maytapi-com/whatsapp-api-nodejs-dialogflow-example): AI chatbot integration
- [Python Dialogflow](https://github.com/maytapi-com/whatsapp-api-python-dialogflow-example): Python AI chatbot

## Integrations

- [MCP Server](https://maytapi.com/tools/maytapi-mcp-server): Model Context Protocol integration
- [n8n Integration](https://maytapi.com/tools/maytapi-n8n-integration): No-code workflow automation
- [Google Contacts Integration](https://maytapi.com/tools/maytapi-google-contacts-integration): Sync WhatsApp with Google Contacts

## Free Tools

- [WhatsApp Number Checker](https://maytapi.com/tools/free-whatsapp-number-checker-tool): Verify if number is on WhatsApp
- [Chat Link Generator](https://maytapi.com/tools/free-whatsapp-link-generator): Create wa.me links
- [QR Code Generator](https://maytapi.com/tools/free-whatsapp-qr-code-generator): Generate WhatsApp QR codes
- [Text Formatter](https://maytapi.com/tools/whatsapp-text-formatter): Bold, italic, strikethrough formatting
- [JSON Escape/Unescape](https://maytapi.com/tools/json-escaper-unascaper): JSON utility

## Feature Pages

- [WhatsApp Group API](https://maytapi.com/features/whatsapp-group-api): Group management overview
- [WhatsApp Channel API](https://maytapi.com/features/whatsapp-channel-api): Channel operations overview
- [WhatsApp Community API](https://maytapi.com/features/whatsapp-community-api): Community management overview
- [WhatsApp Status API](https://maytapi.com/features/whatsapp-status-api): Status/Story operations overview
- [Multi-Agent Platform](https://maytapi.com/multi-agent-platform-for-whatsapp): Multi-agent customer support

## Support & Resources

- [Console Dashboard](https://console.maytapi.com/)
- [Status Page](https://status.maytapi.com/)
- [Changelog](https://maytapi.com/changelog)
- [FAQ](https://maytapi.com/whatsapp-api-faq)
- [Partner Program](https://maytapi.com/whatsapp-api-partner)
- [Blog](https://medium.com/maytapi)
- [GitHub](https://github.com/maytapi-com)
- [Contact](https://maytapi.com/contact)
- [Terms of Service](https://maytapi.com/legal/terms)
- [Privacy Policy](https://maytapi.com/legal/privacy)