removeGroupParticipant

Исключает участника из группы. Номер канала должен быть админом группы.

Параметры

Пример запроса

Исключить Олега из группы MAX:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/removeGroupParticipant/$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}/removeGroupParticipant/{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}/removeGroupParticipant/${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 . '/removeGroupParticipant/' . 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:

{"removeParticipant": true}

Если площадка отказала

Как у Green API, отказ площадки — тоже 200 OK, но с флагом false и причиной в reason. Проверяйте флаг, а не только код ответа. Номер канала — не админ группы в MAX:

{"removeParticipant": false, "reason": "admin_required: Нужны права администратора (user.not.admin)"}

Ошибки

Общие правила — в статье Ответы и ошибки.

Особенности каналов

• Темп. В MAX и Telegram изменения групп идут по одному с паузой 2 секунды: запрос ждёт очереди.
• MAX. Сообщения исключённого остаются в группе.
• Telegram. Из супергруппы участник исключается без бана: позже он сможет вернуться по ссылке-приглашению.
• События. В MAX и Telegram придёт уведомление groupEvent с participantRemoved. В MAX его сразу получает и исключённый: если исключили номер канала, приложение узнает об этом из уведомления.

Что дальше

• addGroupParticipant — добавить участника.
• leaveGroup — выйти из группы самому.
• groupEvent — уведомления об изменениях состава.