Добавляет человека в группу. Номер канала должен быть админом группы или иметь право добавлять участников. Если человек запретил добавлять себя в группы, отправьте ему ссылку-приглашение.
| Запрос | POST /waInstance{idInstance}/addGroupParticipant/{apiTokenInstance} |
| Тело | JSON |
| Каналы | MAX, Telegram, WhatsApp |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | id группы. Принимается и groupId |
participantChatId |
string | да | chatId личного чата с человеком. Номер телефона здесь не ищется: в MAX и Telegram сначала узнайте chatId через checkAccount |
Пример запроса
Добавить Олега в группу MAX:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/addGroupParticipant/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "-80040066617372",
"participantChatId": "1111111"
}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/addGroupParticipant/{TOKEN}"
payload = {"chatId": "-80040066617372", "participantChatId": "1111111"}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())
Node.js
const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;
const url = `${base}/addGroupParticipant/${GRATIO_TOKEN}`;
const payload = { chatId: "-80040066617372", participantChatId: "1111111" };
const response = await fetch(url, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(payload),
});
console.log(response.status, await response.json());
PHP
<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/addGroupParticipant/' . getenv('GRATIO_TOKEN');
$payload = ['chatId' => '-80040066617372', 'participantChatId' => '1111111'];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);
Пример ответа
Ответ 200 OK:
{"addParticipant": true}
В Telegram, если человек уже в группе, — тоже true.
Если площадка отказала
Как у Green API, отказ площадки — тоже 200 OK, но с флагом false и причиной в reason. Проверяйте флаг, а не только код ответа. Настройки приватности Telegram не дают добавить человека:
{"addParticipant": false, "reason": "privacy_restricted: Настройки приватности не дают добавить участника"}
Номер канала WhatsApp этому человеку ещё не писал:
{"addParticipant": false, "reason": "member_not_engaged: В группу добавляем только тех, кому номер писал: +7 999 ***-**-67 — переписки нет."}
Код в reason |
Когда | Что делать |
|---|---|---|
privacy_restricted |
Telegram: человек запретил добавлять себя | отправить groupInviteLink |
admin_required |
MAX, Telegram: у номера канала нет прав | дать номеру права админа |
member_not_engaged |
WhatsApp: номер канала этому человеку не писал | сначала переписка, потом группа |
group_tempo |
WhatsApp: прошло меньше минуты с прошлого добавления | повторить через минуту |
member_refused |
WhatsApp не добавил человека, код WhatsApp — в тексте | отправить groupInviteLink |
not_admin |
WhatsApp: номер канала — не админ | дать номеру права админа |
not_a_group, bad_group, member_is_group |
chatId — не группа или участник — группа |
исправить запрос |
Ссылка-приглашение — groupInviteLink в ответе getGroupData. Отправьте её человеку обычным сообщением через sendMessage.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId или participantChatId |
добавить поле |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
402 |
payment_required |
канал на паузе за неоплату | продлить канал в кабинете |
501 |
not_supported |
канал «Почта» | — |
Общие правила — в статье Ответы и ошибки.
Особенности каналов
- Темп. В MAX и Telegram изменения групп идут по одному с паузой 2 секунды: запрос ждёт очереди. Добавлять людей массово не стоит — Telegram за это ограничивает аккаунт чаще всего.
- MAX. Новый участник видит историю группы.
- Telegram. В обычной группе новый участник видит 50 последних сообщений.
- WhatsApp. Только те, кому номер канала уже писал с момента привязки к Gratio, и не больше одного человека в минуту. Отказ по темпу приходит
200сreason: group_tempo, безRetry-After. Подробно — WhatsApp. - События. В MAX и Telegram придёт уведомление groupEvent с
participantAdded.
Что дальше
- removeGroupParticipant — убрать участника.
- createInviteLink — отдельная ссылка-приглашение со сроком или одобрением.
- groupEvent — уведомления об изменениях состава.
