GetGroupData#

Метод получает данные группового чата.

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

Для получения данных группового чата требуется выполнить запрос по адресу:

POST

{{apiUrl}}/v3/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр	Тип	Обязательный	Описание
`groupId`	string	Да	Идентификатор группового чата

Примечание

Если пользователь не является администратором или владельцем группы, метод вернёт код 200 и пустое поле groupInviteLink. Для получения ссылки необходимо запрашивать метод с номера, являющегося владельцем группы, либо назначить текущий номер администратором.

Пример тела запроса#

{
    "groupId": "-10000000000000"
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`groupId`	string	Идентификатор группового чата
`owner`	string	Идентификатор владельца группы
`subject`	string	Наименование группы
`description`	string	Описание группы может быть пустой строкой
`creation`	number	Время создания группы в Unix-формате
`groupInviteLink`	string	Ссылка приглашения в группу
`allowParticipantsEditGroupSettings`	boolean	Разрешение изменять настройки группы, `true`/`false`
`allowParticipantsAddMembers`	boolean	Разрешение добавлять других участников в группу, `true`/`false`
`size`	number	Количество участников в группе
`participants`	array	Коллекция участников группы

Поля объектов из массива participants

Поле	Тип	Описание
`chatId`	string	Идентификатор участника группового чата
`isAdmin`	boolean	Флаг, является ли пользователь администратором группы
`isSuperAdmin`	boolean	Флаг, является ли пользователь супер администратором группы

Пример тела ответа#

Успешное выполнение метода#

{
    "groupId": "-10000000000000",
    "owner": "10000001",
    "subject": "GREEN-API Group",
    "description": "",
    "creation": 1755774955,
    "groupInviteLink": "",
    "allowParticipantsEditGroupSettings": true,
    "allowParticipantsAddMembers": true,
    "size": 2,
    "participants": [
        {
            "chatId": "10000000",
            "isAdmin": false,
            "isSuperAdmin": false
        },
        {
            "chatId": "10000001",
            "isAdmin": true,
            "isSuperAdmin": true
        }
    ]
}

Выполнение метода с ошибкой#

status code 400

"groupId not found"

Ошибки GetGroupData#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP	Идентификатор ошибки	Описание
200	`Error: forbidden`	Вы не состоите в группе
200	`Error: item-not-found`	Группы не существует
400	`Bad Request` `Validation failed`	Ошибка валидации
400	`Bad Request` `Validation failed.` `Details: 'groupId' must be the next formats:`	Неверный формат поля `groupId`, поле указывается в формате `-10000000000000`

Примеры кода#

PythoncURLJava - SpringJava - UnirestVBA

import requests

url = "{{apiUrl}}/v3/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}"

payload = {(
    "groupId": "-10000000000000")
}
headers = {
  'Content-Type': 'application/json'
}

response = requests.post(url, json=payload)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupId": "-10000000000000"
}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/v3/waInstance").append({{idInstance}})
    .append("/getGroupData/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\"groupId\": \"-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("/v3/waInstance").append({{idInstance}})
    .append("/getGroupData/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\"groupId\": \"-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}}/v3/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}"

    ' groupId - group chat identifier
    RequestBody = "{""groupId"":""-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