Перейти к содержанию

GetGroupData#

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

Запрос#

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

POST https://api.green-api.com/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}

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

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

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

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

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

Ответ#

Поля ответа#

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

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

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

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

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

Ошибки GetGroupData#

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

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

import requests

url = "https://api.green-api.com/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}"

payload = "{\r\n\t\"groupId\": \"120363043968066561@g.us\"\r\n}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
curl --location 'https://api.green-api.com/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("https://api.greenapi.com")
    .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("https://api.greenapi.com")
    .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 idInstance and apiTokenInstance values are available in your account, double brackets must be removed
    url = "https://api.green-api.com/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