Referencia de payload

Referencia para el mensaje Payload utilizado por Notify al enviar a través de cualquier canal que no sea correo electrónico (push, SMS, Telegram, Kakao, LINE, Viber, WhatsApp, Facebook Messenger).

Payload

preset (string): código del preset de push (formato XXXXX-XXXXX) para aplicar a este mensaje.
sms_preset (string): código (formato XXXXX-XXXXX) de un preset de SMS guardado. Su texto por configuración regional se resuelve en el sms.body de cada configuración regional. Un sms.body en línea para una configuración regional dada anula el preset para esa configuración regional. El preset debe pertenecer a la misma aplicación que el mensaje.
content (LocalizedContent): contenido del mensaje. Mutuamente exclusivo con silent.
silent (bool): enviar un push silencioso (solo datos) a todas las plataformas. Mutuamente exclusivo con content. Para que solo algunas plataformas sean silenciosas, establezca silent dentro de content para iOS o Android en su lugar.
custom_data (object): JSON de formato libre reenviado al SDK del cliente como el parámetro u. Los enteros muy grandes pueden perder precisión; consulte Enteros grandes en datos personalizados.
custom_data_raw (string): una cadena que contiene un objeto JSON, reenviada al SDK del cliente como el parámetro u. Los números que contiene conservan su valor exacto. Mutuamente exclusivo con un custom_data no vacío. Un valor no válido devuelve 400.
open_action (OpenAction): acción que se activa cuando el usuario abre la notificación.
open_actions (map<Platform, OpenAction>): anulación por plataforma de open_action. La clave es un valor numérico del enum Platform.
voip_push (bool): notificación VoIP de iOS.

{
  "payload": {
    "preset": "XXXXX-XXXXX",
    "content": { "localized_content": { "default": { "ios": { "title": "Hello", "body": "Tap to view" } } } },
    "custom_data": { "order_id": "42" },
    "open_action": { "link": { "url": "https://example.com/promo" } }
  }
}

Enteros grandes en datos personalizados

Los enteros mayores que 9007199254740992 pierden precisión en custom_data. Use custom_data_raw para conservarlos exactos.

custom_data es un google.protobuf.Struct (un objeto genérico similar a JSON). Almacena cada número como double, un número de punto flotante de 64 bits que solo es exacto para enteros de hasta 9007199254740992. Los enteros mayores se redondean: 5190090000030465245 llega al dispositivo como 5190090000030465000. Las cadenas no se ven afectadas.

Para conservar exactos esos enteros, envíe en custom_data_raw una cadena que contenga el objeto JSON:

{ "payload": { "silent": true, "custom_data_raw": "{\"pushUID\": 5190090000030465245}" } }

Reglas de custom_data_raw:

La cadena debe contener un objeto JSON. Un array, una cadena, null o un JSON no válido devuelven 400 (INVALID_ARGUMENT) con una infracción de campo en payload.custom_data_raw.
Si custom_data tiene alguna clave y se establece custom_data_raw, la solicitud devuelve 400. Un objeto custom_data vacío se ignora.
Al igual que custom_data, reemplaza los datos personalizados guardados en el preset de push.
El objeto se vuelve a convertir en texto JSON antes de la entrega. No se conserva el orden de las claves y se eliminan los espacios en blanco. Los números conservan su valor exacto, pero el texto original no se conserva byte a byte.
En /messaging/v2/notify/batch, un custom_data_raw no válido solo hace fallar su propio elemento. Los demás elementos se envían.

Cómo se envía la solicitud:

REST: no se necesitan cambios para /messaging/v2/notify ni /messaging/v2/notify/batch. Si custom_data contiene un entero que un double no puede representar con exactitud, la API lo conserva sin pérdida automáticamente. Aun así, puede establecer custom_data_raw explícitamente.
gRPC: el cliente construye el Struct por sí mismo, por lo que la precisión se pierde antes de enviar la solicitud. Rellene custom_data_raw en lugar de custom_data.

Dónde se entrega la notificación:

