Pular para o conteúdo principal
GET
/
wa
/
instances
/
{instance_id}
/
groups
/wa/instances/{instance_id}/groups
curl --request GET \
  --url https://api.example.com/wa/instances/{instance_id}/groups \
  --header 'Authorization: Bearer <token>'
[
  {
    "description": "My group description",
    "id": "120363279776130958",
    "invite_code": "XobOM8UBL8EXR3dXoGozql",
    "is_announcement": true,
    "is_restricted": true,
    "name": "My group name",
    "owner": {
      "id": "558796139874",
      "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
      "name": "Owner Name"
    },
    "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
    "total_participants": 2,
    "is_community": true,
    "approval_mode": "requires_approval"
  }
]

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

​
instance_id
string
obrigatório

Resposta

success

​
description
string
obrigatório

Descrição do grupo que também pode ser vista na seção de detalhamento do grupo.

Exemplo:

"My group description"

​
id
string
obrigatório

Identificador único do grupo.

Exemplo:

"120363279776130958"

​
invite_code
string | null
obrigatório

Código do convite do grupo que pode ser usado para convitar outros usuários.

Exemplo:

"XobOM8UBL8EXR3dXoGozql"

​
is_announcement
boolean
obrigatório

Indica se o grupo é apenas para anúncios (ninguém pode enviar mensagens, só o dono).

Exemplo:

true

​
is_restricted
boolean
obrigatório

Mostra se o grupo tem acesso restrito (apenas pessoas autorizadas podem participar).

Exemplo:

true

​
name
string
obrigatório

O nome dado ao grupo.

Exemplo:

"My group name"

​
owner
object
obrigatório
​
profile_picture
string<uri>
obrigatório

Profile picture URL of the group.

Exemplo:

"https://zapsterapi.s3.us-east-1.amazonaws.com/..."

​
total_participants
integer
obrigatório

Total number of participants in the group.

Exemplo:

2

​
is_community
boolean

Indica se o grupo é uma comunidade (pode ser um grupo de anúncios).

Exemplo:

true

​
approval_mode
enum<string>

Define como os participantes serão aprovados no grupo.

Opções disponíveis:
auto_approve,
requires_approval
Exemplo:

"requires_approval"