GetGroupData#

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

Запрос#

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

POST

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

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

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

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

Примечание

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

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

{
    "groupId": "120363043968066561@g.us"
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`groupId`	string	Идентификатор группового чата
`owner`	string	Идентификатор владельца группы
`subject`	string	Наименование группы
`creation`	number	Время создания группы в Unix-формате
`participants`	array	Коллекция участников группы
`subjectTime`	number	Время создания наименования группы в Unix-формате
`subjectOwner`	string	Идентификатор пользователя создавшего наименование группы
`groupInviteLink`	string	Ссылка приглашения в группу

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

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

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

{
    "groupId": "120363043968066561@g.us",
    "owner": "79876543210@c.us",
    "subject": "GREEN-API Group",
    "creation": 1587570015,
    "participants": [
        {
            "id": "79876543210@c.us",
            "isAdmin": true,
            "isSuperAdmin": true
        },
        {
            "id": "79001234567@c.us",
            "isAdmin": true,
            "isSuperAdmin": false
        },
        {
            "id": "79001234567@c.us",
            "isAdmin": false,
            "isSuperAdmin": false
        }
    ],
    "subjectTime": 1587737715,
    "subjectOwner": "79876543210@c.us",
    "groupInviteLink": "https://chat.whatsapp.com/xxxxxxxxxxxxxxxxxxxxxx"
}

Ошибки 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: 'group_id@g.us`	Неверный формат поля `groupId`, поле указывается в формате `group_id@g.us`

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

PythoncURLJava - SpringJava - UnirestVBA

import requests

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

payload = {(
    "groupId": "11011234567@g.us")
}
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 '{
    "groupId": "11111111111111111@g.us"
}'

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 = "{\"groupId\": \"11111111111111111@g.us\"}";

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("{\"groupId\": \"11111111111111111@g.us\"}")
    .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}}"

    ' groupId - group chat identifier
    RequestBody = "{""groupId"":""120123400367448864@g.us""}"

    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