Android: el SDK pasa u a la aplicación como una cadena a través de PushMessage.getCustomData(), por lo que se conservan todos los dígitos.
Web push: el Web SDK analiza u con JSON.parse, y todo número de JavaScript es un double. Los enteros grandes se redondean en el navegador independientemente de la API, así que páselos como cadenas.
Windows: la notificación toast recibe los mismos datos u que las demás plataformas, y los enteros enviados a través de custom_data_raw llegan exactos.

LocalizedContent

Mapea el código de la configuración regional → contenido por plataforma. Las claves son códigos de dos letras ISO 639-1 (por ejemplo, "en", "es") más la clave especial "default" para una traducción general. Las excepciones a ISO 639-1 son "zh-Hant" y "zh-Hans" para chino tradicional y simplificado.

{
  "localized_content": {
    "default": {
      "ios":     { "title": "Hello", "body": "Tap to view" },
      "android": { "title": "Hello", "body": "Tap to view" }
    },
    "es": {
      "ios":     { "title": "Hola",  "body": "Toca para ver" },
      "android": { "title": "Hola",  "body": "Toca para ver" }
    }
  }
}

Selección de la configuración regional para un dispositivo

El contenido entregado a un dispositivo se elige en este orden:

Coincidencia exacta con el idioma del dispositivo.
Clave "default".
Clave "en".
Cualquier otra configuración regional presente en el mapa.

Proporciona al menos uno de "default" o "en" para que cada dispositivo tenga una alternativa determinista. Si no esperas variantes por configuración regional, envía solo "default".

Cada entrada de configuración regional es un objeto Content con bloques opcionales por plataforma. Solo rellena las plataformas a las que te diriges.

Bloque de plataforma	Canal
`ios`	Push de iOS
`android`	Push de Android (FCM)
`huawei_android`	Push de Huawei Android
`mac_os`	Push de macOS
`amazon`	Push de Amazon (ADM)
`safari`	Push web de Safari
`chrome`	Push web de Chrome
`firefox`	Push web de Firefox
`ie`	Push web de Internet Explorer
`windows`	Push de Windows (tile / toast / badge)
`telegram`	Mensaje de Telegram
`kakao`	Mensaje de Kakao
`line`	Mensaje de LINE
`viber`	Mensaje de Viber
`whatsapp`	Mensaje de WhatsApp
`fb_messenger`	Mensaje de Facebook Messenger
`sms`	Mensaje SMS

Botones

Cada entrada de idioma también puede incluir buttons, hasta 3 botones de acción que se muestran debajo del push en iOS, Android y Huawei. Las demás plataformas los ignoran. Los botones requieren iOS SDK 7.2.10 o posterior con una Notification Service Extension, y Android SDK 6.17.0 o posterior.

Cada PushButton tiene estos campos:

id (string): el ID del botón que su aplicación recibe al tocarlo. Hasta 64 caracteres, sin espacios, único dentro del push. Obligatorio para ACTION_OPEN y ACTION_CUSTOM. Si lo omite para otras acciones, Pushwoosh asigna btn_1, btn_2, etc.
label (string): el texto del botón, de 1 a 64 caracteres.
action (enum): ACTION_OPEN abre la aplicación, ACTION_URL abre url, ACTION_DEEPLINK abre un deep link, ACTION_CUSTOM pasa id a su aplicación, y su aplicación lo gestiona.
url (string): una dirección http o https absoluta para ACTION_URL, o un deep link con esquema para ACTION_DEEPLINK.
platform_urls (map): un deep link por plataforma para ACTION_DEEPLINK, con el código de plataforma como clave: 1 iOS, 3 Android, 17 Huawei.
style (enum): STYLE_DEFAULT o STYLE_DESTRUCTIVE. El estilo destructivo muestra el botón en rojo en iOS.

{
  "localized_content": {
    "default": {
      "ios": { "title": "Your order is on its way", "body": "Arrives tomorrow" },
      "android": { "title": "Your order is on its way", "body": "Arrives tomorrow" },
      "buttons": [
        { "id": "track", "label": "Track order", "action": "ACTION_DEEPLINK", "url": "myapp://orders/42" },
        { "id": "cancel", "label": "Cancel order", "action": "ACTION_CUSTOM", "style": "STYLE_DESTRUCTIVE" }
      ]
    }
  }
}

