القائمة
Skill for AI agents to write correct code using GREEN-API SDK for WhatsApp integration
يُحدَّد Prompt الذي يراجع المصدر أولًا بشكل افتراضي. يمكنك التبديل إلى أمر مباشر أو تنزيل نسخة محلية.
اقرأ SKILL.md وأي ملفات مرافقة يعرضها SkillsMP قبل أن تقرر التثبيت.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
يتجاوز الأمر المباشر Prompt المخصّص للمراجعة. افحص المصدر قبل تشغيله.
npx skills add https://github.com/green-api/whatsapp-api-client-js-v2 --skill green-api-whatsapp-sdk-v2-javascript-typescriptيبقى الأمر في سطر واحد. مرّر أفقيًا لمراجعته كاملًا قبل النسخ.
تفضّل نسخة محلية؟ نزّل الملفات المتاحة حاليًا لدى SkillsMP.
استنادا إلى تصنيف SOC المهني
عرض SKILL.md
| name | GREEN-API WhatsApp SDK v2 - JavaScript/TypeScript |
| version | 2.0.0 |
| description | Skill for AI agents to write correct code using GREEN-API SDK for WhatsApp integration |
| created_at | 2026-07-20 |
| updated_at | 2026-07-20 |
This skill teaches AI agents (Claude Code, Cursor, etc.) how to use the GREEN-API WhatsApp SDK v2 to send/receive WhatsApp messages, manage groups, handle files, and integrate with the GREEN-API platform.
Data sources:
⚠️ This skill is NOT for:
WhatsApp uses special ID formats:
// Individual contact (phone number)
chatId: "1234567890@c.us" // Format: {phone}@c.us
// Group
groupId: "120363xxxxxxxxxxxx-123456789@g.us" // Format: {groupId}@g.us
// When creating a group, GREEN-API returns the groupId; use it for subsequent calls
Common mistake: Forgetting @c.us or @g.us suffix → API returns 400 error.
Before any operation, the WhatsApp account MUST be authorized:
const state = await client.getStateInstance();
// state.stateInstance === "authorized" ✓
// state.stateInstance === "notAuthorized" ✗ → Must scan QR first
// ✓ CORRECT: Respects delays
for (const chatId of chatIds) {
await client.sendMessage({ chatId, message: "Hello" });
await new Promise(r => setTimeout(r, 700)); // 700ms delay
}
// ✗ WRONG: No delays → Rate limit, messages rejected
for (const chatId of chatIds) {
await client.sendMessage({ chatId, message: "Hello" });
}
try {
const result = await client.sendMessage({
chatId: "1234567890@c.us",
message: "Test"
});
console.log("Message sent:", result.idMessage);
} catch (error) {
// Common errors:
// 400: Invalid chatId format, unauthorized instance, message too long
// 401: Invalid apiTokenInstance or idInstance
// 429: Rate limit exceeded
console.error("Failed:", error.message);
}
npm install @green-api/whatsapp-api-client-js-v2
# or
yarn add @green-api/whatsapp-api-client-js-v2
import { GreenApiClient } from '@green-api/whatsapp-api-client-js-v2';
const client = new GreenApiClient({
idInstance: 1234567890, // Your instance ID
apiTokenInstance: 'your-token' // Your API token
});
Get credentials from: https://console.green-api.com/
If using the Partner API:
import { GreenApiPartnerClient } from '@green-api/whatsapp-api-client-js-v2';
const partnerClient = new GreenApiPartnerClient({
partnerToken: 'your-partner-token',
partnerApiUrl: 'https://api.green-api.com' // Optional, defaults to this
});
const response = await client.sendMessage({
chatId: "1234567890@c.us",
message: "Hello, this is a test message from GREEN-API!"
});
console.log(`Message sent with ID: ${response.idMessage}`);
Response:
{
idMessage: "BAE5D4E8766D60DD63B8FB6CCDA5D9D7"
}
const response = await client.sendFileByUrl({
chatId: "1234567890@c.us",
file: {
url: "https://example.com/document.pdf",
fileName: "report.pdf"
},
caption: "Check the attached report"
});
console.log(`File sent with ID: ${response.idMessage}`);
async function pollMessages() {
while (true) {
try {
const notification = await client.receiveNotification(5); // 5 sec timeout
if (notification) {
console.log("Received notification:", notification.body);
// Delete from queue after processing
await client.deleteNotification(notification.receiptId);
}
} catch (error) {
console.error("Polling error:", error.message);
}
await new Promise(r => setTimeout(r, 1000)); // 1 sec between polls
}
}
pollMessages();
// Create group
const group = await client.createGroup({
groupName: "My Team",
chatIds: ["1234567890@c.us", "9876543210@c.us"]
});
console.log(`Group created: ${group.chatId}`);
// Add participant
await client.addGroupParticipant({
groupId: group.chatId,
participantChatId: "5555555555@c.us"
});
// Change group name
await client.updateGroupName({
groupId: group.chatId,
groupName: "Updated Team Name"
});
// Set someone as admin
await client.setGroupAdmin({
groupId: group.chatId,
participantChatId: "1234567890@c.us"
});
// Get group info
const groupData = await client.getGroupData({
groupId: group.chatId
});
console.log("Group members:", groupData.participants);
// Example: Express.js webhook handler
import express from 'express';
const app = express();
app.use(express.json());
app.post('/webhook', (req, res) => {
const notification = req.body; // Entire webhook body
// notification.eventType can be:
// - "IncomingMessageReceived"
// - "OutgoingMessageReceived"
// - "IncomingCall"
// - "StateInstanceChanged"
// - etc.
if (notification.eventType === "IncomingMessageReceived") {
const message = notification.messageData;
console.log(`From: ${message.senderData.chatId}`);
console.log(`Text: ${message.textMessageData?.textMessage}`);
}
res.json({ result: true });
});
app.listen(3000, () => console.log('Webhook server running on port 3000'));
For detailed parameter descriptions, API response formats, and constraints, see:
sendMessage() - text messagessendFileByUrl() - files by URLsendFileByUpload() - files by uploadsendPoll() - poll questionssendLocation() - location markerssendContact() - contact cardssendInteractiveButtons() - interactive buttonsforwardMessages() - forward from other chatsuploadFile() - upload file to storagesendTyping() - typing indicatoreditMessage() - edit sent messagedeleteMessage() - delete messagereadChat() - mark chat as readarchiveChat() / unarchiveChat() - archive/unarchive chatssetDisappearingChat() - enable disappearing messagesgetChats() - list recent chatsgetChatHistory() - message historyreceiveNotification() - polling-based notification retrievaldeleteNotification() - remove from queuelastIncomingMessages() - incoming messages by timelastOutgoingMessages() - sent messages by timelastIncomingCalls() - incoming callslastOutgoingCalls() - outgoing callscreateGroup() - create new groupupdateGroupName() - rename groupgetGroupData() - fetch group infoaddGroupParticipant() - add memberremoveGroupParticipant() - remove membersetGroupAdmin() - promote to adminremoveAdmin() - demote from adminsetGroupPicture() - change group iconleaveGroup() - leave groupupdateGroupSettings() - configure group optionsgetStateInstance() - check authorization statusgetSettings() / setSettings() - instance settingsgetQR() - QR code for authorizationreboot() - restart instancelogout() - disconnect accountgetAuthorizationCode() - get auth code for new phoneupdateApiToken() - generate new API tokengetStateInstanceHistory() - authorization historygetContacts() - list saved contactsgetContactInfo() - individual contact detailscheckWhatsapp() - check if phone is on WhatsAppaddContact() - save new contacteditContact() - update contactdeleteContact() - remove contactsendTextStatus() - text-based statussendMediaStatus() - image/video statussendVoiceStatus() - audio statusgetStatusStatistic() - view count, reactionsgetIncomingStatuses() - received statusesgetOutgoingStatuses() - sent statusesdeleteStatus() - remove statusdownloadFile() - get download URL for received filesuploadFile() - upload file to storage (returns URL for sendFileByUrl())getMessage() - fetch single message detailsgetChatHistory() - retrieve messages from a chatlastIncomingMessages() - recent incoming messageslastOutgoingMessages() - recent sent messageslastIncomingCalls() - recent incoming callslastOutgoingCalls() - recent outgoing callsshowMessagesQueue() - pending message queueclearMessagesQueue() - clear queuegetWebhooksCount() - webhook queue sizeclearWebhooksQueue() - clear webhook queuegetAvatar() - fetch profile picturesetProfilePicture() - change profile picturegetContacts() - contact list with avatars| Problem | Cause | Solution |
|---|---|---|
400 Bad Request | Invalid chatId format | Use "1234567890@c.us" for contacts, "...-...@g.us" for groups |
401 Unauthorized | Wrong token/instance ID | Verify credentials in console.green-api.com |
429 Too Many Requests | Sending too fast | Add 700ms delay between messages |
| Message not received | Instance not authorized | Run getStateInstance(), must show "authorized" |
| Webhook not firing | Wrong endpoint configured | Set webhook URL in console, must be HTTPS and reachable |
idMessage is null | SDK version mismatch | Update SDK: npm install @green-api/whatsapp-api-client-js-v2@latest |
| Group operations fail | Invalid groupId format | Use full ID from createGroup() response or getGroupData() |
All types are exported from the SDK:
import {
GreenApiClient,
SendMessage,
SendResponse,
ReceiveNotificationResponse,
CreateGroup,
CreateGroupResponse,
// ... all other types
} from '@green-api/whatsapp-api-client-js-v2';
Use these types to ensure compile-time type safety.
DO NOT hardcode credentials in code.
Use environment variables:
const client = new GreenApiClient({
idInstance: parseInt(process.env.ID_INSTANCE!),
apiTokenInstance: process.env.API_TOKEN_INSTANCE!
});
Create .env file:
ID_INSTANCE=1234567890
API_TOKEN_INSTANCE=your-secret-token
import { GreenApiClient } from '@green-api/whatsapp-api-client-js-v2';
import OpenAI from 'openai';
const client = new GreenApiClient({
idInstance: parseInt(process.env.ID_INSTANCE!),
apiTokenInstance: process.env.API_TOKEN_INSTANCE!
});
const openai = new OpenAI();
async function processIncomingMessage(message: string, fromChatId: string) {
// Get AI response
const aiResponse = await openai.chat.completions.create({
model: 'gpt-4',
messages: [{ role: 'user', content: message }]
});
// Send reply
await client.sendMessage({
chatId: fromChatId,
message: aiResponse.choices[0].message.content!
});
}
// Polling loop
async () {
() {
notification = client.();
(notification?.. === ) {
msg = notification..;
(
msg.?. || ,
msg..
);
client.(notification.);
}
( (r, ));
}
}
().(.);
See separate documents for parameter details and constraints:
Skill Version: 2.0.0
Last Updated: 2026-07-20
Source: Official GREEN-API Documentation + SDK v2 Source Code Verification