GetGroupData#
Метод получает данные группового чата.
Для метода используются ограничения на частоту запросов в секунду.
Запрос#
Для получения данных группового чата требуется выполнить запрос по адресу:
{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}
Префикс v3 стал необязательным параметром запроса
Для вашего удобства унифицировали формат запросов методов API для всех мессенджеров.
Подробнее о правилах вызова методов читайте в статье Выполнение запросов.
Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.
Параметры запроса#
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId | string | Да | Идентификатор группового чата |
Примечание
Если пользователь не является администратором или владельцем группы, метод вернёт код 200 и пустое поле groupInviteLink. Для получения ссылки необходимо запрашивать метод с номера, являющегося владельцем группы, либо назначить текущий номер администратором.
Пример тела запроса#
{
"chatId": "-10000000000000"
}
Ответ#
Поля ответа#
| Поле | Тип | Описание |
|---|---|---|
chatId | string | Идентификатор группового чата |
type | string | Принимает значения group или channel соответственно для группы или канала |
owner | string | Идентификатор владельца группы. Возвращает 0, если владелец скрыт |
subject | string | Наименование группы |
description | string | Описание группы может быть пустой строкой |
creation | number | Время создания группы в Unix-формате. Возвращает 0, если дата создания неизвестна |
groupInviteLink | string | Ссылка приглашения в группу Если настройка "Приглашать по ссылке" в группе выключена, то поле будет пустым |
allowParticipantsAddMembers | boolean | Разрешение добавлять других участников в группу, true/false |
allowParticipantsEditGroupSettings | boolean | Разрешение изменять настройки группы, true/false |
allowParticipantsPinMessages | boolean | Разрешение закреплять сообщения в группе, true / false |
allowParticipantsCopyMessages | boolean | Разрешение участникам копировать сообщения, true / false |
allowParticipantsChangeAvatar | boolean | Разрешение участникам изменять название чата и аватар, true / false |
allowParticipantsCall | boolean | Разрешение участникам совершать звонки, true / false |
isOfficial | boolean | Является ли чат верифицированным, true / false |
isCommentsEnabled | boolean | Разрешение на использование комментариев, true / false |
urlAvatar | string | Ссылка на аватар чата |
size | number | Количество участников в группе |
participants | array | Коллекция участников группы |
Поля объектов из массива participants
| Поле | Тип | Описание |
|---|---|---|
chatId | string | Идентификатор участника группового чата |
isAdmin | boolean | Флаг, является ли пользователь администратором группы |
isSuperAdmin | boolean | Флаг, является ли пользователь супер администратором группы |
Пример тела ответа#
Успешное выполнение метода#
{
"chatId": "-10000000000000",
"type": "group",
"owner": "10000001",
"subject": "GREEN-API Group",
"description": "Всё об API мессенджера MAX",
"creation": 1755774955,
"groupInviteLink": "https://max.ru/join/123...xyz",
"allowParticipantsAddMembers": true,
"allowParticipantsEditGroupSettings": true,
"allowParticipantsPinMessages": true,
"allowParticipantsCopyMessages": true,
"allowParticipantsChangeAvatar": true,
"allowParticipantsCall": true,
"isOfficial": false,
"isCommentsEnabled": false,
"urlAvatar": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotfasfasxP6VpAOkOxP-0N5TW9EkzFcgsdE70ZdjoR0gRY",
"size": 3,
"participants": [
{
"chatId": "10000000",
"isAdmin": false,
"isSuperAdmin": false
},
{
"chatId": "10000001",
"isAdmin": true,
"isSuperAdmin": true
},
{
"chatId": "10000002",
"isAdmin": true,
"isSuperAdmin": true
}
]
}
Выполнение метода с ошибкой#
status code 400
"chatId not found"
Ошибки GetGroupData#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
| Код HTTP | Идентификатор ошибки | Описание |
|---|---|---|
| 200 | Error: forbidden | Вы не состоите в группе |
| 200 | Error: item-not-found | Группы не существует |
| 400 | Bad Request Validation failed | Ошибка валидации |
| 400 | Bad Request Validation failed. Details: 'chatId' must be the next formats: | Неверный формат поля chatId, поле указывается в формате -10000000000000 |
Примеры кода#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}"
payload = {(
"chatId": "-10000000000000")
}
headers = {
'Content-Type': 'application/json'
}
response = requests.post(url, json=payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"chatId": "-10000000000000"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getGroupData/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"chatId\": \"-10000000000000\"}";
var requestEntity = new HttpEntity<>(jsonBody, headers);
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getGroupData/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"chatId\": \"-10000000000000\"}")
.asString();
System.out.println(response);
Sub GetGroupData()
Dim url As String
Dim RequestBody As String
Dim http As Object
Dim response As String
' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
url = "{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}"
RequestBody = "{""chatId"":""-10000000000000""}"
Set http = CreateObject("MSXML2.XMLHTTP")
With http
.Open "POST", url, False
.setRequestHeader "Content-Type", "application/json"
.Send RequestBody
End With
response = http.responseText
Debug.Print response
' Outputting the answer to the desired cell
Range("A1").Value = response
Set http = Nothing
End Sub