Campos comunes de push

Estos campos son compartidos por los bloques ios, android, huawei_android, mac_os, amazon, safari, chrome y firefox (el soporte varía. Los campos no utilizados son ignorados por la plataforma correspondiente).

title (string): título de la notificación.
body (string): cuerpo de la notificación.
time_to_live (duration, p. ej. "3600s"): cuánto tiempo el servidor de push debe retener la notificación para un dispositivo sin conexión.
sound (string): nombre del archivo de sonido.
sound_enabled (bool): activar o suprimir el sonido.
badges (string): conteo de la insignia (iOS) o análogo.
root_params (object): anulaciones de payload crudas específicas de la plataforma.
inbox (Inbox): entrada en el Buzón de Mensajes.

{
  "android": {
    "title": "Hello",
    "body": "Tap to view",
    "time_to_live": "3600s",
    "sound": "default",
    "sound_enabled": true,
    "badges": "+1"
  }
}

iOS (`ios`)

subtitle (string): subtítulo de la notificación de iOS.
is_critical (bool): alerta crítica (requiere autorización).
attachment (string): URL de un archivo adjunto multimedia.
thread_id (string): identificador de hilo para notificaciones agrupadas.
trim_content (bool): recortar el contenido para que quepa.
category_id (string): identificador UNNotificationCategory para acciones interactivas.
interruption_level (string): passive, active, time-sensitive o critical.
collapse_id (string): identificador de colapso de APNs. Las notificaciones con el mismo collapse_id se reemplazan entre sí en el dispositivo.
silent (bool): enviar el push de iOS como silencioso (solo datos), mientras que las demás plataformas del mismo mensaje reciben una notificación normal. Se establece dentro de content, por lo que funciona junto con él. Para que todas las plataformas sean silenciosas, use en su lugar el silent de nivel superior, que reemplaza a content. Establézcalo en cualquier configuración regional para aplicarlo a todas las configuraciones regionales.

{
  "ios": {
    "title": "Hello",
    "body": "Tap to view",
    "subtitle": "New update",
    "attachment": "https://cdn.example.com/image.png",
    "interruption_level": "active",
    "thread_id": "promo"
  }
}

Android (`android`, `huawei_android`)

icon (string): icono pequeño de la notificación.
banner (string): URL de imagen grande.
delivery_priority (NORMAL | HIGH): prioridad de entrega de FCM.
vibration (bool): vibración al recibir.
led_color (string, hex): color del LED de notificación.
icon_background_color (string, hex): color de fondo del icono.
show_on_lockscreen (bool): mostrar en la pantalla de bloqueo.
custom_icon (string): URL de un icono personalizado.
priority (NotificationPriority): prioridad en la bandeja.
group_id (string): clave del grupo de notificaciones.
collapse_key (string): clave de colapso de FCM. Las notificaciones con la misma collapse_key se reemplazan entre sí mientras el dispositivo está sin conexión.
silent (bool): enviar el push a esta plataforma como silencioso (solo datos), mientras que las demás plataformas del mismo mensaje reciben una notificación normal. Se establece dentro de content, por lo que funciona junto con él. Para que todas las plataformas sean silenciosas, use en su lugar el silent de nivel superior, que reemplaza a content. Establézcalo en cualquier configuración regional para aplicarlo a todas las configuraciones regionales. El bloque baidu_android también acepta silent, con el mismo comportamiento.

{
  "android": {
    "title": "Hello",
    "body": "Tap to view",
    "icon": "ic_notification",
    "banner": "https://cdn.example.com/banner.png",
    "led_color": "#FF0000",
    "priority": "PRIORITY_HIGH",
    "delivery_priority": "HIGH"
  }
}

macOS (`mac_os`)

Usa los campos comunes de push más subtitle y action (URL que se abre cuando el usuario hace clic en la notificación).

