Labsco
aldinokemal logo

WhatsApp API Multi Device Version

★ 4,200

from aldinokemal

A multi-device WhatsApp API server for AI agents and tools.

🔥🔥🔥🔥✓ VerifiedFreeAdvanced setup
#email#automation#database#cloud#devops#git#maps#security

Golang WhatsApp - Built with Go for efficient memory use

**If you're using this tools to generate income, consider supporting its development by becoming a Patreon member!**Your support helps ensure the library stays maintained and receives regular updates!

Support for ARM & AMD Architecture along with MCP Support

Download:

  • Release

  • Docker Hub

  • GitHub Container Registry

Support n8n package (n8n.io)

  • n8n package

  • Go to Settings -> Community Nodes -> Input @aldinokemal2104/n8n-nodes-gowa -> Install

Breaking Changes

  • v6

  • For REST mode, you need to run <binary> rest instead of <binary>

  • for example: ./whatsapp rest instead of ./whatsapp
  • For MCP mode, you need to run <binary> mcp
  • for example: ./whatsapp mcp

  • v7

  • Starting version 7.x we are using goreleaser to build the binary, so you can download the binary from release

  • v8

  • Multi-device support: You can now connect and manage multiple WhatsApp accounts simultaneously in a single server instance

  • New Device Management API: New endpoints under /devices for managing multiple devices

  • Device scoping required: All device-scoped REST API calls now require either:

  • X-Device-Id header, or
  • device_id query parameter
  • If only one device is registered, it will be used as the default

  • WebSocket device scoping: Connect to /ws?device_id=<id> to scope WebSocket to a specific device

  • Webhook payload changes: All webhook payloads now include a top-level device_id field identifying which device received the event:

