Pular para o conteúdo
Wbiztool

API de contas do WhatsApp

API de status da conexão do WhatsApp

Verifique se um dos seus números de WhatsApp está conectado e pronto para enviar mensagens. Use-o antes de uma campanha ou enquanto você aguarda um número recém-conectado terminar a conexão. Use este endpoint em vez de /api/v1/whatsapp/status/<id>/, que não funciona.

POSThttps://wbiztool.com/api/v1/whatsapp-client/status/

Corpo: JSON ou campos de formulário

Exemplo rápido#

curl -X POST https://wbiztool.com/api/v1/whatsapp-client/status/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678
  }'

Substitua 12345, YOUR_API_KEY e 678 pelos seus próprios valores. Veja em Autenticação onde encontrá-los.

Parâmetros da requisição#

client_idintegerobrigatório

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

api_keystringobrigatório

Sua chave de API, na mesma página.

whatsapp_clientintegerobrigatório

ID do número de WhatsApp a verificar, obtido nas configurações do WhatsApp, em Listar contas ou no whatsapp_client_id retornado por Conectar um número.

Usar os clientes oficiais#

O cliente Python chama este endpoint para você.

Python
from wbiztool_client import WbizToolClient

client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)

result = client.get_whatsapp_client_status(678)
print(result)

O cliente Python lança requests.exceptions.HTTPError quando a API retorna HTTP 400 ou 403, então coloque a chamada dentro de um try/except.

O getWhatsAppClientStatus() do cliente Node.js chama um endereço que não existe e falha com 404. Use fetch, como no Exemplo rápido.

Resposta#

Quando suas credenciais são válidas, a requisição retorna HTTP 200 com um destes corpos.

O número está conectado:

{ "message": "Connected", "status": 1 }

O número não está conectado:

{ "message": "Disconnected", "status": 0 }
CampoTipoDescrição
statusinteger1 se o número está conectado. 0 se não está conectado ou se a requisição falhou.
messagestringConnected, Disconnected ou o erro.

Um número que você excluiu nas configurações do WhatsApp também retorna Disconnected.

Erros#

MensagemHTTPComo corrigir
Auth Error200Envie client_id, api_key e um whatsapp_client numérico no corpo de um POST, como JSON válido ou campos de formulário.
Invalid Client Id403Envie client_id como número inteiro, por exemplo 12345.
Auth Error: invalid api key400Verifique se a chave existe, não foi excluída e pertence a este client_id.
Auth Error 2200Esse ID de whatsapp_client não está no espaço de trabalho desta chave de API.
Demo Account can not access apis200Use uma conta normal.

Dicas#

  • Antes de enviar: se o número pelo qual você envia estiver desconectado, as mensagens dele aguardam na fila até que ele se reconecte ou até expirarem, então verifique o status antes de envios grandes. As mensagens não enviadas em um número desconectado são removidas depois de 90 dias.
  • Depois de conectar um número: consulte este endpoint a cada poucos segundos até que ele retorne Connected. O webhook connected pode chegar alguns segundos antes de este endpoint retornar Connected, então continue consultando por até um minuto após o evento. Veja Conectar um número.
  • Todos os números de uma vez: para obter o status de todos os números em uma única chamada, use Listar contas.