Skip to main content
A API externa permite que o seu sistema envie mensagens de WhatsApp, consulte o status de entrega e gerencie contatos, etiquetas e campos personalizados da WizeBot.

​
Antes de começar

Esta API tem limites que definem se ela serve para o seu caso. Vale conhecê-los antes de escrever a primeira linha de código.
Só é possível responder a conversas existentes. O envio exige que o contato já tenha falado com o seu número antes. Não há como iniciar uma conversa pela API, porque o envio de modelo de mensagem não está disponível aqui. Veja Enviar mensagem.
É uma API de servidor para servidor. A chave concede acesso total à sua conta e não pode ir para o navegador. Veja Autenticação.

​
URL base

Todos os endpoints ficam sob a mesma base:
Integrações que já usam https://api.wizebot.com.br/api/v1/whatsapp continuam funcionando, sem prazo de desligamento. Não é preciso migrar nada; a base acima é apenas mais curta.
Esta é a camada específica do WhatsApp, e ela permanece. Existe também um contrato multicanal, com endpoints neutros que falam com qualquer canal conectado — hoje WhatsApp e Telegram. Os dois convivem: o contrato neutro serve quem quer um só caminho para todos os canais; esta seção serve quem precisa do que só o WhatsApp tem. Quem já integrou aqui não precisa mudar nada.
Sobre o domínio antigo. Versões anteriores desta documentação usavam app.wizebot.com.br nos exemplos. Aquele domínio nunca serviu esta API — ele responde apenas pelo painel, e as requisições ali sempre retornaram erro de rota não encontrada. Não existe transição de domínio a fazer nem prazo de desligamento: há apenas a base acima, que é a correta desde agora.

​
Obter uma chave

  1. Acesse o painel da WizeBot.
  2. Vá em Configurações → API Keys.
  3. Clique em Nova API Key.
  4. Copie a chave gerada — ela só é exibida uma vez.
A chave é confidencial e dá acesso total à sua conta. Guarde-a em local seguro e nunca a coloque em código-fonte público, aplicativo móvel ou página web.

​
Identificar o phone_number_id

A maioria dos endpoints exige o parâmetro phone_number_id, que identifica de qual dos seus números de WhatsApp a operação parte. É o identificador do número na Meta, e você o encontra no painel, na tela de conexão do WhatsApp.

​
Primeira chamada

O endpoint de teste de conexão confirma que a chave funciona, sem produzir nenhum efeito:
Resposta:
O campo permissions é informativo. Ele não restringe o que a chave pode fazer nos endpoints do WhatsApp: qualquer chave válida pode ler e escrever.

​
O que existe nesta API

​
O que não existe

​
Próximos passos

Autenticação

As duas formas de enviar a chave, e a que não funciona

Respostas e erros

O envelope de resposta e a tabela de códigos de erro

Limites de uso

Quantas requisições por minuto cada endpoint aceita

Referência da API

Todos os endpoints, com playground para testar cada um

​
Suporte

Em caso de dúvida, escreva para suporte@wizebot.com.br. Se estiver relatando um erro, inclua o campo errorId da resposta: ele é o que permite localizar a requisição exata nos nossos registros.