Меняет права обычных участников группы: что им можно делать без админа. Передавайте только флаги, которые меняете, — остальные права останутся как есть.
| Запрос | POST /waInstance{idInstance}/updateGroupSettings/{apiTokenInstance} |
| Тело | JSON |
| Каналы | MAX, Telegram, WhatsApp |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | id группы. Принимается и groupId |
allowParticipantsAddMembers |
boolean | нет | добавлять участников |
allowParticipantsChangeAvatar |
boolean | нет | менять название и фото группы |
allowParticipantsEditGroupSettings |
boolean | нет | менять настройки группы |
allowParticipantsPinMessages |
boolean | нет | закреплять сообщения |
allowParticipantsCall |
boolean | нет | звонить в группу |
Нужен хотя бы один флаг. Значения — JSON true и false, не строки: строка "false" считается включённым правом.
Пример запроса
Закрыть участникам добавление людей, название и фото:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/updateGroupSettings/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "-80040066617372",
"allowParticipantsAddMembers": false,
"allowParticipantsChangeAvatar": false
}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/updateGroupSettings/{TOKEN}"
payload = {
"chatId": "-80040066617372",
"allowParticipantsAddMembers": False,
"allowParticipantsChangeAvatar": False,
}
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}/updateGroupSettings/${GRATIO_TOKEN}`;
const payload = {
chatId: "-80040066617372",
allowParticipantsAddMembers: false,
allowParticipantsChangeAvatar: false,
};
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 . '/updateGroupSettings/' . getenv('GRATIO_TOKEN');
$payload = [
'chatId' => '-80040066617372',
'allowParticipantsAddMembers' => false,
'allowParticipantsChangeAvatar' => false,
];
$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:
{"updateGroupSettings": true}
Флаги по каналам
| Флаг | MAX | Telegram | |
|---|---|---|---|
allowParticipantsAddMembers |
да | да | да |
allowParticipantsChangeAvatar |
да | да | да — «менять сведения о группе» |
allowParticipantsEditGroupSettings |
да — тот же флаг MAX, что название и фото | да — то же право Telegram, что название и фото | нет, 501 |
allowParticipantsPinMessages |
да | да | нет, 501 |
allowParticipantsCall |
да | нет — флаг без действия | нет, 501 |
- Название, фото и настройки в MAX и Telegram — одно право. Если запрещено хоть одно из
allowParticipantsChangeAvatarиallowParticipantsEditGroupSettings, закрыты оба. - Telegram. Права участников — запреты группы по умолчанию. Запрос только с
allowParticipantsCall— отказunsupported_setting; вместе с другими флагами он ничего не меняет. - WhatsApp. Можно задать только два права. Запрос с любым другим флагом целиком отвечает
501 not_supported— ничего не меняется.
Текущие права — в ответе getGroupData: там только флаги, которые есть у площадки.
Если площадка отказала
Как у Green API, отказ площадки — тоже 200 OK, но с флагом false и причиной в reason. Проверяйте флаг, а не только код ответа. Ни одного флага в запросе:
{"updateGroupSettings": false, "reason": "NO_SETTINGS_TO_UPDATE"}
Только allowParticipantsCall в Telegram:
{"updateGroupSettings": false, "reason": "unsupported_setting: У Telegram нет таких прав участников"}
Код в reason |
Когда |
|---|---|
NO_SETTINGS_TO_UPDATE |
в запросе нет ни одного флага |
unsupported_setting |
Telegram: только флаги, которых у Telegram нет |
admin_required |
MAX, Telegram: у номера канала нет прав |
not_admin |
WhatsApp: номер канала — не админ |
not_a_group, bad_group |
chatId — не группа |
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId |
добавить поле |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
501 |
not_supported |
WhatsApp: флаг, которого у WhatsApp нет; канал «Почта» | убрать флаг |
Общие правила — в статье Ответы и ошибки.
Что дальше
- getGroupData — текущие права участников.
- setGroupAdmin — дать участнику права админа.
- Группа для клиентов — группа целиком на готовом примере.
