Skip to main content
GET
/
api
/
{session}
/
groups
Obter todos os grupos
curl --request GET \
  --url https://{host}/api/{session}/groups \
  --header 'apikey: <api-key>'
{
  "groups": [
    {
      "id": "120363XXXXX@g.us",
      "subject": "Grupo 1",
      "participants": [...],
      "creation": 1234567890
    },
    {
      "id": "120363YYYYY@g.us",
      "subject": "Grupo 2",
      "participants": [...],
      "creation": 1234567891
    }
  ]
}

​
Descrição

Este endpoint retorna uma lista de todos os grupos em que a sessão está participando.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp

​
Resposta

​
groups
array
Array contendo todos os grupos da sessão
{
  "groups": [
    {
      "id": "120363XXXXX@g.us",
      "subject": "Grupo 1",
      "participants": [...],
      "creation": 1234567890
    },
    {
      "id": "120363YYYYY@g.us",
      "subject": "Grupo 2",
      "participants": [...],
      "creation": 1234567891
    }
  ]
}

​
Códigos de Status

  • 200 - Grupos listados com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Não autorizado

​
Exemplo de Uso

curl -X GET https://api.wappfy.com.br/api/my-session/groups

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Query Parameters

​
sortBy
enum<string>

Ordenar por campo

Available options:
id,
subject
​
sortOrder
enum<string>

Ordem de ordenação - <b>desc</b>endente (Z => A, Novo primeiro) ou <b>asc</b>endente (A => Z, Antigo primeiro) (Sort order - <b>desc</b>ending (Z => A, New first) or <b>asc</b>ending (A => Z, Old first))

Available options:
desc,
asc
​
limit
number
​
offset
number
​
exclude
enum<string>[]

Excluir campos

Response

200 - application/json

The response is of type object.

⌘I