WhatsApp 💬

Integração do Mega-Bot com Alauda API

Ativar Grupo

POST/api/whatsapp/activate

Ativa um grupo do WhatsApp para uso com o Mega-Bot.

Body (JSON)

Campo	Tipo	Obrigatório	Descrição
group_id	string	Sim	ID do grupo (formato: 120363xxxxx@g.us)
api_key	string	Sim	Chave da API do usuário
group_name	string	Não	Nome do grupo
bot_number	string	Não	Número do bot

Exemplo de Requisição

bash

curl -X POST https://api.alauda.mz/api/whatsapp/activate \
  -H "X-API-Key: sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "group_id": "120363012345678901@g.us",
    "api_key": "sua_api_key_aqui",
    "group_name": "Meu Grupo",
    "bot_number": "258840000000"
  }'

Resposta

json

{
  "success": true,
  "message": "Grupo ativado com sucesso",
  "data": {
    "group_id": "120363012345678901@g.us",
    "group_name": "Meu Grupo",
    "status": "active",
    "activated_at": "2024-01-15T10:30:00Z"
  }
}

Custo: Sem consumo de créditos

Validar Grupo e Créditos

POST/api/whatsapp/validate

Valida se o grupo está ativo e se o usuário possui créditos suficientes.

Body (JSON)

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

Exemplo de Requisição

bash

curl -X POST https://api.alauda.mz/api/whatsapp/validate \
  -H "X-API-Key: sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "group_id": "120363012345678901@g.us"
  }'

Resposta

json

{
  "success": true,
  "data": {
    "group_id": "120363012345678901@g.us",
    "active": true,
    "credits_available": 4500,
    "plan": "PRO"
  }
}

Consumir Créditos

POST/api/whatsapp/consume

Consome créditos do usuário associado ao grupo para uma operação do bot.

Body (JSON)

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

Exemplo de Requisição

bash

curl -X POST https://api.alauda.mz/api/whatsapp/consume \
  -H "X-API-Key: sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "group_id": "120363012345678901@g.us"
  }'

Resposta

json

{
  "success": true,
  "message": "Créditos consumidos com sucesso",
  "data": {
    "credits_consumed": 50,
    "credits_remaining": 4450
  }
}

Custo: 50 créditos por operação

Desativar Grupo

POST/api/whatsapp/deactivate

Desativa um grupo do WhatsApp, removendo a integração com o Mega-Bot.

Body (JSON)

Campo	Tipo	Obrigatório	Descrição
group_id	string	Sim	ID do grupo do WhatsApp
api_key	string	Sim	Chave da API do usuário

Exemplo de Requisição

bash

curl -X POST https://api.alauda.mz/api/whatsapp/deactivate \
  -H "X-API-Key: sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "group_id": "120363012345678901@g.us",
    "api_key": "sua_api_key_aqui"
  }'

Resposta

json

{
  "success": true,
  "message": "Grupo desativado com sucesso",
  "data": {
    "group_id": "120363012345678901@g.us",
    "status": "inactive",
    "deactivated_at": "2024-01-15T12:00:00Z"
  }
}

Status do Grupo

GET/api/whatsapp/status/:group_id

Retorna o status atual de um grupo ativado.

Parâmetros

Campo	Tipo	Obrigatório	Descrição
group_id	string	Sim	ID do grupo (parâmetro na URL)

Exemplo de Requisição

bash

curl -X GET "https://api.alauda.mz/api/whatsapp/status/120363012345678901@g.us" \
  -H "X-API-Key: sua_api_key_aqui"

Resposta

json

{
  "success": true,
  "data": {
    "group_id": "120363012345678901@g.us",
    "group_name": "Meu Grupo",
    "status": "active",
    "owner": "usuario@email.com",
    "credits_remaining": 4450,
    "activated_at": "2024-01-15T10:30:00Z",
    "total_operations": 125
  }
}

Funcionalidades

✓
Ativação de Grupos
Ative grupos do WhatsApp para integração com o Mega-Bot
✓
Validação de Créditos
Verifique se o grupo está ativo e possui créditos antes de cada operação
✓
Consumo por Operação
Cada operação do bot consome 50 créditos da conta do usuário

⚠️

Formato do Group ID

O ID do grupo deve seguir o formato do WhatsApp: 120363xxxxx@g.us. Certifique-se de usar o ID correto ao ativar ou consultar grupos.

💡

Dica

Use a rota /validate antes de cada operação para garantir que o grupo está ativo e possui créditos suficientes.