Saltar al contenido
Wbiztool

API de cuentas de WhatsApp

API para listar cuentas de WhatsApp

Usa esta API para obtener en una sola llamada una lista completa de todos tus números de WhatsApp y su estado de conexión. A diferencia de Listar números conectados, incluye los números desconectados.

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

Cuerpo: JSON o campos de formulario

DiferenciaListar cuentasListar números conectados
Incluye números desconectados y eliminadosNo
Claves de cada elementowhatsapp_client_id, whatsapp_number, statusid, whatsapp_client_id, whatsapp_client_number, is_connected
message si la solicitud es correctaNo se incluyeokay

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

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

Ninguno de los clientes oficiales tiene un método para este endpoint, así que llámalo directamente como en los ejemplos.

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.

Respuesta#

Una solicitud correcta devuelve 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
}
CampoTipoDescripción
statusinteger1 si todo va bien, 0 si la solicitud falló.
whatsapp_clientsarrayTodos los números de WhatsApp que se han añadido alguna vez a este espacio de trabajo. 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[].whatsapp_numberstringEl número de teléfono tal como se guardó al añadirlo.
whatsapp_clients[].statusstringconnected o not_connected.

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

Una respuesta correcta no tiene campo message, así que léelo con un valor alternativo, como en los ejemplos.

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.

Si el servidor encuentra un problema inesperado, o la solicitud no es un POST, la respuesta es un objeto vacío: {}. Trata la ausencia de status como un fallo.

Consejos#

  • Volver a conectar un número: un número not_connected se puede volver a conectar en la configuración de WhatsApp o con Conectar un número.
  • Un solo número: para comprobar un único número, usa Estado de conexión.
  • 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.