POST /api/push/start

Crea un grupo de push y obtén su botón para unirse.

Envía la clave en el encabezado x-api-key. Crear un grupo nunca se factura. Los errores están en errores y límites.

Cuerpo

Campo	Tipo	Instrucciones
`group`	string	Obligatorio. El nombre del grupo que ve la gente en la app.
`pushGroupId`	string	Obligatorio. Cualquier texto que identifique el grupo. Lo usan todas las llamadas de envío y de marca.
`brand`	object	La marca del grupo. Ver abajo.
`reuse`	boolean	`true` le da a cada teléfono que se une su propia copia del grupo, para que cada teléfono registre el sitio web desde el que se ha unido. Los envíos llegan a todos los teléfonos en ambos casos.

El objeto brand

Campo	Tipo	Instrucciones
`logo`	string	URL de una imagen cuadrada. La imagen del grupo en cada notificación y en la app.
`name`	string	El nombre de la marca que se muestra en la app. Omítelo para no mostrar nombre de marca.
`description`	string	Una línea corta sobre el grupo, que se muestra en la app.

brand.color y brand.title son campos de actividades en directo. Los grupos de push los ignoran.

Ejemplo

curl -X POST https://api.webliveactivity.com/api/push/start \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: wla_your_key' \
  -d '{
  "group": "Acme Orders",
  "pushGroupId": "acme-orders",
  "reuse": true,
  "brand": {
    "name": "Acme",
    "logo": "https://acme.example/logo.webp",
    "description": "Order updates from Acme"
  }
}'

Respuesta

Responde 201. groupId es el id que usa el botón para unirse. Pon links.iframe en una página web; el botón funciona como el botón de lanzamiento, con los tipos de botón notify, subscribe y follow.

{
  "ok": true,
  "groupId": "pg-7hk3mzq2wd9x",
  "pushGroupId": "acme-orders",
  "links": {
    "iframe": "<iframe src=\"https://api.webliveactivity.com/embed/button?type=notify&userId=pg-7hk3mzq2wd9x\" width=\"340\" height=\"95\" style=\"border:0;color-scheme:light\"></iframe>"
  }
}

Notas

Cada inicio crea un botón para unirse nuevo. Iniciar de nuevo con el mismo pushGroupId añade otro botón al mismo grupo, y los envíos llegan a los teléfonos que se han unido por cualquiera de los dos.
Para cambiar el nombre o la marca después, usa POST /api/push/branding.
Los grupos de push no envían webhooks.