Меняет название группы. Номер канала должен быть админом группы или иметь право менять её название.
| Запрос | POST /waInstance{idInstance}/updateGroupName/{apiTokenInstance} |
| Тело | JSON |
| Каналы | MAX, Telegram, WhatsApp |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | id группы. Принимается и groupId |
groupName |
string | да | новое название. MAX — до 100 символов, Telegram — до 128, длиннее обрезается; WhatsApp — от 1 до 25 |
Пример запроса
Добавить в название день занятий:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/updateGroupName/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "-80040066617372",
"groupName": "3А · Робототехника, суббота"
}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/updateGroupName/{TOKEN}"
payload = {
"chatId": "-80040066617372",
"groupName": "3А · Робототехника, суббота",
}
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}/updateGroupName/${GRATIO_TOKEN}`;
const payload = { chatId: "-80040066617372", groupName: "3А · Робототехника, суббота" };
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 . '/updateGroupName/' . getenv('GRATIO_TOKEN');
$payload = [
'chatId' => '-80040066617372',
'groupName' => '3А · Робототехника, суббота',
];
$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:
{"updateGroupName": true}
Если площадка отказала
Как у Green API, отказ площадки — тоже 200 OK, но с флагом false и причиной в reason. Проверяйте флаг, а не только код ответа. Номер канала — не админ группы в MAX:
{"updateGroupName": false, "reason": "admin_required: Нужны права администратора (user.not.admin)"}
reason — код причины, двоеточие и текст для человека:
Код в reason |
Когда |
|---|---|
admin_required |
MAX, Telegram: у номера канала нет прав |
not_admin |
WhatsApp: номер канала — не админ |
not_a_group, bad_group |
chatId — не группа |
not_in_group, group_not_found |
WhatsApp: номер не в группе или группы нет |
bad_name |
WhatsApp: название не от 1 до 25 знаков |
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId или groupName |
добавить поле |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
402 |
payment_required |
канал на паузе за неоплату | продлить канал в кабинете |
501 |
not_supported |
канал «Почта» | — |
Общие правила — в статье Ответы и ошибки.
Особенности каналов
- Темп. В MAX и Telegram изменения групп идут по одному с паузой 2 секунды: запрос ждёт очереди, а не получает отказ.
- События. В MAX и Telegram придёт уведомление groupEvent с
groupRenamed, новое название — вtitle.
Что дальше
- updateGroupSettings — права участников.
- setGroupPicture — фото группы.
- groupEvent — уведомление о переименовании.
