Pular para o conteúdo principal

​
Grupos

Gerencie grupos do WhatsApp através da API da Wappfy. Você pode criar grupos, gerenciar participantes, lidar com links de convite e mais. Todos os endpoints de grupo são vinculados a uma instância específica: 
/api/instances/{instanceId}/groups/...

​
Criar um Grupo

Crie um novo grupo do WhatsApp com participantes iniciais. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Projeto Alpha",
    "participants": [
      "[email protected]",
      "[email protected]"
    ]
  }'
Resposta: 
{
  "data": {
    "group_id": "[email protected]",
    "name": "Projeto Alpha",
    "participants": [
      {
        "id": "[email protected]",
        "is_admin": false
      },
      {
        "id": "[email protected]",
        "is_admin": false
      }
    ]
  }
}

​
Listar Grupos

Recupere todos os grupos dos quais a instância é membro. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups \
  -H "X-Api-Key: YOUR_API_KEY"

​
Informações do Grupo

Busque informações detalhadas sobre um grupo específico. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY"

​
Atualizar um Grupo

Atualize o nome ou descrição do grupo. Você deve ser admin do grupo. 
curl -X PATCH https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Projeto Alpha v2",
    "description": "Workspace atualizado do Projeto Alpha"
  }'
Apenas admins do grupo podem atualizar o nome e descrição. Se a instância não for admin, retornará erro 403.

​
Sair de um Grupo

Remova a instância de um grupo. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/leave \
  -H "X-Api-Key: YOUR_API_KEY"
Após sair de um grupo, você precisará de um link de convite ou que outro admin te adicione novamente.

​
Participantes

​
Listar Participantes

Obtenha todos os participantes de um grupo. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY"

​
Adicionar Participantes

Adicione um ou mais participantes a um grupo. Você deve ser admin do grupo. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": [
      "[email protected]",
      "[email protected]"
    ]
  }'

​
Remover Participantes

Remova um ou mais participantes de um grupo. Você deve ser admin do grupo. 
curl -X DELETE https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": [
      "[email protected]"
    ]
  }'

​
Códigos de Convite

​
Obter Código de Convite

Gere ou recupere o link de convite do grupo. Você deve ser admin do grupo. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/invite-code \
  -H "X-Api-Key: YOUR_API_KEY"
Resposta: 
{
  "data": {
    "invite_code": "https://chat.whatsapp.com/AbCdEfGhIjKlMn"
  }
}

​
Entrar via Código de Convite

Entre em um grupo usando um código de convite. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/join \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invite_code": "AbCdEfGhIjKlMn"
  }'
Passe apenas o código, não a URL completa. Para https://chat.whatsapp.com/AbCdEfGhIjKlMn, passe AbCdEfGhIjKlMn.

​
Enviando Mensagens para Grupos

Para enviar uma mensagem a um grupo, use o endpoint padrão de envio de mensagens com o chat ID do grupo: 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/messages/send \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chat_id": "[email protected]",
    "type": "text",
    "text": "Olá equipe!"
  }'
IDs de chat de grupo sempre terminam com @g.us.

​
Referência de Endpoints

MétodoEndpointDescrição
POST/api/instances/{id}/groupsCriar um novo grupo
GET/api/instances/{id}/groupsListar todos os grupos
GET/api/instances/{id}/groups/{groupId}Informações do grupo
PATCH/api/instances/{id}/groups/{groupId}Atualizar nome/descrição
POST/api/instances/{id}/groups/{groupId}/leaveSair de um grupo
GET/api/instances/{id}/groups/{groupId}/participantsListar participantes
POST/api/instances/{id}/groups/{groupId}/participantsAdicionar participantes
DELETE/api/instances/{id}/groups/{groupId}/participantsRemover participantes
GET/api/instances/{id}/groups/{groupId}/invite-codeObter código de convite
POST/api/instances/{id}/groups/joinEntrar via código de convite

​
Tratamento de Erros

CódigoDescrição
403Você não é admin deste grupo.
404Grupo não encontrado ou instância não é membro.
409Participante já está no grupo (ao adicionar) ou não está no grupo (ao remover).
422Formato de participante inválido. Use {telefone}@s.whatsapp.net.