Documentacion completa de Waprime API

Quickstart

curl -X POST "https://api.waprime.click/{instance_id}/messages/chat" \
  -H "content-type: application/json" \
  -d '{
    "token": "wap_inst_xxxxxxxxx",
    "to": "59899123456",
    "body": "Hola desde Waprime",
    "priority": 10
  }'

Respuesta esperada:

{
  "sent": "true",
  "message": "ok",
  "id": 123
}

Esta respuesta significa que el mensaje fue aceptado en cola. El envio real sucede en background y se confirma por estados/webhooks.

Instancia y token

Cada cuenta creada en el panel tiene al menos una instancia. La instancia publica tiene formato instancexxxxxx y el token tiene formato wap_inst_....

El panel no vuelve a solicitar ni mostrar el token almacenado. Para reemplazarlo, use Rotar token en Credenciales API, confirme la invalidacion inmediata del token anterior y copie el nuevo antes de recargar.

En webhooks, instance_id es el UUID interno de WAPRIME. En la API compatible /{instance_id}/... se usa el publicId, por ejemplo instanceff9104.

WhatsApp puede entregar entrantes como JID privado @lid. Waprime lo resuelve al telefono real cuando Baileys tiene el mapping, para que message.received.data.from contenga el contacto remoto.

Formatos de destinatarios

El campo to acepta contactos y grupos. El formato recomendado depende del tipo de destino.

59899123456

+598 99 123 456
(+598) 99-123-456
598-99-123-456
598 99 123 456
598097609597

59899123456@c.us
59899123456@s.whatsapp.net

120363000000000000@g.us

GET https://api.waprime.click/{instance_id}/groups/ids?token=wap_inst_xxxxxxxxx

{
  "token": "wap_inst_xxxxxxxxx",
  "to": "120363000000000000@g.us",
  "body": "Hola grupo"
}

Panel

Autenticacion

Los endpoints compatibles aceptan token por query string, JSON, form-urlencoded o multipart.

GET https://api.waprime.click/{instance_id}/instance/status?token=wap_inst_xxxxxxxxx

POST https://api.waprime.click/{instance_id}/messages/chat
Content-Type: application/json

{
  "token": "wap_inst_xxxxxxxxx",
  "to": "59899123456",
  "body": "Mensaje",
  "priority": 10
}

Mensajes

Los envios se encolan, se procesan por Waprime y se actualizan con estados de entrega cuando WhatsApp los informa.

priority es opcional en los envios. Si no se envia, Waprime usa messagePriority de la instancia. Valores permitidos: 1 a 100; 1 se procesa antes.

En /messages/vcard, name o displayName se usa como nombre visible del contacto. Si faltan, Waprime parsea FN, luego ORG y finalmente el numero de la vCard. Soporta saltos CRLF, LF, CR y \n literal escapado.

Instancia

Para enviar con rotacion de instancias, usa solo instancias cuyo status sea authenticated y substatus connected.

{
  "status": {
    "accountStatus": {
      "status": "authenticated",
      "substatus": "connected"
    }
  }
}

Gestion de perfil

Estos endpoints usan capacidades de la instancia conectada. Algunas acciones pueden tardar en reflejarse en todos los clientes.

Chats

Algunos datos dependen de lo sincronizado por la instancia. Waprime cachea actividad entrante y consulta la conexion cuando esta activa.

Contactos

Grupos

Los endpoints de grupos consultan metadata de la instancia cuando esta activa y cachean resultados utiles.

Etiquetas

Waprime agrega soporte propio para etiquetas de WhatsApp Business. Se cachean localmente para poder listarlas aunque WhatsApp no reenvie todo el estado.

curl -X POST "https://api.waprime.click/{instance_id}/labels" \
  -H "content-type: application/json" \
  -d '{
    "token": "wap_inst_xxxxxxxxx",
    "name": "Cliente VIP",
    "color": "4"
  }'

Media

Waprime acepta archivos por URL HTTP, base64 o multipart. La media se guarda temporalmente y puede exponerse como URL no adivinable.

curl -X POST "https://api.waprime.click/{instance_id}/media/upload" \
  -H "content-type: application/json" \
  -d '{
    "token": "wap_inst_xxxxxxxxx",
    "file": "https://example.com/factura.pdf"
  }'

Webhooks

Los webhooks se configuran por instancia desde el panel o desde /instance/settings.

webhookRetries acepta valores de 0 a 10. El valor recomendado 3 significa tres reintentos despues del intento inicial, hasta cuatro intentos totales.

