API de contas do WhatsApp
API para listar contas do WhatsApp
Use esta API para obter, em uma única chamada, a lista completa de todos os seus números de WhatsApp e o status de conexão de cada um. Ao contrário de Listar números conectados, ela inclui números desconectados.
https://wbiztool.com/api/v1/whatsapp/accounts/Corpo: JSON ou campos de formulário
| Diferença | Listar contas | Listar números conectados |
|---|---|---|
| Inclui números desconectados e excluídos | Sim | Não |
| Chaves de cada item | whatsapp_client_id, whatsapp_number, status | id, whatsapp_client_id, whatsapp_client_number, is_connected |
message em caso de sucesso | Não incluído | okay |
Exemplo rápido#
curl -X POST https://wbiztool.com/api/v1/whatsapp/accounts/ \
-H "Content-Type: application/json" \
-d '{
"client_id": 12345,
"api_key": "YOUR_API_KEY"
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp/accounts/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400 or 403
if result.get("status") == 1:
for account in result["whatsapp_clients"]:
print(account["whatsapp_client_id"], account["whatsapp_number"], account["status"])
else:
print("Failed:", result.get("message", "no response"))// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/whatsapp/accounts/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403
if (result.status === 1) {
for (const account of result.whatsapp_clients) {
console.log(account.whatsapp_client_id, account.whatsapp_number, account.status);
}
} else {
console.error("Failed:", result.message ?? "no response");
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp/accounts/');
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) {
foreach ($result['whatsapp_clients'] as $account) {
echo $account['whatsapp_client_id'] . ' ' . $account['whatsapp_number'] . ' ' . $account['status'] . PHP_EOL;
}
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}Substitua 12345 e YOUR_API_KEY pelos seus próprios valores. Veja em Autenticação onde encontrá-los.
Nenhum dos clientes oficiais tem um método para este endpoint, então chame-o diretamente, como nos exemplos.
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. A lista é do espaço de trabalho em que esta chave foi criada.
Resposta#
Uma requisição bem-sucedida retorna HTTP 200:
{
"whatsapp_clients": [
{
"whatsapp_client_id": 678,
"whatsapp_number": "919876543210",
"status": "connected"
},
{
"whatsapp_client_id": 702,
"whatsapp_number": "919812345678",
"status": "not_connected"
}
],
"status": 1
}
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | 1 em caso de sucesso, 0 se a requisição falhou. |
whatsapp_clients | array | Todos os números de WhatsApp já adicionados a este espaço de trabalho. Presente apenas em caso de sucesso. |
whatsapp_clients[].whatsapp_client_id | integer | O ID do número. Informe-o como whatsapp_client em outras chamadas à API. |
whatsapp_clients[].whatsapp_number | string | O número de telefone como foi salvo quando foi adicionado. |
whatsapp_clients[].status | string | connected ou not_connected. |
A lista não tem nenhuma ordem garantida. Ordene por whatsapp_client_id se a ordem for importante.
Uma resposta de sucesso não tem o campo message, então leia-o com um valor padrão, como nos exemplos.
Erros#
| Mensagem | HTTP | Como corrigir |
|---|---|---|
Auth Error | 200 | Envie client_id e api_key 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. |
Se o servidor encontrar um problema inesperado, ou se a requisição não for um POST, a resposta é um objeto vazio: {}. Trate a ausência de status como falha.
Dicas#
- Reconectar um número: um número
not_connectedpode ser reconectado nas configurações do WhatsApp ou com Conectar um número. - Apenas um número: para verificar um único número, use Status da conexão.
- Vários espaços de trabalho: a chave de API define qual espaço de trabalho é listado. Use uma chave criada no espaço de trabalho desejado.
