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#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Пример кода на Python#
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'))