{
  "mac_os": {
    "title": "Hello",
    "body": "Tap to view",
    "subtitle": "New update",
    "action": "https://example.com/promo"
  }
}

Amazon (`amazon`)

Usa los campos comunes de push más custom_icon y priority (NotificationPriority).

{
  "amazon": {
    "title": "Hello",
    "body": "Tap to view",
    "custom_icon": "https://cdn.example.com/icon.png",
    "priority": "PRIORITY_HIGH"
  }
}

Safari (`safari`)

action (string): URL que se abre cuando el usuario hace clic en la notificación.
url_arguments (array of string): argumentos de URL de Safari sustituidos en la plantilla de URL de Web Push.

{
  "safari": {
    "title": "Hello",
    "body": "Tap to view",
    "action": "https://example.com/promo",
    "url_arguments": ["promo", "2026"]
  }
}

Chrome (`chrome`)

icon, image (string): URLs de icono pequeño e imagen grande.
duration (duration): temporizador de cierre automático.
button_text1 / button_url1, button_text2 / button_url2: hasta dos botones de acción.

{
  "chrome": {
    "title": "Hello",
    "body": "Tap to view",
    "icon": "https://cdn.example.com/icon.png",
    "image": "https://cdn.example.com/banner.png",
    "duration": "20s",
    "button_text1": "Open",
    "button_url1": "https://example.com/promo"
  }
}

Firefox (`firefox`)

Usa solo title, body, icon, root_params e inbox.

{
  "firefox": {
    "title": "Hello",
    "body": "Tap to view",
    "icon": "https://cdn.example.com/icon.png"
  }
}

Windows (`windows`)

Windows usa una forma diferente:

{
  "windows": {
    "type": "TOAST",
    "template": { "title": "Hello", "body": "Tap to view" },
    "tag": "promo",
    "cache": true,
    "time_to_live": "3600s"
  }
}

type es TILE, TOAST o BADGE.
template (estructurado) o raw ({ "content": "<raw xml>" }) — exactamente uno.

Telegram (`telegram`)

body (string): texto del mensaje.
content_variables (string): variables en formato de cadena JSON para la plantilla del lado del bot.

{
  "telegram": {
    "body": "Hello from Pushwoosh",
    "content_variables": "{\"name\":\"John\"}"
  }
}

Kakao (`kakao`)

content (string): contenido del mensaje.
template (string): código de plantilla aprobado.
content_variables (string): vinculaciones de variables de plantilla en formato de cadena JSON.

{
  "kakao": {
    "content": "Hello from Pushwoosh",
    "template": "welcome_v1",
    "content_variables": "{\"name\":\"John\"}"
  }
}

LINE (`line`)

content (string): cuerpo de texto sin formato.
template (string): código de una plantilla de LINE configurada en el Panel de Control de Pushwoosh (utilizada para enviar mensajes de imagen, carrusel o flexibles). Para contenido enriquecido, preconfigura la plantilla en el Panel de Control y haz referencia a ella aquí.

Se debe establecer al menos uno de content o template.

{
  "line": {
    "content": "Hello from Pushwoosh",
    "template": "promo_carousel"
  }
}

Viber (`viber`)

Un mensaje de Viber es un cuerpo de texto libre, opcionalmente con una imagen y un botón o con un carrusel, o una plantilla transaccional preaprobada (Omni Messaging / MStat) a la que se hace referencia por id e idioma.

