Green API WhatsApp
Measured conclusion: Deep-tested. L2 outcome: tools_ok.
MCP gateway for WhatsApp via Green API: messaging, contacts, groups and instance management.
| Author | com.green-api |
|---|---|
| Access | remote |
| Publisher key required | No |
| Measured state | Deep-tested |
| L1 liveness | alive |
| L1 latency | 466 ms |
| Last measured | 2026-10-24 |
Add to your agent
Copy this into your MCP client config:
{
"mcpServers": {
"Green API WhatsApp": {
"url": "https://mcp.green-api.com/mcp",
"transport": "streamable-http"
}
}
}
Measured tools (41)
whatsapp_add_group_participantAdd a participant to a WhatsApp group
Parameters:
instance_id(required) — number — WhatsApp instance IDgroup_id(required) — string — Group IDparticipant_chat_id(required) — string — Participant chat ID ([email protected])
Hints: read-only no · destructive no · idempotent no · open-world yes
whatsapp_check_whatsappread-onlyCheck whether a phone number has a WhatsApp account
Parameters:
instance_id(required) — number — WhatsApp instance IDphone_number(required) — number — Phone number to check
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_connectConnect a WhatsApp instance. Call this before using other tools. Validates credentials via getStateInstance.
Parameters:
instance_id(required) — number — WhatsApp instance ID (from console.green-api.com)api_token(required) — string — Instance API tokenapi_url— string — API URL (defaults to https://api.green-api.com)
Hints: read-only no · destructive no · idempotent no · open-world no
whatsapp_create_groupCreate a WhatsApp group
Parameters:
instance_id(required) — number — WhatsApp instance IDgroup_name(required) — string — Group namechat_ids(required) — array — Participant list (chat IDs, e.g. [email protected])
Hints: read-only no · destructive no · idempotent no · open-world yes
whatsapp_create_instanceCreate a new WhatsApp instance via the GREEN-API Partner API
Parameters:
partner_token(required) — string — Partner Token from your GREEN-API dashboard
Hints: read-only no · destructive no · idempotent no · open-world yes
whatsapp_delete_instancedestructiveDelete a WhatsApp instance via the GREEN-API Partner API
Parameters:
partner_token(required) — string — Partner Token from your GREEN-API dashboardinstance_id(required) — number — Instance ID to delete
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_delete_messagedestructiveDelete a message
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat IDid_message(required) — string — ID of the message to delete
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_delete_notificationdestructiveDelete a notification from the queue (acknowledge receipt)
Parameters:
instance_id(required) — number — WhatsApp instance IDreceipt_id(required) — number — Notification ID (receiptId from receiveNotification)
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_disconnectDisconnect a WhatsApp instance and remove credentials from the session
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only no · destructive no · idempotent no · open-world no
whatsapp_edit_messagedestructiveEdit a previously sent message
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat IDid_message(required) — string — ID of the message to editmessage(required) — string — New message text
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_forward_messagesdestructiveForward messages to another chat
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Destination chat IDchat_id_from(required) — string — Source chat IDmessages(required) — array — Message IDs to forward
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_get_authorization_coderead-onlyGet an authorization code for sign-in by phone number
Parameters:
instance_id(required) — number — WhatsApp instance IDphone_number(required) — string — Phone number (e.g. 79001234567)
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_chat_historyread-onlyGet chat message history. Use a small 'count' (default 50, max 100) to keep responses focused.
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat ID ([email protected] or [email protected])count— number — Number of messages (default 50, max 100)
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_contact_avatarread-onlyGet the avatar of a contact or group
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Contact or group ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_contact_inforead-onlyGet information about a contact or group
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Contact or group ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_contactsread-onlyGet the contact list
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_group_dataread-onlyGet group data (members, name, invite link)
Parameters:
instance_id(required) — number — WhatsApp instance IDgroup_id(required) — string — Group ID (e.g. [email protected])
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_instancesread-onlyList all partner instances via the GREEN-API Partner API
Parameters:
partner_token(required) — string — Partner Token from your GREEN-API dashboard
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_messageread-onlyGet a message by ID
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat IDid_message(required) — string — Message ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_qrread-onlyGet the QR code for instance authorization. The result contains the QR as an image and a qrLink URL to an official GREEN-API page with a full-size auto-refreshing QR code. Always include the qrLink in your response as a clickable markdown link so the user can open it in the browser and scan comfortably.
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_settingsread-onlyGet instance settings
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_stateread-onlyGet instance state (authorized, notAuthorized, blocked, sleepMode)
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_get_wa_settingsread-onlyGet WhatsApp account settings (name, description, etc.)
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_last_incoming_messagesread-onlyGet recent incoming messages from the last N minutes (default 60, max 1440 = 24 hours).
Parameters:
instance_id(required) — number — WhatsApp instance IDminutes— number — Time window in minutes (default 60, max 1440)
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_last_outgoing_messagesread-onlyGet recent outgoing messages from the last N minutes (default 60, max 1440 = 24 hours).
Parameters:
instance_id(required) — number — WhatsApp instance IDminutes— number — Time window in minutes (default 60, max 1440)
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_leave_groupdestructiveLeave a WhatsApp group
Parameters:
instance_id(required) — number — WhatsApp instance IDgroup_id(required) — string — Group ID ([email protected])
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_logoutdestructiveLog out the WhatsApp instance
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_read_chatMark chat messages as read
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat IDid_message— string — ID of a specific message (optional)
Hints: read-only no · destructive no · idempotent no · open-world yes
whatsapp_rebootReboot the WhatsApp instance
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only no · destructive no · idempotent no · open-world yes
whatsapp_receive_notificationread-onlyGet one notification from the queue (manual polling)
Parameters:
instance_id(required) — number — WhatsApp instance ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
whatsapp_remove_group_admindestructiveRevoke admin rights from a group member
Parameters:
instance_id(required) — number — WhatsApp instance IDgroup_id(required) — string — Group ID ([email protected])participant_chat_id(required) — string — Participant chat ID ([email protected])
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_remove_group_participantdestructiveRemove a participant from a WhatsApp group
Parameters:
instance_id(required) — number — WhatsApp instance IDgroup_id(required) — string — Group IDparticipant_chat_id(required) — string — Participant chat ID ([email protected])
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_send_contactdestructiveSend a contact card via WhatsApp
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat IDphone_number(required) — number — Contact phone numbercompany— string — Contact companylast_name— string — Contact last namefirst_name— string — Contact first name
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_send_filedestructiveSend a file by URL
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat IDurl(required) — string — File URLcaption— string — File captionfile_name— string — File name
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_send_file_by_uploaddestructiveSend a file directly to a chat via multipart upload (no separate URL step)
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat ID ([email protected] or [email protected])file_base64(required) — string — File contents encoded as base64filename(required) — string — File name with extension (e.g. photo.jpg)caption— string — File caption (optional)
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_send_locationdestructiveSend a location
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat IDlatitude(required) — number — Latitudelongitude(required) — number — Longitudename— string — Place nameaddress— string — Address
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_send_messagedestructiveSend a text message via WhatsApp
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat ID ([email protected] or [email protected])message(required) — string — Message textlink_preview— boolean — Show link previewsquoted_message_id— string — ID of the message to quote (optional)
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_send_polldestructiveSend a poll via WhatsApp
Parameters:
instance_id(required) — number — WhatsApp instance IDchat_id(required) — string — Chat IDmessage(required) — string — Poll questionoptions(required) — array — Answer options (strings)multiple_answers— boolean — Allow multiple answers
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_set_group_adminPromote a group member to admin
Parameters:
instance_id(required) — number — WhatsApp instance IDgroup_id(required) — string — Group ID ([email protected])participant_chat_id(required) — string — Participant chat ID ([email protected])
Hints: read-only no · destructive no · idempotent no · open-world yes
whatsapp_set_settingsdestructiveUpdate instance settings (webhooks, proxy, etc.)
Parameters:
instance_id(required) — number — WhatsApp instance IDwebhook_url— string — URL for incoming webhooksdelay_message— number — Message send delay (ms)state_webhook— boolean — Enable state webhookdevice_webhook— boolean — Enable device webhookincoming_webhook— boolean — Enable incoming message webhookoutgoing_webhook— boolean — Enable outgoing message webhookwebhook_url_token— string — Token for the webhook URLstatus_instance_webhook— boolean — Enable instance status webhookmark_incoming_messages_readed— boolean — Mark incoming messages as read
Hints: read-only no · destructive yes · idempotent no · open-world yes
whatsapp_upload_fileUpload a file to GREEN-API storage and return its URL. Use the returned URL with whatsapp_send_file.
Parameters:
instance_id(required) — number — WhatsApp instance IDfile_base64(required) — string — File contents encoded as base64filename(required) — string — File name with extension (e.g. photo.jpg)
Hints: read-only no · destructive no · idempotent no · open-world yes
Measured by MCPYP probing. Untested fields are omitted, never estimated. Listing is always free; MCPYP never proxies calls or stores user tokens.