Copy & paste — that's it
```json 
{ 
 "event": "message", 
 "device_id": "[email protected]", 
 "payload": { ... } 
}
Copy & paste — that's it

Feature

  • Send WhatsApp message via http API, docs/openapi.yaml for more details

  • MCP (Model Context Protocol) Server Support - Integrate with AI agents and tools using standardized protocol

  • Mention someone

  • @phoneNumber

  • example: Hello @628974812XXXX, @628974812XXXX

  • Ghost Mentions (Mention All) - Mention group participants without showing @phone in message text

  • Pass phone numbers in mentions field to mention users without visible @ in message

  • Use special keyword @everyone to automatically mention ALL group participants

  • UI checkbox available in Send Message modal for groups

  • Post Whatsapp Status

  • Send Stickers - Automatically converts images to WebP sticker format

  • Supports JPG, JPEG, PNG, WebP, and GIF formats

  • Automatic resizing to 512x512 pixels

  • Preserves transparency for PNG images

  • Animated WebP stickers are supported but must meet WhatsApp requirements:

  • Must be exactly 512x512 pixels
  • Must be under 500KB file size
  • Maximum 10 seconds duration
  • If your animated sticker doesn't meet these requirements, please resize it before uploading using tools like ezgif.com

  • Compress image before send

  • Compress video before send

  • Change OS name become your app (it's the device name when connect via mobile)

  • --os=Chrome or --os=MyApplication

  • Basic Auth (able to add multi credentials)

  • --basic-auth=kemal:secret,toni:password,userName:secretPassword, or you can simplify

  • -b=kemal:secret,toni:password,userName:secretPassword

  • Subpath deployment support

  • --base-path="/gowa" (allows deployment under a specific path like /gowa/sub/path)

  • Customizable port and debug mode

  • --port 8000

  • --debug true

  • Auto reply message

  • --autoreply="Don't reply this message"

  • Auto mark read incoming messages

  • --auto-mark-read=true (automatically marks incoming messages as read)

  • Auto download media from incoming messages

  • --auto-download-media=false (disable automatic media downloads, default: true)

  • Auto reject incoming calls

  • --auto-reject-call=true or WHATSAPP_AUTO_REJECT_CALL=true (see Webhook Payload for call events)

  • Configurable presence on connect

  • --presence-on-connect=unavailable or WHATSAPP_PRESENCE_ON_CONNECT=unavailable

  • available — mark as online (suppresses phone notifications)

  • unavailable — register pushname without going online (default, preserves phone notifications)

  • none — skip presence entirely (pushname won't be registered, contacts may see "-" as name)

  • Daily presence pulse

  • --presence-pulse-enabled=true or WHATSAPP_PRESENCE_PULSE_ENABLED=true (default: true)

  • --presence-pulse-interval=24h controls how often each connected device is pulsed

  • --presence-pulse-duration=5m controls how long the account stays available before returning to unavailable

  • Webhook for received message

  • --webhook="http://yourwebhook.site/handler", or you can simplify

  • -w="http://yourwebhook.site/handler"

  • for more detail, see Webhook Payload Documentation

  • Per-Device Webhook - Each device can have its own webhook URL

  • Set via API: PATCH /devices/:device_id/webhook with {"webhook_url": "https://device-webhook.site/handler"}

  • Get via API: GET /devices/:device_id/webhook

  • When a device has a custom webhook, events for that device are sent to the device-specific URL

  • When no device webhook is set, events fall back to the global webhook (--webhook)

  • Set to empty string "" via PATCH to clear and use global webhook

  • Webhook Secret Our webhook will be sent to you with an HMAC header and a sha256 default key secret. You may modify this by using the option below:

  • --webhook-secret="secret"

  • Webhook Payload DocumentationFor detailed webhook payload schemas, security implementation, and integration examples, see Webhook Payload Documentation

  • Webhook Event FilteringYou can filter which events are forwarded to your webhook using:

  • --webhook-events="message,message.ack" (comma-separated list)

  • Or environment variable: WHATSAPP_WEBHOOK_EVENTS=message,message.ack Available Webhook Events: | Event | Description | | ------------------ | --------------------------------------------- | | message | Text, media, contact, location messages | | message.reaction | Emoji reactions to messages | | message.revoked | Deleted/revoked messages | | message.edited | Edited messages | | message.ack | Delivery and read receipts | | message.deleted | Messages deleted for the user | | chat_presence | Typing and recording indicators from contacts | | group.participants | Group member join/leave/promote/demote events | | group.joined | You were added to a group | | label.edit | WhatsApp label metadata changed | | label.association | Label applied to or removed from a chat | | newsletter.joined | You subscribed to a newsletter/channel | | newsletter.left | You unsubscribed from a newsletter | | newsletter.message | New message(s) posted in a newsletter | | newsletter.mute | Newsletter mute setting changed | | call.offer | Incoming call received | If not configured (empty), all events will be forwarded.

  • Webhook TLS Configuration If you encounter TLS certificate verification errors when using webhooks (e.g., with Cloudflare tunnels or self-signed certificates):

Copy & paste — that's it
tls: failed to verify certificate: x509: certificate signed by unknown authority

You can disable TLS certificate verification using:

  • --webhook-insecure-skip-verify=true

  • Or environment variable: WHATSAPP_WEBHOOK_INSECURE_SKIP_VERIFY=true Security Warning: This option disables TLS certificate verification and should only be used in:

  • Development/testing environments

  • Cloudflare tunnels (which provide their own security layer)

  • Internal networks with self-signed certificates For production environments, it's strongly recommended to use proper SSL certificates (e.g., Let's Encrypt) instead of disabling verification.

Current API

MCP (Model Context Protocol) API

  • MCP server provides standardized tools for AI agents to interact with WhatsApp

  • Supports Server-Sent Events (SSE) transport

  • Available tools are listed in the "Available MCP Tools" section above.

  • Compatible with MCP-enabled AI tools and agents

HTTP REST API

  • Check docs/openapi.yaml for detailed API specifications.

  • Use SwaggerEditor to visualize the API.

  • Generate HTTP clients using openapi-generator.

Feature Menu Method URL ✅ Health Check GET /health ✅ List Devices GET /devices ✅ Add Device POST /devices ✅ Get Device Info GET /devices/:device_id ✅ Remove Device DELETE /devices/:device_id ❌ Login Device (QR, reserved) GET /devices/:device_id/login ❌ Login Device (Code, reserved) POST /devices/:device_id/login/code ✅ Logout Device POST /devices/:device_id/logout ✅ Reconnect Device POST /devices/:device_id/reconnect ✅ Get Device Status GET /devices/:device_id/status ✅ Get Device Webhook GET /devices/:device_id/webhook ✅ Set Device Webhook PATCH /devices/:device_id/webhook ✅ Login with Scan QR GET /app/login ✅ Login With Pair Code GET /app/login-with-code ✅ Passkey Pairing Status GET /app/passkey ✅ Passkey Pairing Response POST /app/passkey/response ✅ Passkey Pairing Confirm POST /app/passkey/confirm ✅ Logout GET /app/logout ✅ Reconnect GET /app/reconnect ✅ Devices GET /app/devices ✅ Connection Status GET /app/status ✅ User Info GET /user/info ✅ User Avatar GET /user/avatar ✅ User Change Avatar POST /user/avatar ✅ User Change PushName POST /user/pushname ✅ User My Groups* GET /user/my/groups ✅ User My Newsletter GET /user/my/newsletters ✅ User My Privacy Setting GET /user/my/privacy ✅ User My Contacts GET /user/my/contacts ✅ User Check GET /user/check ✅ User Business Profile GET /user/business-profile ✅ Send Message POST /send/message ✅ Send Image POST /send/image ✅ Send Audio POST /send/audio ✅ Send File POST /send/file ✅ Send Video POST /send/video ✅ Send Sticker POST /send/sticker ✅ Send Contact POST /send/contact ✅ Send Link POST /send/link ✅ Send Location POST /send/location ✅ Send Poll / Vote POST /send/poll ✅ Send Presence POST /send/presence ✅ Send Chat Presence (Typing Indicator) POST /send/chat-presence ✅ Revoke Message POST /message/:message_id/revoke ✅ React Message POST /message/:message_id/reaction ✅ Delete Message POST /message/:message_id/delete ✅ Edit Message POST /message/:message_id/update ✅ Read Message (DM) POST /message/:message_id/read ✅ Star Message POST /message/:message_id/star ✅ Unstar Message POST /message/:message_id/unstar ✅ Download Message Media GET /message/:message_id/download ✅ Reject Call POST /call/reject ✅ Join Group With Link POST /group/join-with-link ✅ Group Info From Link GET /group/info-from-link ✅ Group Info GET /group/info ✅ Leave Group POST /group/leave ✅ Create Group POST /group ✅ List Participants in Group GET /group/participants ✅ Add Participants in Group POST /group/participants ✅ Remove Participant in Group POST /group/participants/remove ✅ Promote Participant in Group POST /group/participants/promote ✅ Demote Participant in Group POST /group/participants/demote ✅ Export Group Participants (CSV) GET /group/participants/export ✅ List Requested Participants in Group GET /group/participant-requests ✅ Approve Requested Participant in Group POST /group/participant-requests/approve ✅ Reject Requested Participant in Group POST /group/participant-requests/reject ✅ Set Group Photo POST /group/photo ✅ Set Group Name POST /group/name ✅ Set Group Locked POST /group/locked ✅ Set Group Announce POST /group/announce ✅ Set Group Topic POST /group/topic ✅ Get Group Invite Link GET /group/invite-link ✅ Unfollow Newsletter POST /newsletter/unfollow ✅ Get Newsletter Messages GET /newsletter/messages ✅ Get Chat List GET /chats ✅ Get Chat Messages GET /chat/:chat_jid/messages ✅ Pin Chat POST /chat/:chat_jid/pin ✅ Archive Chat POST /chat/:chat_jid/archive ✅ Set Disappearing Messages POST /chat/:chat_jid/disappearing ✅ Chatwoot Sync History POST /chatwoot/sync ✅ Chatwoot Sync Status GET /chatwoot/sync/status ✅ Chatwoot Reply Webhook POST /chatwoot/webhook

Copy & paste — that's it
✅ = Available
❌ = Not Available Yet
* = Has known limitations (see notes below)

Notes:

  • *User My Groups: Returns a maximum of 500 groups due to WhatsApp protocol limitation. This is enforced by WhatsApp servers, not this API. See whatsmeow source for details.

  • /health is public and always registered at the root path, even when APP_BASE_PATH is set.

  • Device-specific login routes are reserved by the router but not implemented by the current usecase. Use /app/login or /app/login-with-code with X-Device-Id or device_id to pair a specific slot.

  • Chatwoot routes are registered only when CHATWOOT_ENABLED=true.

User Interface

MCP UI

  • Setup MCP (tested in cursor)

  • Test MCP

  • Successfully setup MCP

HTTP REST API UI

Description Image Homepage Login Login With Code Send Message Send Image Send File Send Video Send Sticker Send Contact Send Location Send Audio Send Poll Send Presence Send Link My Group Group Info From Link Create Group Join Group with Link Manage Participant My Newsletter My Contacts Business Profile

Mac OS NOTE

  • Please do this if you have an error (invalid flag in pkg-config --cflags: -Xpreprocessor)export CGO_CFLAGS_ALLOW="-Xpreprocessor"

Important

  • This project is unofficial and not affiliated with WhatsApp.

  • Please use official WhatsApp API to avoid any issues.

  • We only able to run MCP or REST API, this is limitation from whatsmeow library. independent MCP will be available in the future.