Saltar al contenido
Wbiztool

API de cuentas de WhatsApp

API para listar números de WhatsApp conectados

Obtén los números de WhatsApp de tu espacio de trabajo que están conectados en este momento. Úsala para que los usuarios elijan desde qué número enviar, o para encontrar el ID de whatsapp_client para otras llamadas a la API.

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

Cuerpo: JSON o campos de formulario

Solo se devuelven los números conectados. Para ver también los números desconectados, usa Listar cuentas.

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

Sustituye 12345 y YOUR_API_KEY por tus propios valores. Consulta Autenticación para saber dónde encontrarlos.

Parámetros de la solicitud#

client_idintegerobligatorio

Tu ID de cliente de la API, de Configuración → Claves API.

api_keystringobligatorio

Tu clave API, de esa misma página. La lista corresponde al espacio de trabajo en el que se creó esta clave.

Usar los clientes oficiales#

El cliente de Python llama a este endpoint por ti.

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

El cliente de Python lanza requests.exceptions.HTTPError cuando la API devuelve HTTP 400 o 403, así que envuelve la llamada en un try/except.

getWhatsAppClients() del cliente de Node.js llama a una dirección que no existe y falla con un 404. Usa fetch como en el Ejemplo rápido.

Respuesta#

Una solicitud correcta devuelve HTTP 200:

{
  "message": "okay",
  "whatsapp_clients": [
    {
      "id": 678,
      "whatsapp_client_id": 678,
      "whatsapp_client_number": "919876543210",
      "is_connected": true
    }
  ],
  "status": 1
}
CampoTipoDescripción
statusinteger1 si todo va bien, 0 si la solicitud falló.
messagestringokay si todo va bien; en caso contrario, el error.
whatsapp_clientsarrayTus números conectados. Vacío si no hay ninguno conectado. Solo aparece si la solicitud es correcta.
whatsapp_clients[].whatsapp_client_idintegerEl ID del número. Pásalo como whatsapp_client en otras llamadas a la API.
whatsapp_clients[].idintegerEl mismo valor que whatsapp_client_id.
whatsapp_clients[].whatsapp_client_numberstringEl número de teléfono tal como se guardó cuando se agregó el número.
whatsapp_clients[].is_connectedbooleanSiempre true, porque solo se listan los números conectados.

La lista no sigue ningún orden garantizado. Ordénala por whatsapp_client_id si el orden importa.

Errores#

MensajeHTTPCómo solucionarlo
Auth Error200Envía client_id y api_key en el cuerpo de una solicitud POST, como JSON válido o campos de formulario.
Invalid Client Id403Envía client_id como número entero, por ejemplo 12345.
Auth Error: invalid api key400Comprueba que la clave existe, que no se ha eliminado y que pertenece a este client_id.

Una solicitud que no sea POST devuelve un objeto vacío {}. Un problema inesperado del servidor devuelve HTTP 500 con un cuerpo HTML, así que comprueba que la respuesta sea JSON antes de leer status.

Consejos#

  • Lista vacía: "whatsapp_clients": [] significa que no hay ningún número conectado en este espacio de trabajo. Conecta uno en la configuración de WhatsApp o con Conectar un número.
  • Varios espacios de trabajo: la clave API determina qué espacio de trabajo se lista. Usa una clave creada en el espacio de trabajo que quieras.
  • Un solo número: para comprobar un único número, usa Estado de conexión.