Pular para o conteúdo
Wbiztool

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.

POSThttps://wbiztool.com/api/v1/whatsapp/accounts/

Corpo: JSON ou campos de formulário

DiferençaListar contasListar números conectados
Inclui números desconectados e excluídosSimNão
Chaves de cada itemwhatsapp_client_id, whatsapp_number, statusid, whatsapp_client_id, whatsapp_client_number, is_connected
message em caso de sucessoNão incluídookay

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"
  }'

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ó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.

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
}
CampoTipoDescrição
statusinteger1 em caso de sucesso, 0 se a requisição falhou.
whatsapp_clientsarrayTodos os números de WhatsApp já adicionados a este espaço de trabalho. 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[].whatsapp_numberstringO número de telefone como foi salvo quando foi adicionado.
whatsapp_clients[].statusstringconnected 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#

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.

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_connected pode 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.