getGroupData

Отдаёт данные группы: название, описание, владельца, участников с ролями, ссылку-приглашение, фото и права участников. Нужен, чтобы показать состав группы и проверить, админ ли номер канала.

Параметры

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

Группа «3А · Робототехника» в MAX:

curl

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

{
  "chatId": "-80040066617372",
  "type": "group",
  "owner": "457747484",
  "subject": "3А · Робототехника",
  "description": "",
  "creation": 1791825710,
  "groupInviteLink": "https://max.ru/join/JvIa7E1T…",
  "urlAvatar": "https://i.oneme.ru/i?r=…",
  "size": 3,
  "participants": [
    {"chatId": "8695836", "isAdmin": false, "isSuperAdmin": false},
    {"chatId": "1111111", "isAdmin": false, "isSuperAdmin": false},
    {"chatId": "457747484", "isAdmin": true, "isSuperAdmin": true}
  ],
  "allowParticipantsAddMembers": false,
  "allowParticipantsEditGroupSettings": false,
  "allowParticipantsChangeAvatar": false,
  "allowParticipantsCall": false,
  "allowParticipantsPinMessages": true
}

Поля ответа

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

getGroupData на отказ отвечает ошибкой, а не 200 с флагом false. Группы нет или номер канала в ней больше не состоит:

{"message": "Группа не найдена", "code": "not_found"}

Код ответа — 400. Номер исключили из группы — приложение узнаёт об этом сразу из уведомления groupEvent, не дожидаясь этой ошибки.

Ошибки

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

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

Что дальше

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