GetGroupData#
Метод получает данные группового чата.
Для метода используются ограничения на частоту запросов в секунду.
Запрос#
Для получения данных группового чата требуется выполнить запрос по адресу:
POST
{{apiUrl}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}
Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.
Параметры запроса#
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId | string | Да | Идентификатор группового чата |
Пример тела запроса#
{
"chatId": "-10000000000000"
}
Ответ#
Поля ответа#
| Поле | Тип | Описание |
|---|---|---|
chatId | string | Идентификатор группового чата |
owner | string | Идентификатор владельца группы |
subject | string | Наименование группы |
description | string | Описание группы (может быть пустой строкой) |
creation | integer | Время создания группы в Unix-формате |
groupInviteLink | string | Ссылка приглашения в группу. Если настройка "Приглашать по ссылке" в группе выключена, поле будет пустым |
isSupergroup | boolean | Флаг супергруппы, true / false |
isChannel | boolean | Флаг канала, true / false |
allowParticipantsSendMessages | boolean | Разрешение участникам отправлять текстовые сообщения, true / false |
allowParticipantsSendMedia | boolean | Разрешение участникам отправлять медиафайлы (фото, видео), true / false |
allowParticipantsSendPolls | boolean | Разрешение участникам отправлять опросы, true / false |
allowParticipantsSendOtherMessages | boolean | Разрешение участникам отправлять прочие сообщения (стикеры, GIF), true / false |
allowParticipantsAddWebPagePreviews | boolean | Разрешение участникам на предпросмотр ссылок в сообщениях (Rich Link Previews), true / false |
allowParticipantsEditGroupSettings | boolean | Разрешение участникам изменять настройки группы, true / false |
allowParticipantsAddMembers | boolean | Разрешение участникам добавлять других участников в группу, true / false |
allowParticipantsPinMessages | boolean | Разрешение участникам закреплять сообщения в группе, true / false |
size | integer | Количество участников в группе |
participants | array | Коллекция участников группы |
Поля объектов из массива participants
| Поле | Тип | Описание |
|---|---|---|
chatId | string | Идентификатор участника группового чата |
name | string | Имя участника группы |
isAdmin | boolean | Флаг администратора группы |
isSuperAdmin | boolean | Флаг супер администратора группы |
Пример тела ответа#
{
"chatId": "-10000000000000",
"owner": "10000001",
"subject": "GREEN-API Group",
"description": "Description of the group",
"creation": 1755774955,
"groupInviteLink": "https://t.me/+AbCdEfGhIjKlMnOp",
"isSupergroup": true,
"isChannel": false,
"allowParticipantsSendMessages": true,
"allowParticipantsSendMedia": true,
"allowParticipantsSendPolls": true,
"allowParticipantsSendOtherMessages": true,
"allowParticipantsAddWebPagePreviews": true,
"allowParticipantsEditGroupSettings": false,
"allowParticipantsAddMembers": true,
"allowParticipantsPinMessages": false,
"size": 2,
"participants": [
{
"chatId": "10000000",
"name": "Василиса",
"isAdmin": false,
"isSuperAdmin": false
},
{
"chatId": "10000001",
"name": "Иван",
"isAdmin": true,
"isSuperAdmin": true
}
]
}
Ошибки#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
| Код 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