/install green-api
\r \r
GREEN-API WhatsApp Skill\r
\r Use this skill when the user wants to send or receive WhatsApp messages, manage contacts, groups, or WhatsApp instances via GREEN-API.\r \r
Connection\r
\r
Before using any tools, connect an instance with whatsapp_connect by providing instance_id and api_token (from console.green-api.com). This validates credentials and stores them for the session.\r
\r
Call whatsapp_disconnect when done.\r
\r
Chat ID format\r
\r
- Personal chats:
[email protected](phone number in international format +@c.us)\r - Group chats:
[email protected]or[email protected]\r \r
Tools\r
\r
Session\r
\r
| Tool | Description |\r
|---|---|\r
| whatsapp_connect | Connect instance (required first). Params: instance_id, api_token, optional api_url |\r
| whatsapp_disconnect | Disconnect instance and clear credentials |\r
\r
Messaging\r
\r
| Tool | Description |\r
|---|---|\r
| whatsapp_send_message | Send text message. Params: instance_id, chat_id, message, optional quoted_message_id, link_preview |\r
| whatsapp_send_file | Send file by URL. Params: instance_id, chat_id, url, optional file_name, caption |\r
| whatsapp_upload_file | Upload file to GREEN-API storage, returns URL. Params: instance_id, file_base64, filename. Use returned URL with whatsapp_send_file |\r
| whatsapp_send_file_by_upload | Send file directly via base64 (no separate upload step). Params: instance_id, chat_id, file_base64, filename, optional caption |\r
| whatsapp_send_location | Send location. Params: instance_id, chat_id, latitude, longitude, optional name, address |\r
| whatsapp_send_contact | Send contact card. Params: instance_id, chat_id, phone_number, optional first_name, last_name, company |\r
| whatsapp_send_poll | Send poll. Params: instance_id, chat_id, message (question), options (string array, 2–12), optional multiple_answers |\r
| whatsapp_forward_messages | Forward messages between chats. Params: instance_id, chat_id (destination), chat_id_from (source), messages (ID array) |\r
| whatsapp_edit_message | Edit a sent message. Params: instance_id, chat_id, id_message, message (new text) |\r
| whatsapp_delete_message | Delete a message. Params: instance_id, chat_id, id_message |\r
\r
Instance management\r
\r
| Tool | Description |\r
|---|---|\r
| whatsapp_get_state | Get instance state: authorized, notAuthorized, blocked, sleepMode, starting, yellowCard |\r
| whatsapp_get_settings | Get instance settings (webhooks, delays, flags) |\r
| whatsapp_set_settings | Update instance settings. Params: optional webhook_url, webhook_url_token, outgoing_webhook, incoming_webhook, state_webhook, mark_incoming_messages_readed, delay_message, etc. |\r
| whatsapp_get_qr | Get QR code for authorization (instance must be unauthorized) |\r
| whatsapp_get_authorization_code | Get auth code by phone number (alternative to QR). Params: instance_id, phone_number |\r
| whatsapp_get_wa_settings | Get WhatsApp account info (avatar, phone, state, device ID) |\r
| whatsapp_reboot | Reboot instance |\r
| whatsapp_logout | Log out instance (required before re-authorizing) |\r
\r
Contacts & history\r
\r
| Tool | Description |\r
|---|---|\r
| whatsapp_check_whatsapp | Check if a phone number has WhatsApp. Params: instance_id, phone_number |\r
| whatsapp_get_contacts | Get all contacts |\r
| whatsapp_get_contact_info | Get info about a contact or group. Params: instance_id, chat_id |\r
| whatsapp_get_contact_avatar | Get avatar of contact or group. Params: instance_id, chat_id |\r
| whatsapp_get_chat_history | Get chat message history. Params: instance_id, chat_id, optional count (default 100) |\r
| whatsapp_get_message | Get a specific message. Params: instance_id, chat_id, id_message |\r
| whatsapp_last_incoming_messages | Get recent incoming messages. Params: instance_id, optional minutes (default 1440) |\r
| whatsapp_last_outgoing_messages | Get recent outgoing messages. Params: instance_id, optional minutes (default 1440) |\r
| whatsapp_read_chat | Mark messages as read. Params: instance_id, chat_id, optional id_message |\r
\r
Notifications (manual polling)\r
\r
| Tool | Description |\r
|---|---|\r
| whatsapp_receive_notification | Get one notification from the queue |\r
| whatsapp_delete_notification | Acknowledge/delete a notification. Params: instance_id, receipt_id |\r
\r
Groups\r
\r
| Tool | Description |\r
|---|---|\r
| whatsapp_create_group | Create a group. Params: instance_id, group_name, chat_ids (participant array) |\r
| whatsapp_get_group_data | Get group info (members, name, link). Params: instance_id, group_id |\r
| whatsapp_add_group_participant | Add member. Params: instance_id, group_id, participant_chat_id |\r
| whatsapp_remove_group_participant | Remove member. Params: instance_id, group_id, participant_chat_id |\r
| whatsapp_set_group_admin | Promote member to admin. Params: instance_id, group_id, participant_chat_id |\r
| whatsapp_remove_group_admin | Demote admin. Params: instance_id, group_id, participant_chat_id |\r
| whatsapp_leave_group | Leave a group. Params: instance_id, group_id |\r
\r
Partner API (instance provisioning)\r
\r
These require a partner_token from the GREEN-API partner dashboard.\r
\r
| Tool | Description |\r
|---|---|\r
| whatsapp_create_instance | Create a new instance |\r
| whatsapp_delete_instance | Delete an instance. Params: partner_token, instance_id |\r
| whatsapp_get_instances | List all partner instances |\r
\r
Resources\r
\r
whatsapp://instance/{id}/state— read current instance authorization state\rwhatsapp://instance/{id}/settings— read instance settings\r \r
Prompts\r
\r
whatsapp_customer_support— system prompt template for a customer support agent. Args:instance_id,language\rwhatsapp_broadcast— template for planning and executing broadcast messaging. Args:instance_id,message_template\r \r
Important notes\r
\r
- Always
whatsapp_connectbefore calling any other tool.\r - Use
whatsapp_check_whatsappto verify a phone number has WhatsApp before sending.\r - For broadcasts, add delays between messages to avoid rate limiting.\r
- File uploads use base64 encoding. Max file size: 100 MB.\r
- Poll options must be unique, 2–12 items, max 100 chars each.\r
- Message quoting only works within the same chat.\r
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install green-api - After installation, invoke the skill by name or use
/green-api - Provide required inputs per the skill's parameter spec and get structured output
What is GREEN-API?
Send and receive WhatsApp messages, manage groups, contacts, and instances via GREEN-API MCP gateway. It is an AI Agent Skill for Claude Code / OpenClaw, with 122 downloads so far.
How do I install GREEN-API?
Run "/install green-api" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is GREEN-API free?
Yes, GREEN-API is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does GREEN-API support?
GREEN-API is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created GREEN-API?
It is built and maintained by Green API (@support-greenapi); the current version is v1.0.0.