API account WhatsApp

API Elenca numeri WhatsApp collegati

Ottieni i numeri WhatsApp del tuo spazio di lavoro che sono collegati in questo momento. Usala per permettere agli utenti di scegliere da quale numero inviare, o per trovare l'ID whatsapp_client da usare nelle altre chiamate API.

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

Corpo: JSON o campi di un modulo

Vengono restituiti solo i numeri collegati. Per vedere anche i numeri scollegati, usa Elenca account.

Esempio rapido#

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

import requests

response = requests.post(
    "https://wbiztool.com/api/v1/whatsapp-client/list/",
    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 number in result["whatsapp_clients"]:
        print(number["whatsapp_client_id"], number["whatsapp_client_number"])
else:
    print("Failed:", result.get("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/list/", {
  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 number of result.whatsapp_clients) {
    console.log(number.whatsapp_client_id, number.whatsapp_client_number);
  }
} else {
  console.error("Failed:", result.message);
}

<?php
$payload = [
    'client_id' => 12345,
    'api_key'   => 'YOUR_API_KEY',
];

$ch = curl_init('https://wbiztool.com/api/v1/whatsapp-client/list/');
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 $number) {
        echo $number['whatsapp_client_id'] . ' ' . $number['whatsapp_client_number'] . PHP_EOL;
    }
} else {
    echo 'Failed: ' . ($result['message'] ?? 'no response');
}

Sostituisci 12345 e YOUR_API_KEY con i tuoi valori. Consulta Autenticazione per sapere dove trovarli.

Parametri della richiesta#

client_idintegerobbligatorio: Il tuo ID Client API, da Impostazioni → Chiavi API.
api_keystringobbligatorio: La tua chiave API, dalla stessa pagina. L'elenco riguarda lo spazio di lavoro in cui è stata creata questa chiave.

Usare i client ufficiali#

Il client Python chiama questo endpoint per te.

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"])

Il client Python solleva requests.exceptions.HTTPError quando l'API restituisce HTTP 400 o 403, quindi racchiudi la chiamata in un try/except.

getWhatsAppClients() del client Node.js chiama un indirizzo che non esiste e non riesce con un 404. Usa fetch come nell'Esempio rapido.

Risposta#

Una richiesta riuscita restituisce HTTP 200:

{
  "message": "okay",
  "whatsapp_clients": [
    {
      "id": 678,
      "whatsapp_client_id": 678,
      "whatsapp_client_number": "919876543210",
      "is_connected": true
    }
  ],
  "status": 1
}

Campo	Tipo	Descrizione
`status`	integer	`1` in caso di successo, `0` se la richiesta non è riuscita.
`message`	string	`okay` in caso di successo, altrimenti l'errore.
`whatsapp_clients`	array	I tuoi numeri collegati. Vuoto se nessun numero è collegato. Presente solo in caso di successo.
`whatsapp_clients[].whatsapp_client_id`	integer	L'ID del numero. Passalo come `whatsapp_client` nelle altre chiamate API.
`whatsapp_clients[].id`	integer	Stesso valore di `whatsapp_client_id`.
`whatsapp_clients[].whatsapp_client_number`	string	Il numero di telefono così come è stato salvato quando il numero è stato aggiunto.
`whatsapp_clients[].is_connected`	boolean	Sempre `true`, perché vengono elencati solo i numeri collegati.

L'elenco non è ordinato in modo garantito. Ordina per whatsapp_client_id se l'ordine è importante.

Errori#

Messaggio	HTTP	Come risolvere
`Auth Error`	`200`	Invia sia `client_id` sia `api_key` nel corpo di una richiesta `POST`, come JSON valido o campi di un modulo.
`Invalid Client Id`	`403`	Invia `client_id` come numero intero, ad esempio `12345`.
`Auth Error: invalid api key`	`400`	Verifica che la chiave esista, non sia stata eliminata e appartenga a questo `client_id`.

Una richiesta che non è una POST restituisce un oggetto vuoto {}. Un problema imprevisto del server restituisce HTTP 500 con un corpo HTML, quindi verifica che la risposta sia JSON prima di leggere status.

Suggerimenti#

Elenco vuoto: "whatsapp_clients": [] significa che nessun numero è collegato in questo spazio di lavoro. Collegane uno nelle Impostazioni WhatsApp oppure con Collega un numero.
Più spazi di lavoro: la chiave API determina quale spazio di lavoro viene elencato. Usa una chiave creata nello spazio di lavoro che ti interessa.
Un solo numero: per controllare un singolo numero, usa Stato della connessione.