POST /api/push/send
Envía una notificación a todos los celulares de un grupo de push.
Cuerpo
| Campo | Tipo | Instrucciones |
|---|---|---|
pushGroupId | string | Obligatorio. El grupo al que se envía. |
title | string | La primera línea, en negrita. Envía un título, un mensaje o ambos. |
subtitle | string | La línea bajo el título. |
message | string | El texto del cuerpo. Envía un título, un mensaje o ambos. |
imageUrl | string | Una imagen que se muestra con la notificación. WebP, PNG o JPEG. |
actionURL | string | La página que abre un toque. Debe empezar con http:// o https://. Sin ella, un toque abre el grupo en la app. |
name | string | Una etiqueta para este mensaje en el registro del panel. Los celulares nunca la ven. |
Ejemplo
1 2 3 4 5 6 7 8 9 10 11 12
curl -X POST https://api.webliveactivity.com/api/push/send \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "pushGroupId": "acme-orders", "title": "Your order shipped!", "subtitle": "Order #1234", "message": "Your package is on the way. Expected delivery: tomorrow by 5 PM.", "imageUrl": "https://acme.example/shipped.webp", "actionURL": "https://acme.example/orders/1234", "name": "Shipping notice" }'
Respuesta
targeted es a cuántos celulares se envió la notificación. Es 0 cuando nadie se ha unido, y entonces no se factura nada.
1 2 3 4 5 6
{ "ok": true, "targeted": 42, "groupId": "pg-7hk3mzq2wd9x", "pushGroupId": "acme-orders" }
Entrega
- Los envíos salen de inmediato. No se combinan como las actualizaciones de actividades en vivo: dos envíos son dos notificaciones.
- Cada notificación genera una alerta en el celular. No hay envío silencioso.
- Un celular apagado la recibe cuando vuelve a encenderse, hasta 3 días después. El iPhone conserva solo la más reciente.
- Cada celular que la recibe cuenta como un envío push. Consulta entrega y facturación.
Errores
| Estado | Significado |
|---|---|
| 400 | Sin pushGroupId, sin title ni message, o un actionURL que no es http ni https. |
| 402 | FREE_TIER_LIMIT_REACHED: se agotaron los envíos push mensuales del plan gratis. Solo cuando alguien se ha unido. |
| 413 | La notificación supera los 4KB. Acorta el texto. |
Todos los demás errores están en errores y límites.
