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.
https://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
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp-client/status/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"whatsapp_client": 678,
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400 or 403
if result["status"] == 1:
print("Connected")
elif result["message"] == "Disconnected":
print("Not connected. Reconnect it in WhatsApp settings.")
else:
print("Failed:", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/whatsapp-client/status/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
whatsapp_client: 678,
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403
if (result.status === 1) {
console.log("Connected");
} else if (result.message === "Disconnected") {
console.log("Not connected. Reconnect it in WhatsApp settings.");
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'whatsapp_client' => 678,
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp-client/status/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
if (($result['status'] ?? 0) === 1) {
echo 'Connected';
} elseif (($result['message'] ?? '') === 'Disconnected') {
echo 'Not connected. Reconnect it in WhatsApp settings.';
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}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órioSeu ID do Cliente da API, em Configurações → Chaves API.
api_keystringobrigatórioSua chave de API, na mesma página.
whatsapp_clientintegerobrigatórioID do número de WhatsApp a verificar, obtido nas configurações do WhatsApp, em Listar contas ou no
whatsapp_client_idretornado por Conectar um número.
Usar os clientes oficiais#
O cliente Python chama este endpoint para você.
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 }
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | 1 se o número está conectado. 0 se não está conectado ou se a requisição falhou. |
message | string | Connected, Disconnected ou o erro. |
Um número que você excluiu nas configurações do WhatsApp também retorna Disconnected.
Erros#
| Mensagem | HTTP | Como corrigir |
|---|---|---|
Auth Error | 200 | Envie 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 Id | 403 | Envie client_id como número inteiro, por exemplo 12345. |
Auth Error: invalid api key | 400 | Verifique se a chave existe, não foi excluída e pertence a este client_id. |
Auth Error 2 | 200 | Esse ID de whatsapp_client não está no espaço de trabalho desta chave de API. |
Demo Account can not access apis | 200 | Use 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 webhookconnectedpode chegar alguns segundos antes de este endpoint retornarConnected, 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.