body (string): mensaje de texto sin formato. Requerido cuando no se establece template_id, a menos que se establezca image. Requerido con un botón o un carrusel.
image (string): URL pública de la imagen. Se ignora cuando se establece template_id.
button_caption (string): texto del botón, hasta 30 caracteres. Se establece junto con button_action. Requiere body. Se ignora cuando se establece template_id.
button_action (string): enlace del botón: una URL http:// o https://, un deep link viber:// o un token de Omni como {lp-100} (un marcador de posición de enlace de seguimiento que Omni Messaging resuelve en el momento del envío). Se establece junto con button_caption.
carousel (object): de 2 a 5 tarjetas deslizables que se muestran debajo de body. No se puede combinar con image, button_caption, button_action ni template_id. Consulte Carrusel.
template_id (string): id de una plantilla transaccional preaprobada. Cuando se establece, tiene prioridad sobre body.
template_lang (string): configuración regional de la plantilla. Requerido cuando se establece template_id.
template_params (map<string, string>): vinculaciones de clave/valor sustituidas en la plantilla, p. ej. { "name": "John", "code": "123456" }.
all_devices (bool): false (predeterminado) entrega solo al dispositivo principal del usuario; true entrega a todos los dispositivos del usuario.

Se debe establecer al menos uno de body, image o template_id. Cuando se establece template_id, se requiere template_lang.

Dirige a los destinatarios de Viber como hwids en el formato viber:<teléfono> (E.164), por ejemplo viber:+1234567890.

Texto sin formato:

{
  "viber": {
    "body": "Hello from Pushwoosh"
  }
}

Plantilla transaccional:

{
  "viber": {
    "template_id": "e3dec4a0-c063-4b0f-96d5-cf9d629a7abe",
    "template_lang": "en",
    "template_params": {
      "name": "John",
      "code": "123456",
      "expires_in": "5 minutes"
    },
    "all_devices": false
  }
}

Carrusel

carousel.items contiene de 2 a 5 tarjetas. Para configurar un carrusel en un journey, consulte Enviar un carrusel. Cada tarjeta tiene estos campos:

title (string): título de la tarjeta, de 2 a 38 caracteres. Requerido.
image (string): URL pública de la imagen http:// o https://. Requerido.
primary_button (object): botón principal. Requerido.
secondary_button (object): segundo botón. Opcional.

Cada botón tiene dos campos, y ambos son obligatorios cuando el botón está presente:

