Номер канала выходит из группы. Для канала (сообщества) MAX и Telegram — отписывается от него.
| Запрос | POST /waInstance{idInstance}/leaveGroup/{apiTokenInstance} |
| Тело | JSON |
| Каналы | MAX, Telegram, WhatsApp |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | id группы или канала. Принимается и groupId |
Пример запроса
Выйти из группы MAX:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/leaveGroup/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"chatId": "-80040066617372"}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/leaveGroup/{TOKEN}"
payload = {"chatId": "-80040066617372"}
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}/leaveGroup/${GRATIO_TOKEN}`;
const payload = { chatId: "-80040066617372" };
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 . '/leaveGroup/' . getenv('GRATIO_TOKEN');
$payload = ['chatId' => '-80040066617372'];
$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:
{"leaveGroup": true}
Если площадка отказала
Как у Green API, отказ площадки — тоже 200 OK, но с флагом false и причиной в reason. Проверяйте флаг, а не только код ответа. chatId — личный чат, а не группа:
{"leaveGroup": false, "reason": "not_a_group: Это не групповой чат"}
Код в reason |
Когда |
|---|---|
not_a_group, bad_group |
chatId — не группа |
not_in_group, group_not_found |
WhatsApp: номер уже не в группе или группы нет |
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId |
добавить поле |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
501 |
not_supported |
канал «Почта» | — |
Общие правила — в статье Ответы и ошибки.
Особенности каналов
- MAX. Вышедшему MAX ничего не сообщает, поэтому событие о выходе Gratio формирует сам: придёт groupEvent с
participantLeftиself: true. Данные группы после выхода больше не берутся из кэша. - Telegram. Работает с обычными группами, супергруппами и каналами.
- WhatsApp. Группа остаётся в списке чатов номера. Убрать её из списка на всех устройствах номера — deleteGroup.
Что дальше
- deleteGroup — удалить группу WhatsApp из списка чатов.
- joinChat — вступить в группу или канал.
- groupEvent — уведомление о выходе.
