Pular para o conteúdo
WbizTool

API de contas do WhatsApp

API para listar números de WhatsApp conectados

Obtenha os números de WhatsApp do seu espaço de trabalho que estão conectados neste momento. Use-a para permitir que os usuários escolham de qual número enviar, ou para encontrar o ID de whatsapp_client para outras chamadas à API.

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

Corpo: JSON ou campos de formulário

Somente números conectados são retornados. Para ver também os números desconectados, use Listar contas. As contas do Telegram conectadas também são listadas, com platform definido como telegram.

Exemplo rápido#

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

Substitua 12345 e YOUR_API_KEY 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. A lista é do espaço de trabalho em que esta chave foi criada.

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.list_whatsapp_clients()
for number in result.get("whatsapp_clients", []):
    print(number["whatsapp_client_id"], number["whatsapp_client_number"])

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 getWhatsAppClients() do cliente Node.js chama um endereço que não existe e falha com 404. Use fetch, como no Exemplo rápido.

Resposta#

Uma requisição bem-sucedida retorna HTTP 200:

{
  "message": "okay",
  "whatsapp_clients": [
    {
      "id": 678,
      "whatsapp_client_id": 678,
      "whatsapp_client_number": "919876543210",
      "platform": "whatsapp",
      "is_connected": true
    },
    {
      "id": 702,
      "whatsapp_client_id": 702,
      "whatsapp_client_number": "919812345670",
      "platform": "telegram",
      "is_connected": true
    }
  ],
  "status": 1
}
CampoTipoDescrição
statusinteger1 em caso de sucesso, 0 se a requisição falhou.
messagestringokay em caso de sucesso; caso contrário, o erro.
whatsapp_clientsarraySeus números conectados. Vazio se nenhum estiver conectado. Presente apenas em caso de sucesso.
whatsapp_clients[].whatsapp_client_idintegerO ID do número. Informe-o como whatsapp_client em outras chamadas à API.
whatsapp_clients[].idintegerMesmo valor de whatsapp_client_id.
whatsapp_clients[].whatsapp_client_numberstringO número de telefone como foi salvo quando o número foi adicionado.
whatsapp_clients[].platformstringwhatsapp para um número de WhatsApp, telegram para uma conta do Telegram. Envie de qualquer um dos dois com o ID dele como whatsapp_client.
whatsapp_clients[].is_connectedbooleanSempre true, porque somente números conectados são listados.

A lista não tem nenhuma ordem garantida. Ordene por whatsapp_client_id se a ordem importar.

Erros#

MensagemHTTPComo corrigir
Auth Error200Envie client_id e api_key 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.

Uma requisição que não seja POST retorna um objeto vazio {}. Um problema inesperado no servidor retorna HTTP 500 com um corpo HTML, então verifique se a resposta é JSON antes de ler status.

Dicas#

  • Lista vazia: "whatsapp_clients": [] significa que nenhum número está conectado neste espaço de trabalho. Conecte um nas configurações do WhatsApp ou com Conectar um número.
  • 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.
  • Apenas um número: para verificar um único número, use Status da conexão.