Grupos

Endpoints para criar e gerenciar grupos WhatsApp. Todos requerem o header x-instance com o ID da sessão.

Listar grupos

Retorna todos os grupos da sessão conectada.

GET https://api.wi.api.br/groups

Headers

Header	Tipo	Obrigatório	Descrição
x-instance	string	Sim	ID da sessão

Request

cURL

curl https://api.wi.api.br/groups \
  -H "x-instance: {sessionId}" \
  -H "x-api-key: wa_key_abc123"

JavaScript

const response = await fetch("https://api.wi.api.br/groups", {
  headers: {
    "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
    "x-api-key": "wa_key_abc123",
  },
});

const groups = await response.json();

Python

import requests

response = requests.get(
    "https://api.wi.api.br/groups",
    headers={
        "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
        "x-api-key": "wa_key_abc123",
    },
)

groups = response.json()

Response

[
  {
    "id": "120363012345678901@g.us",
    "name": "Equipe Comercial",
    "participants": 12
  },
  {
    "id": "120363098765432101@g.us",
    "name": "Suporte Técnico",
    "participants": 5
  }
]

Criar grupo

Cria um novo grupo e adiciona os participantes informados.

POST https://api.wi.api.br/groups/create

Headers

Header	Tipo	Obrigatório	Descrição
x-instance	string	Sim	ID da sessão

Body

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do grupo
participants	string[]	Sim	Números dos participantes (formato internacional)

Request

cURL

curl -X POST https://api.wi.api.br/groups/create \
  -H "x-instance: {sessionId}" \
  -H "x-api-key: wa_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Projeto Alpha",
    "participants": ["5511999999999", "5511888888888"]
  }'

JavaScript

const response = await fetch("https://api.wi.api.br/groups/create", {
  method: "POST",
  headers: {
    "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
    "x-api-key": "wa_key_abc123",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Projeto Alpha",
    participants: ["5511999999999", "5511888888888"],
  }),
});

const group = await response.json();

Python

import requests

response = requests.post(
    "https://api.wi.api.br/groups/create",
    headers={
        "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
        "x-api-key": "wa_key_abc123",
    },
    json={
        "name": "Projeto Alpha",
        "participants": ["5511999999999", "5511888888888"],
    },
)

group = response.json()

Response

{
  "id": "120363045678901234@g.us",
  "name": "Projeto Alpha"
}

Informações do grupo

Retorna informações detalhadas de um grupo, incluindo participantes.

POST https://api.wi.api.br/groups/info

Headers

Header	Tipo	Obrigatório	Descrição
x-instance	string	Sim	ID da sessão

Body

Campo	Tipo	Obrigatório	Descrição
groupId	string	Sim	ID do grupo (formato @g.us)

Request

cURL

curl -X POST https://api.wi.api.br/groups/info \
  -H "x-instance: {sessionId}" \
  -H "x-api-key: wa_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{ "groupId": "120363012345678901@g.us" }'

JavaScript

const response = await fetch("https://api.wi.api.br/groups/info", {
  method: "POST",
  headers: {
    "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
    "x-api-key": "wa_key_abc123",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ groupId: "120363012345678901@g.us" }),
});

const info = await response.json();

Python

import requests

response = requests.post(
    "https://api.wi.api.br/groups/info",
    headers={
        "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
        "x-api-key": "wa_key_abc123",
    },
    json={"groupId": "120363012345678901@g.us"},
)

info = response.json()

Response

{
  "id": "120363012345678901@g.us",
  "name": "Equipe Comercial",
  "topic": "Discussões internas da equipe",
  "owner": "5511999999999@s.whatsapp.net",
  "created": "2026-01-15T10:30:00Z",
  "participants": [
    { "id": "5511999999999@s.whatsapp.net", "admin": true },
    { "id": "5511888888888@s.whatsapp.net", "admin": false }
  ]
}

Entrar em grupo

Entra em um grupo usando o código de convite.

POST https://api.wi.api.br/groups/join

Headers

Header	Tipo	Obrigatório	Descrição
x-instance	string	Sim	ID da sessão

Body

Campo	Tipo	Obrigatório	Descrição
inviteCode	string	Sim	Código de convite (parte final do link)

Request

cURL

curl -X POST https://api.wi.api.br/groups/join \
  -H "x-instance: {sessionId}" \
  -H "x-api-key: wa_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{ "inviteCode": "ABC123xyz" }'

JavaScript

const response = await fetch("https://api.wi.api.br/groups/join", {
  method: "POST",
  headers: {
    "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
    "x-api-key": "wa_key_abc123",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ inviteCode: "ABC123xyz" }),
});

const result = await response.json();

Python

import requests

response = requests.post(
    "https://api.wi.api.br/groups/join",
    headers={
        "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
        "x-api-key": "wa_key_abc123",
    },
    json={"inviteCode": "ABC123xyz"},
)

result = response.json()

Response

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

Sair do grupo

Remove a sessão do grupo informado.

POST https://api.wi.api.br/groups/leave

Headers

Header	Tipo	Obrigatório	Descrição
x-instance	string	Sim	ID da sessão

Body

Campo	Tipo	Obrigatório	Descrição
groupId	string	Sim	ID do grupo

Request

cURL

