Documentação do KiraGo

Avançado
Painel Swagger

Estrutura do webhook

Quando um evento ocorre, o KiraGo envia uma requisição POST para o webhook configurado com os dados do evento. Abaixo estão os formatos dos principais tipos de evento:

Mensagem recebida

{
  "event": "Message",
  "instance": "5491155553934.0:53@s.whatsapp.net",
  "data": {
    "id": "3EB0ABCD123456789",
    "pushName": "Nome do Contato",
    "fromMe": false,
    "timestamp": 1647878528,
    "chat": "5491199999999@s.whatsapp.net",
    "sender": "5491199999999@s.whatsapp.net",
    "message": {
      "conversation": "Olá, como vai?"
    }
  }
}

Confirmação de leitura

{
  "event": "ReadReceipt",
  "instance": "5491155553934.0:53@s.whatsapp.net",
  "data": {
    "sender": "5491199999999@s.whatsapp.net",
    "chat": "5491199999999@s.whatsapp.net",
    "ids": ["3EB0ABCD123456789"],
    "timestamp": 1647878650
  }
}

Presence

{
  "event": "Presence",
  "instance": "5491155553934.0:53@s.whatsapp.net",
  "data": {
    "sender": "5491199999999@s.whatsapp.net",
    "status": "available",
    "timestamp": 1647878750
  }
}
Observação: Garanta que seu servidor de webhook responda com código 200 em um tempo razoável. O KiraGo considera uma resposta bem-sucedida como confirmação de que o evento foi processado corretamente.

Melhores práticas

Para usar a API do KiraGo com eficiência e evitar problemas, considere estas melhores práticas:

Segurança

Limites de uso

Webhooks

FAQ

Sim. O KiraGo suporta múltiplas instâncias. Cada instância tem seu próprio token e pode conectar a um número diferente. Você pode gerenciar todas as instâncias pelo painel administrativo.

Se o WhatsApp desconectar sua sessão (por exemplo, ao conectar no app ou ao clicar em “Sair de todos os dispositivos”), você precisará reconectar pelo endpoint /session/connect e escanear o QR novamente. O KiraGo não reconecta automaticamente em caso de logout forçado.

Para reduzir o risco de bloqueio:

  • Não envie mensagens em massa para pessoas que não conhecem você
  • Não envie a mesma mensagem para muitos contatos em sequência
  • Respeite limites de envio (aprox. 50–100 mensagens/dia para números novos)
  • Use um número que já tenha histórico de uso no WhatsApp
  • Não use a API para spam ou conteúdo inadequado
← Configurações