caption (string): texto del botón, hasta 10 caracteres para primary_button y hasta 12 para secondary_button.
action (string): enlace del botón: una URL con esquema (http://, https://, viber://) o un token de Omni como {lp-100}, los mismos valores que button_action.

Una solicitud que incumple cualquiera de estas reglas se rechaza con INVALID_ARGUMENT. El detalle google.rpc.BadRequest indica el campo, por ejemplo viber.carousel.items[0].title.

Ejemplo:

{
  "viber": {
    "body": "New arrivals are in. Swipe to see them.",
    "carousel": {
      "items": [
        {
          "title": "Running shoes",
          "image": "https://example.com/img/shoes.jpg",
          "primary_button": { "caption": "Buy now", "action": "https://example.com/shoes" },
          "secondary_button": { "caption": "Details", "action": "{lp-100}" }
        },
        {
          "title": "Sports backpack",
          "image": "https://example.com/img/backpack.jpg",
          "primary_button": { "caption": "Buy now", "action": "https://example.com/backpack" }
        }
      ]
    }
  }
}

WhatsApp (`whatsapp`)

Los mensajes de WhatsApp pasan por Meta y están sujetos a las reglas de mensajería de Meta. La división clave es entre el texto de formato libre (solo se entrega dentro de la ventana de servicio al cliente de 24 horas abierta por un mensaje entrante del usuario) y las plantillas aprobadas (requeridas para la iniciación saliente y para cualquier mensaje fuera de la ventana de 24 horas).

content (string): texto del mensaje de formato libre. Entregado por Meta solo dentro de la ventana de 24 horas.
content_id (string): nombre de una plantilla de Meta preaprobada (p. ej. "hello_world"). Requerido para la iniciación saliente o cualquier mensaje fuera de la ventana de 24 horas.
language (string): configuración regional de la plantilla que debe coincidir exactamente con la configuración regional aprobada en Meta (p. ej. "en_US", "en_GB"). Solo tiene sentido junto con content_id. Esto es independiente de la clave externa LocalizedContent. La clave externa selecciona el contenido para un dispositivo, y language selecciona la configuración regional de la plantilla de Meta para ese contenido.
content_variables (string): objeto JSON que mapea los marcadores de posición del cuerpo, p. ej. "{\"1\":\"John\"}".
button_url_variables (string): objeto JSON que mapea los marcadores de posición de la URL del botón con clave por índice de botón, p. ej. "{\"0\":\"https://...\"}".
header_variables (string): objeto JSON que mapea los marcadores de posición del encabezado con clave por tipo, p. ej. "{\"image\":\"https://...\"}".

Se debe establecer al menos uno de content o content_id.

{
  "whatsapp": {
    "content_id": "hello_world",
    "language": "en_US",
    "content_variables": "{\"1\":\"John\"}"
  }
}

Facebook Messenger (`fb_messenger`)

Los mensajes de Facebook Messenger pasan por Meta y están sujetos a las reglas de mensajería de Meta: el contenido de formato libre solo se entrega dentro de la ventana de servicio al cliente de 24 horas abierta por un mensaje entrante del usuario. Fuera de esa ventana, establece message_tag en uno de los casos de uso aprobados por Meta, o Meta rechazará el envío.

body (string): mensaje de texto sin formato. Requerido a menos que se establezca message.
message (string): un objeto message completo de la Meta Send API como cadena JSON, con texto, archivos adjuntos, plantillas o respuestas rápidas. Cuando se establece, Pushwoosh lo envía en lugar de body.
message_tag (string): requerido fuera de la ventana de 24 horas. Uno de CONFIRMED_EVENT_UPDATE, POST_PURCHASE_UPDATE, ACCOUNT_UPDATE, HUMAN_AGENT.

{
  "fb_messenger": {
    "body": "Hello from Pushwoosh",
    "message_tag": "ACCOUNT_UPDATE"
  }
}

Para este canal no hay un identificador de dispositivo separado: hwid, push_token y user_id se resuelven todos al mismo valor, el ID de Alcance de Página (PSID) de Meta del destinatario. Dirígete a una conversación específica con cualquiera de ellos en NotifyTransactional.

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transactional": {
      "application": "XXXXX-XXXXX",
      "platforms": ["FB_MESSENGER"],
      "hwids": { "list": ["<recipient-psid>"] },
      "payload": {
        "content": {
          "localized_content": {
            "default": {
              "fb_messenger": { "body": "Hello from Pushwoosh" }
            }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" }
    }
  }'

SMS (`sms`)

SMS tiene su propio bloque de plataforma dentro del Content de cada configuración regional, junto con ios, android y los otros canales de mensajería.

body (string): texto del SMS para la configuración regional. Requerido cuando el bloque sms está presente.

Hay dos maneras de proporcionar el texto:

En línea — establece sms.body por configuración regional en localized_content.
Desde un preset — establece el sms_preset a nivel de payload al código (formato XXXXX-XXXXX) de un preset de SMS guardado. Su contenido por configuración regional se resuelve en sms.body para cada configuración regional que el preset define. Un sms.body en línea para una configuración regional anula el preset para esa configuración regional, por lo que puedes reutilizar un preset y aun así ajustar idiomas individuales.

{
  "payload": {
    "sms_preset": "XXXXX-XXXXX",
    "content": {
      "localized_content": {
        "default": { "sms": { "body": "Your order has shipped." } },
        "es":      { "sms": { "body": "Tu pedido ha sido enviado." } }
      }
    }
  }
}

MMS

Añadir subject y file_urls a un bloque sms convierte el mensaje en un MMS. Solo AbleMobile tiene un punto final de MMS — otros proveedores de SMS ignoran ambos campos y entregan solo el body de texto sin formato.

subject (string): asunto del MMS. Requiere al menos una entrada en file_urls — un asunto sin archivos adjuntos es rechazado. Hasta 40 caracteres ASCII, o 13 caracteres si el asunto contiene caracteres no ASCII.
file_urls (array of string): hasta 3 URLs de archivos adjuntos. Cada una debe ser una URL https absoluta que termine en .jpg o .gif — .jpeg y .png son rechazados por la validación, incluso para un archivo JPEG o PNG genuino, porque el proveedor no puede decodificarlos. Cada archivo también debe ser de 200 KB o menos; AbleMobile rechaza todo el envío si algún archivo adjunto es más pesado.
message_at (int): índice en file_urls (base 0) después del cual se muestra el texto del cuerpo del SMS.

subject y file_urls admiten la personalización Liquid, al igual que body.

{
  "sms": {
    "body": "Your order has shipped.",
    "subject": "Order update",
    "file_urls": [
      "https://cdn.example.com/shipping-label.jpg",
      "https://cdn.example.com/tracking-map.gif"
    ],
    "message_at": 1
  }
}

RCS

Añadir rcs a un bloque sms envía una plantilla de contenido de Twilio por RCS (Rich Communication Services) en lugar de body. Twilio entrega la plantilla como un mensaje RCS y, como alternativa, envía un SMS creado a partir del tipo twilio/text de la plantilla, no a partir de body. Una plantilla sin el tipo twilio/text solo llega a los teléfonos compatibles con RCS.

rcs.content_sid (string): SID de la plantilla de contenido de Twilio, HX seguido de 32 caracteres hexadecimales. Obténgalo con ListRcsTemplates o en la Twilio Console.
rcs.content_variables (string): objeto JSON con las variables de la plantilla, serializado como cadena, por ejemplo "{\"1\": \"{FirstName|CapitalizeFirst|there}\"}". Los valores admiten etiquetas y personalización Liquid. Una variable que omita toma el valor predeterminado de la plantilla.

body sigue siendo obligatorio en un bloque sms con rcs.

La solicitud se rechaza a menos que la aplicación envíe SMS a través de Twilio con su propio Account SID, Auth token y Messaging Service SID configurados en la configuración de la plataforma SMS. Una aplicación que usa credenciales de Twilio proporcionadas por Pushwoosh no puede enviar RCS.

Un preset de SMS puede incluir una plantilla por configuración regional. Con sms_preset en el payload, la plantilla del preset se usa para cada configuración regional en la que la solicitud no aporta su propio rcs.content_sid.

{
  "sms": {
    "body": "Your order has shipped.",
    "rcs": {
      "content_sid": "HXb5b62575e6e4ff6129ad7c8efe1f983e",
      "content_variables": "{\"1\": \"{FirstName|CapitalizeFirst|there}\", \"2\": \"A-1042\"}"
    }
  }
}

Listar plantillas RCS

ListRcsTemplates devuelve las plantillas de contenido de Twilio de la aplicación que se pueden enviar por RCS, leídas con las propias credenciales de Twilio de la aplicación.

GET https://rpc-api.svc-nue.pushwoosh.com/api/sms_presets:rcs_templates?application=XXXXX-XXXXX
Authorization: Api YOUR_API_TOKEN

application (string, query): código de la aplicación, formato XXXXX-XXXXX.

La respuesta contiene un array templates. Solo se incluyen las plantillas con al menos un tipo de contenido RCS: twilio/card, twilio/carousel, twilio/quick-reply, twilio/call-to-action o twilio/media.

Campo	Tipo	Descripción
`content_sid`	string	SID de la plantilla, el valor para `rcs.content_sid`.
`friendly_name`	string	Nombre de la plantilla en Twilio.
`language`	string	Código de idioma de la plantilla.
`types`	array of string	Tipos de contenido de Twilio que define la plantilla, por ejemplo `twilio/card` y `twilio/text`.
`variables`	object	Variables de la plantilla con sus valores predeterminados.
`has_sms_fallback`	boolean	`true` cuando la plantilla tiene un tipo `twilio/text`, el SMS que recibe un teléfono sin RCS.

{
  "templates": [
    {
      "content_sid": "HXb5b62575e6e4ff6129ad7c8efe1f983e",
      "friendly_name": "order_shipped_card",
      "language": "en",
      "types": ["twilio/card", "twilio/text"],
      "variables": { "1": "there", "2": "your order" },
      "has_sms_fallback": true
    }
  ]
}

ListRcsTemplates devuelve estos errores:

Estado HTTP	Causa
`400 Bad Request`	La aplicación no tiene su propio Account SID ni Auth token de Twilio (`FailedPrecondition`).
`401 Unauthorized`	Twilio rechazó las credenciales de la aplicación (`Unauthenticated`).
`503 Service Unavailable`	La Twilio Content API devolvió otro error (`Unavailable`).

OpenAction

Define la acción que se realiza cuando el usuario abre el mensaje.

Exactamente uno de:

rich_media (RichMedia): abrir una página de Rich Media.
deep_link: abrir un deep link: { "code": "flow-code", "params": { "key": "value" } }.
link (Link): abrir una URL.

{
  "open_action": {
    "deep_link": { "code": "flow-code", "params": { "promo": "summer" } }
  }
}

La URL del deeplink y los valores de params admiten la sintaxis de personalización Liquid — las expresiones se resuelven antes de que se abra el deep link.

RichMedia

{ "code": "XXXXX-XXXXX" }        // por código de Rich Media
{ "url":  "https://..." }        // por URL remota

Link

{
  "url": "https://example.com/promo",
  "shortener": "BITLY"
}

shortener es NONE (predeterminado) o BITLY.

Inbox

Configura cómo aparece el mensaje en el Buzón de Mensajes.

{
  "image_url": "https://cdn.example.com/inbox.png",
  "expiration_date": "2026-05-15T00:00:00Z"
}

image_url (string): imagen que se muestra en la entrada del buzón.
expiration_date (timestamp): cuándo se elimina la entrada del buzón.
expires_in (duration, p. ej. "604800s"): cuánto tiempo permanece la entrada en el buzón, contado desde la fecha de envío (el send_date programado o el momento de la solicitud en los envíos inmediatos). Debe ser positivo. Se ignora si se establece expiration_date.

Para establecer una vida útil relativa en lugar de una fecha fija, envíe solo expires_in:

{
  "image_url": "https://cdn.example.com/inbox.png",
  "expires_in": "604800s"
}

Si su cuenta tiene una vida útil máxima en el buzón, se rechaza un expiration_date o expires_in que la supere.

Enum NotificationPriority

Controla la prioridad de la notificación en el dispositivo de destino, desde PRIORITY_MIN (la más baja) hasta PRIORITY_MAX (la más alta).

PRIORITY_UNSPECIFIED
PRIORITY_MIN
PRIORITY_LOW
PRIORITY_DEFAULT
PRIORITY_HIGH
PRIORITY_MAX

Ejemplo: Enviar un push a un segmento

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "code": "active_users",
      "payload": {
        "content": {
          "localized_content": {
            "en": {
              "ios":     { "title": "Hello",   "body": "Hello, world!" },
              "android": { "title": "Hello",   "body": "Hello, world!" }
            },
            "es": {
              "ios":     { "title": "¡Hola!",  "body": "¡Hola, mundo!" },
              "android": { "title": "¡Hola!",  "body": "¡Hola, mundo!" }
            }
          }
        },
        "open_action": { "link": { "url": "https://example.com/promo" } }
      },
      "schedule":     { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

Ejemplo: Push transaccional por ID de usuario

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transactional": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "users": { "list": ["customer-42"] },
      "payload": {
        "content": {
          "localized_content": {
            "default": {
              "ios":     { "title": "Your order", "body": "Order #42 has shipped." },
              "android": { "title": "Your order", "body": "Order #42 has shipped." }
            }
          }
        },
        "custom_data": { "order_id": "42" }
      },
      "schedule":     { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_TRANSACTIONAL"
    }
  }'

Referencia de payload

Payload

Enteros grandes en datos personalizados

LocalizedContent

Selección de la configuración regional para un dispositivo

Botones

Campos comunes de push

iOS (ios)

Android (android, huawei_android)

macOS (mac_os)

Amazon (amazon)

Safari (safari)

Chrome (chrome)

Firefox (firefox)

Windows (windows)

Telegram (telegram)

Kakao (kakao)

LINE (line)

Viber (viber)