{
  "event": "message.received",
  "timestamp": "2026-06-10T10:17:01.396Z",
  "tenant_id": "tenant_uuid",
  "instance_id": "internal_instance_uuid",
  "instance_public_id": "instanceff9104",
  "data": {
    "direction": "INBOUND",
    "fromMe": false,
    "from_me": false,
    "source": "unknown",
    "message_id": "message_uuid",
    "internal_message_id": "message_uuid",
    "public_message_id": null,
    "external_message_id": "3EB012345678",
    "legacy_external_message_id": "59899123456@s.whatsapp.net:3EB012345678",
    "id": "3EB012345678",
    "msgId": "3EB012345678",
    "sid": "3EB012345678",
    "chat_id": "59899123456@s.whatsapp.net",
    "from": "59899123456",
    "from_jid": "59899123456@s.whatsapp.net",
    "fromPhone": "59899123456",
    "to": "59898765432",
    "to_jid": "59898765432:1@s.whatsapp.net",
    "toPhone": "59898765432",
    "body": "Hola",
    "type": "TEXT",
    "type_normalized": "chat",
    "internal_type": "TEXT",
    "timestamp": 1780000000,
    "timestamp_iso": "2026-05-27T10:13:20.000Z",
    "group_id": null,
    "participant": null,
    "participant_jid": null,
    "media_id": null,
    "media_url": null,
    "quoted_message": null,
    "quotedMsg": null
  }
}

instance_id es el UUID interno y instance_public_id es el identificador compatible con UltraMsg. En message.received, type y participant conservan valores historicos; use type_normalized y participant_jid para el contrato nuevo.

Payload de message.created:

{
  "event": "message.created",
  "timestamp": "2026-05-27T10:13:20.500Z",
  "tenant_id": "tenant_uuid",
  "instance_id": "internal_instance_uuid",
  "instance_public_id": "instanceff9104",
  "data": {
    "direction": "OUTBOUND",
    "fromMe": true,
    "from_me": true,
    "source": "manual",
    "message_id": "message_uuid",
    "internal_message_id": "message_uuid",
    "public_message_id": null,
    "external_message_id": "3EB0ABCDEF",
    "legacy_external_message_id": "59899123456@s.whatsapp.net:3EB0ABCDEF",
    "id": "3EB0ABCDEF",
    "msgId": "3EB0ABCDEF",
    "sid": "3EB0ABCDEF",
    "chat_id": "59899123456@s.whatsapp.net",
    "from": "59898765432",
    "from_jid": "59898765432:1@s.whatsapp.net",
    "fromPhone": "59898765432",
    "to": "59899123456",
    "to_jid": "59899123456@s.whatsapp.net",
    "toPhone": "59899123456",
    "body": "Respuesta manual",
    "type": "chat",
    "type_normalized": "chat",
    "internal_type": "TEXT",
    "timestamp": 1780000000,
    "timestamp_iso": "2026-05-27T10:13:20.000Z",
    "group_id": null,
    "participant": null,
    "participant_jid": null,
    "media_id": null,
    "media_url": null,
    "quoted_message": {
      "external_message_id": "QUOTED123",
      "chat_id": "59899123456@s.whatsapp.net",
      "participant": "59898765432@s.whatsapp.net",
      "fromMe": true,
      "body": "Mensaje anterior",
      "type": "chat"
    },
    "quotedMsg": { "id": "QUOTED123", "sid": "QUOTED123" }
  }
}

Las citas se extraen de contextInfo y se exponen como quoted_message y quotedMsg, incluso dentro de wrappers ephemeral, view-once y document-with-caption cuando Baileys entrega el contenido.

Payload de fallo outbound:

{
  "event": "message.failed",
  "timestamp": "2026-06-10T10:17:31.396Z",
  "tenant_id": "tenant_uuid",
  "instance_id": "internal_instance_uuid",
  "data": {
    "message_id": "message_uuid",
    "status": "FAILED",
    "error": "La instancia no está READY"
  }
}

message.processing, message.sent, message.delivered y message.read usan el mismo shape basico con message_id y status. En compatibilidad UltraMsg, FAILED se consulta como unsent y EXPIRED como expired.

Payload de llamada:

{
  "event": "call.received",
  "timestamp": "2026-06-10T18:45:00.000Z",
  "tenant_id": "tenant_uuid",
  "instance_id": "instance_uuid",
  "data": {
    "call_id": "call_id",
    "from": "59899123456",
    "from_jid": "59899123456@c.us",
    "status": "offer",
    "is_video": false,
    "is_group": false
  }
}

Los envios incluyen X-Waprime-Signature: sha256=<hex>, calculada con HMAC-SHA256 sobre el body HTTP crudo, X-Waprime-Event y X-Waprime-Delivery-Id. Compare la firma con una funcion timing-safe y no vuelva a serializar el JSON. El delivery ID permanece estable durante todos los reintentos.

webhook_retries indica reintentos posteriores al primero. El secreto es diferente del token de instancia, se devuelve una sola vez al crearlo o rotarlo y puede rotarse con POST /v1/webhooks/{webhook_id}/rotate-secret o desde el panel de instancia.

Respuestas y estados

Limites y seguridad

Errores

Soporte

Panel: https://waprime.click

API base: https://api.waprime.click

Swagger tecnico: https://api.waprime.click/docs

Health check: GET https://api.waprime.click/health (sin autenticacion)

Docs publicas: https://docs.waprime.click