Ir para o conteúdo

GetGroupData#

Este método recupera os dados de um chat em grupo.

Solicitação#

Para obter os dados de um chat em grupo, você precisa fazer uma solicitação para o endereço:

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

Para obter os parâmetros da solicitação idInstance e apiTokenInstance, consulte a seção Antes de começar.

Parâmetros da solicitação#

Parâmetro Tipo Obrigatório Descrição
groupId string Sim Identificador do chat em grupo

Exemplo do corpo da solicitação#

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

Resposta#

Campos da resposta#

Campo Tipo Descrição
groupId string Identificador do chat em grupo
owner string Identificador do proprietário do grupo
subject string Nome do grupo
creation integer Hora de criação do grupo no formato Unix
participants array Coleção de participantes do grupo
subjectTime integer Hora de criação do nome do grupo no formato Unix
subjectOwner string Identificador do usuário que criou o nome do grupo
groupInviteLink string Link do convite para o grupo

Campos dos objetos no array participants

Campo Tipo Descrição
id string Identificador do participante do chat em grupo
isAdmin boolean Indica se o usuário é um administrador do grupo
isSuperAdmin boolean Indica se o usuário é um superadministrador do grupo

Exemplo do corpo da resposta#

{
    "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"
}

Erros de GetGroupData#

Veja a lista de erros comuns para todos os métodos na seção Erros comuns

Exemplo de código em 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'))