curl -X POST https://api.wi.api.br/groups/leave \
  -H "x-instance: {sessionId}" \
  -H "x-api-key: wa_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{ "groupId": "120363012345678901@g.us" }'

JavaScript

const response = await fetch("https://api.wi.api.br/groups/leave", {
  method: "POST",
  headers: {
    "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
    "x-api-key": "wa_key_abc123",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ groupId: "120363012345678901@g.us" }),
});

Python

import requests

response = requests.post(
    "https://api.wi.api.br/groups/leave",
    headers={
        "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
        "x-api-key": "wa_key_abc123",
    },
    json={"groupId": "120363012345678901@g.us"},
)

Caution

Ao sair do grupo, você perde acesso ao histórico e precisará de um novo convite para entrar novamente.

Participantes

Retorna a lista de participantes de um grupo com indicação de admin.

POST https://api.wi.api.br/groups/participants

Headers

Header	Tipo	Obrigatório	Descrição
x-instance	string	Sim	ID da sessão

Body

Campo	Tipo	Obrigatório	Descrição
groupId	string	Sim	ID do grupo

Request

cURL

curl -X POST https://api.wi.api.br/groups/participants \
  -H "x-instance: {sessionId}" \
  -H "x-api-key: wa_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{ "groupId": "120363012345678901@g.us" }'

JavaScript

const response = await fetch("https://api.wi.api.br/groups/participants", {
  method: "POST",
  headers: {
    "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
    "x-api-key": "wa_key_abc123",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ groupId: "120363012345678901@g.us" }),
});

const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.wi.api.br/groups/participants",
    headers={
        "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
        "x-api-key": "wa_key_abc123",
    },
    json={"groupId": "120363012345678901@g.us"},
)

data = response.json()

Response

{
  "participants": [
    { "id": "5511999999999@s.whatsapp.net", "admin": true },
    { "id": "5511888888888@s.whatsapp.net", "admin": false },
    { "id": "5511777777777@s.whatsapp.net", "admin": false }
  ]
}

Link de convite

Gera ou retorna o link de convite atual do grupo.

POST https://api.wi.api.br/groups/invitelink

Headers

Header	Tipo	Obrigatório	Descrição
x-instance	string	Sim	ID da sessão

Body

Campo	Tipo	Obrigatório	Descrição
groupId	string	Sim	ID do grupo

Request

cURL

curl -X POST https://api.wi.api.br/groups/invitelink \
  -H "x-instance: {sessionId}" \
  -H "x-api-key: wa_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{ "groupId": "120363012345678901@g.us" }'

JavaScript

const response = await fetch("https://api.wi.api.br/groups/invitelink", {
  method: "POST",
  headers: {
    "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
    "x-api-key": "wa_key_abc123",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ groupId: "120363012345678901@g.us" }),
});

const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.wi.api.br/groups/invitelink",
    headers={
        "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
        "x-api-key": "wa_key_abc123",
    },
    json={"groupId": "120363012345678901@g.us"},
)

data = response.json()

Response

{ "inviteLink": "https://chat.whatsapp.com/ABC123xyz" }

Alterar nome

Altera o nome de um grupo. Requer permissão de administrador.

POST https://api.wi.api.br/groups/name

Headers

Header	Tipo	Obrigatório	Descrição
x-instance	string	Sim	ID da sessão

Body

Campo	Tipo	Obrigatório	Descrição
groupId	string	Sim	ID do grupo
name	string	Sim	Novo nome do grupo

Request

cURL

curl -X POST https://api.wi.api.br/groups/name \
  -H "x-instance: {sessionId}" \
  -H "x-api-key: wa_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "groupId": "120363012345678901@g.us",
    "name": "Equipe Comercial 2026"
  }'

JavaScript

const response = await fetch("https://api.wi.api.br/groups/name", {
  method: "POST",
  headers: {
    "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
    "x-api-key": "wa_key_abc123",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    groupId: "120363012345678901@g.us",
    name: "Equipe Comercial 2026",
  }),
});

Python

import requests

response = requests.post(
    "https://api.wi.api.br/groups/name",
    headers={
        "x-instance": "01234567-89ab-cdef-0123-456789abcdef",
        "x-api-key": "wa_key_abc123",
    },
    json={
        "groupId": "120363012345678901@g.us",
        "name": "Equipe Comercial 2026",
    },
)

Outros endpoints

Endpoint	Método	Descrição	Body
/groups/topic	POST	Altera a descrição do grupo	{ "groupId": "...", "topic": "Nova descrição" }
/groups/photo	POST	Define a foto do grupo (base64 JPEG)	{ "groupId": "...", "image": "data:image/jpeg;base64,..." }
/groups/photo/remove	POST	Remove a foto do grupo	{ "groupId": "..." }
/groups/announce	POST	Ativa/desativa modo anuncio (só admins enviam)	{ "groupId": "...", "announce": true }
/groups/locked	POST	Ativa/desativa grupo trancado (só admins editam info)	{ "groupId": "...", "locked": true }
/groups/ephemeral	POST	Define mensagens temporárias	{ "groupId": "...", "expiration": 604800 }
/groups/inviteinfo	POST	Retorna informações de um código de convite	{ "inviteCode": "ABC123xyz" }

Tip

Valores válidos para expiration em /groups/ephemeral: 86400 (24h), 604800 (7 dias), 7776000 (90 dias), ou 0 para desativar.