Pular para o conteúdo
Wbiztool

Primeiros passos

Primeiros passos com a API do Wbiztool

A API REST do Wbiztool permite que o seu software envie mensagens de WhatsApp a partir do seu próprio número de WhatsApp conectado. Use-a para enviar atualizações de pedidos, lembretes e alertas a partir do seu app, CRM, site ou ferramenta de automação.

Esta página explica o que toda requisição precisa. Para enviar sua primeira mensagem, vá direto para Enviar mensagem.

URL base#

Todos os endpoints ficam em:

https://wbiztool.com/api/v1/

A maioria dos endpoints aceita requisições POST. Você pode enviar o corpo como JSON (application/json) ou como campos de formulário (application/x-www-form-urlencoded). Para enviar um arquivo, use multipart/form-data. Alguns endpoints de consulta usam GET; a página de cada endpoint mostra o método.

Antes de começar#

  1. Crie uma conta em wbiztool.com/signup. Contas novas incluem 50 mensagens grátis.
  2. Conecte um número de WhatsApp. Abra as configurações do WhatsApp, clique em conectar e escaneie o QR code pelo WhatsApp no seu celular.
  3. Crie uma chave de API. Acesse Configurações → Chaves API. Somente o proprietário de um espaço de trabalho pode criar chaves. Cada espaço de trabalho pode ter até 10 chaves.

Autenticação#

A maioria dos endpoints recebe suas credenciais no corpo de cada requisição. A API de verificação de números usa um cabeçalho Authorization: Bearer no lugar disso; as páginas dela explicam como.

client_idintegerobrigatório

Seu ID do Cliente da API, exibido em Configurações → Chaves API.

api_keystringobrigatório

Uma das suas chaves de API, na mesma página. Mantenha-a em segredo: qualquer pessoa com a chave pode enviar mensagens a partir dos seus números.

whatsapp_clientintegerA maioria dos endpoints de mensagens

O ID do número de WhatsApp a partir do qual a mensagem é enviada, exibido na coluna ID do Cliente WhatsApp das configurações do WhatsApp. A página de cada endpoint informa se ele é necessário.

A chave de API define em qual espaço de trabalho a requisição atua. Se você faz parte de mais de um espaço de trabalho, use uma chave criada no espaço de trabalho a partir do qual deseja enviar.

Se uma chave vazar, exclua-a na página de chaves de API. Chaves excluídas param de funcionar imediatamente.

Sua primeira requisição#

Esta requisição envia uma mensagem de texto a partir do seu número conectado. Substitua os IDs, a chave e o número de telefone pelos seus.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

Uma resposta com "status": 1 e um msg_id significa que a mensagem está na fila. Enviar mensagem explica todos os parâmetros e tem versões em Python, Node.js e PHP.

Respostas e erros#

Toda resposta é um objeto JSON com um campo status (exceto a verificação de disponibilidade /api/v1/status/, que retorna "status": 200):

  • "status": 1 significa que a requisição foi bem-sucedida.
  • "status": 0 significa que ela falhou. O campo message explica o motivo.
{ "status": 0, "message": "Auth Error: invalid api key" }

Erros de autenticação comuns:

MensagemSignificado
Auth Errorclient_id ou api_key está ausente, o corpo não é JSON ou dados de formulário válidos, ou a requisição não foi um POST.
Auth Error - Please send correct API key and Client idapi_key está ausente ou vazia.
Invalid client id. ou Invalid Client Idclient_id não é um número inteiro (ou, em alguns endpoints, está ausente). Envie-o como número, por exemplo 12345.
Auth Error: invalid api keyA chave não existe, foi excluída ou não pertence a este client_id.
Demo Account can not access apisContas de demonstração não podem usar a API.
Not enough creditsSeu plano não tem mais mensagens disponíveis. Faça upgrade ou aguarde o próximo ciclo de cobrança.

Ciclo de vida da mensagem#

As mensagens enviadas pela API primeiro entram na fila e depois são enviadas do seu número de WhatsApp. Cada mensagem tem um destes status:

StatusNomeSignificado
0CriadaNa fila, aguardando envio.
1EnviadaEnviada do seu número de WhatsApp.
2FalhouNão pôde ser enviada, por exemplo porque o número não tem WhatsApp.
3CanceladaCancelada antes de ser enviada.
4ExpiradaNão foi enviada antes do prazo definido em expire_after_seconds.

Seu número de WhatsApp precisa continuar conectado para que as mensagens na fila sejam enviadas. Se o número pelo qual você envia estiver desconectado, as mensagens dele aguardam na fila até que ele se reconecte ou até expirarem. Mensagens não enviadas de um número desconectado são removidas após 90 dias.

Para acompanhar uma mensagem, guarde o msg_id da resposta e informe uma URL em webhook ao enviá-la, ou chame Status da mensagem.

Bibliotecas cliente oficiais#

Os wrappers para Python e Node.js cuidam da autenticação e do envio de arquivos para você. Eles ainda não cobrem todos os endpoints corretamente, então confira a página de cada endpoint antes de depender de um método do cliente.

pip install wbiztool-client

Prefere uma configuração sem código? Veja Apps e integrações para Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify e WordPress.

Explore a documentação#