Saltar al contenido
WbizTool

Primeros pasos

Primeros pasos con la API de WbizTool

La API REST de WbizTool permite que tu software envíe mensajes de WhatsApp desde tu propio número de WhatsApp conectado. Úsala para enviar actualizaciones de pedidos, recordatorios y alertas desde tu app, CRM, sitio web o herramienta de automatización.

Esta página explica lo que necesita cada solicitud. Para enviar tu primer mensaje, ve directamente a Enviar mensaje.

URL base#

Todos los endpoints están bajo:

https://wbiztool.com/api/v1/

La mayoría de los endpoints aceptan solicitudes POST. Puedes enviar el cuerpo como JSON (application/json) o como campos de formulario (application/x-www-form-urlencoded). Para subir un archivo, usa multipart/form-data. Algunos endpoints de consulta usan GET; la página de cada endpoint indica su método.

Antes de empezar#

  1. Crea una cuenta en wbiztool.com/signup. Las cuentas nuevas incluyen 50 mensajes gratis.
  2. Conecta un número de WhatsApp. Abre Números de WhatsApp, haz clic en Añadir número y escanea el código QR desde WhatsApp en tu teléfono.
  3. Crea una clave API. Ve a Configuración → Claves API. Solo el propietario de un espacio de trabajo puede crear claves. Cada espacio de trabajo puede tener hasta 10 claves.

Autenticación#

Envía tu clave API en una cabecera Authorization: Bearer en cada solicitud (recomendado). La clave indica su espacio de trabajo, así que entonces no hace falta client_id. Las credenciales en el cuerpo (client_id y api_key como JSON o campos de formulario) siguen funcionando en todos los endpoints. Si se envían ambas, se usa una clave válida de la cabecera. Consulta Enviar la clave en una cabecera.

Authorization: Bearer YOUR_API_KEY
api_keystringobligatorio

Una de tus claves API de Configuración → Claves API, en la cabecera Authorization: Bearer o en el cuerpo. Mantenla en secreto: cualquiera que tenga la clave puede enviar mensajes desde tus números.

client_idintegerSolo con la clave en el cuerpo

Tu ID de cliente de la API, que aparece en esa misma página.

whatsapp_clientintegerLa mayoría de los endpoints de mensajería

El ID del número de WhatsApp desde el que se envía, que aparece como ID … ⧉ en la tarjeta del número en Números de WhatsApp (haz clic en él para copiarlo). La página de cada endpoint indica si lo necesita.

La clave API determina sobre qué espacio de trabajo actúa una solicitud. Si perteneces a más de un espacio de trabajo, usa una clave creada en el espacio de trabajo desde el que quieres enviar.

Si una clave se filtra, elimínala en la página de claves API. Las claves eliminadas dejan de funcionar de inmediato.

Tu primera solicitud#

Esto envía un mensaje de texto desde tu número conectado. Sustituye los IDs, la clave y el número de teléfono por los tuyos.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

Una respuesta "status": 1 con un msg_id significa que el mensaje está en cola. Enviar mensaje explica cada parámetro e incluye versiones en Python, Node.js y PHP.

Respuestas y errores#

Cada respuesta es un objeto JSON con un campo status (excepto la comprobación de estado /api/v1/status/, que devuelve "status": 200):

  • "status": 1 significa que la solicitud se completó correctamente.
  • "status": 0 significa que falló. El campo message explica el motivo.
{ "status": 0, "message": "Auth Error: invalid api key" }

Errores de autenticación frecuentes:

MensajeSignificado
Auth ErrorFalta client_id o api_key, el cuerpo no es JSON ni datos de formulario válidos, o la solicitud no fue un POST.
Auth Error - Please send correct API key and Client idFalta api_key o está vacío.
Invalid client id. o Invalid Client Idclient_id no es un número entero (o, en algunos endpoints, falta). Envíalo como número, por ejemplo 12345.
Auth Error: invalid api keyLa clave no existe, se eliminó o no pertenece a este client_id.
Demo Account can not access apisLas cuentas de demostración no pueden usar la API.
Not enough creditsEl espacio de trabajo está en el plan gratuito y no le quedan mensajes: los planes de pago envían mensajes ilimitados. Consulta Cuando te quedas sin mensajes.
Daily limit reached: … (HTTP 429, "code": "daily_limit_reached")El número de WhatsApp ya aceptó 1.000 mensajes en las últimas 24 horas (uso justo). Envía el resto más tarde o desde otro número.

Ciclo de vida de un mensaje#

Los mensajes que envías a través de la API primero se ponen en cola y luego se envían desde tu número de WhatsApp. Cada mensaje tiene uno de estos estados:

EstadoNombreSignificado
0CreatedEn cola, esperando a enviarse.
1SentEnviado desde tu número de WhatsApp.
2FailedNo se pudo enviar, por ejemplo porque el número no está en WhatsApp.
3CancelledCancelado antes de enviarse.
4ExpiredNo se envió antes de su plazo expire_after_seconds.

Tu número de WhatsApp debe seguir conectado para que salgan los mensajes en cola. Si el número desde el que envías está desconectado, sus mensajes esperan en la cola hasta que se vuelva a conectar o hasta que caduquen. Los mensajes no enviados de un número desconectado se eliminan después de 90 días.

Para hacer seguimiento de un mensaje, guarda el msg_id de la respuesta y pasa una URL webhook al enviarlo, o llama a Estado del mensaje.

Librerías cliente oficiales#

Los wrappers para Python y Node.js se encargan por ti de la autenticación y la subida de archivos. Todavía no cubren correctamente todos los endpoints, así que revisa la página de cada endpoint antes de confiar en un método del cliente.

pip install wbiztool-client

¿Prefieres una configuración sin código? Consulta Apps e integraciones para Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify y WordPress.

Explora la documentación#