Parámetros de /createMessage

Obsoleto

/createMessage está obsoleto. Las nuevas integraciones deben usar la API de mensajería v2; consulte la guía de migración para una correspondencia campo por campo de los parámetros a continuación.

Aquí encontrará las descripciones de los parámetros de la API /createMessage.

• Parámetros obligatorios deben incluirse para enviar con éxito una solicitud a la API /createMessage y emitir una notificación push en el momento especificado.

• Parámetros opcionales le permiten personalizar las propiedades de las notificaciones push.

Nota

Si está utilizando /createMessage para enviar SMS, consulte Parámetros para enviar SMS. No se pasarán otros parámetros.

Parámetros obligatorios

Los parámetros obligatorios son de uso obligatorio en las solicitudes /createMessage. De lo contrario, la solicitud no se enviará.

application

Código único de una aplicación creada en su cuenta de Pushwoosh. El código de la aplicación se puede encontrar en la esquina superior izquierda del Panel de control o en la respuesta a una solicitud /createApplication. El código de la aplicación es un conjunto de 10 caracteres (letras y dígitos) separados por guiones.

Al crear una aplicación a través de la API, obtendrá un código de aplicación en respuesta a su solicitud /createApplication.

Para obtener un código de una aplicación creada previamente a través de la API, llame a /getApplications. En respuesta a la solicitud /getApplications, recibirá la lista de todas las aplicaciones creadas en su cuenta de Pushwoosh con sus nombres y códigos.

auth

Token de acceso a la API desde el Panel de control de Pushwoosh. Vaya a Configuración → Acceso a la API y copie el token que le gustaría usar o genere uno nuevo.

Al generar un token de acceso, especifique sus permisos. Marque las casillas de verificación para aquellos tipos de actividades con las que va a utilizar el token de la API. Puede crear tokens de API específicos de la aplicación marcando las casillas de verificación de Aplicaciones.

content

La cadena u objeto que define el contenido del mensaje. El parámetro “content” enviado con un valor de tipo cadena enviará el mismo mensaje a todos los destinatarios.

String

"content": "Hello world!",

Los objetos JSON se utilizan para especificar el contenido utilizando Contenido dinámico, por ejemplo, para mensajes en varios idiomas.

Object

"content": {
  "en": "Hello!",
  "es": "¡Hola!",
  "de": "Hallo!"
},

notifications

El array JSON de propiedades push. Debe incluir al menos los parámetros obligatorios content y send_date.

Parámetros opcionales para usar dentro del array “notifications”:

• campaign
• capping_days
• capping_count
• conditions
• data
• devices
• dynamic_content
• filter
• ignore_user_timezone
• inbox_date
• inbox_image
• link
• minimize_link
• message_type
• platforms
• preset
• rich_media
• send_rate
• timezone
• template_bindings
• transactionId
• users

send_date

Fecha y hora en que se envía el mensaje. Puede ser cualquier fecha y hora con el formato YYYY-MM-DD HH:mm o ‘now’. Si se establece en ‘now’, el mensaje se enviará inmediatamente después de enviar la solicitud.

Parámetros opcionales

campaign

El código de una Campaña. Para obtener un código de Campaña, vaya a Estadísticas → Estadísticas agregadas y seleccione la Campaña que va a utilizar. El código de la campaña será visible al final de la URL de la página en el formato XXXXX-XXXXX.

Ejemplo:

URL: https://app.pushwoosh.com/applications/AAAAA-AAAAA/statistics/aggregated-message?campaignCode=XXXXX-XXXXX

Código de campaña: XXXXX-XXXXX

Para obtener una lista de Campañas con sus códigos, llame a /getCampaigns. En respuesta a la solicitud /getCampaigns, recibirá la lista de todas las Campañas creadas para una aplicación en particular en su cuenta de Pushwoosh, con sus códigos, nombres y descripciones.

capping_days

Período que se aplicará para el límite de frecuencia, en días (máximo 30 días). Consulte Límite de frecuencia para más detalles.

El límite de frecuencia no se aplica a los mensajes con message_type: transactional. En todos los demás casos, se aplica el límite de frecuencia, incluidas las solicitudes en las que se omite message_type.

capping_count

El número máximo de pushes que se pueden enviar desde una aplicación específica a un dispositivo en particular dentro de un período de “capping_days”. En caso de que el mensaje creado exceda el límite de “capping_count” para un dispositivo, no se enviará a ese dispositivo. Consulte Límite de frecuencia para más detalles.

conditions

Las condiciones son arrays como [tagName, operator, operand] que se utilizan para enviar mensajes dirigidos basados en Tags y sus valores, donde:

• tagName — el nombre de un tag a aplicar,
• operator — un operador de comparación de valores (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
• operand — valores de Tag de cualquiera de los siguientes tipos: string | integer | array | date | boolean | list

Descripción del operador

EQ	el valor del tag es igual al operando.
IN	el valor del tag se cruza con el operando (el operando siempre debe ser un array).
NOTEQ	el valor del tag no es igual a un operando.
NOTIN	el valor del tag no se cruza con el operando (el operando siempre debe ser un array).
GTE	el valor del tag es mayor o igual que el operando.
LTE	el valor del tag es menor o igual que el operando.
BETWEEN	el valor del tag es mayor o igual que el valor mínimo del operando pero menor o igual que el valor máximo del operando (el operando siempre debe ser un array).
NOTSET	el tag no está establecido. No se considera el operando.
ANY	el tag tiene cualquier valor. No se considera el operando.

Tags de cadena

Operadores válidos: EQ, IN, NOTEQ, NOTIN, NOTSET, ANY

Operandos válidos:

EQ, NOTEQ	el operando debe ser una cadena
IN, NOTIN	el operando debe ser un array de cadenas como ["valor 1", "valor 2", "valor N"]
NOTSET	el tag no está establecido. No se considera el operando
ANY	el tag tiene cualquier valor. No se considera el operando

Tags de enteros

Operadores válidos: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

Operandos válidos:

EQ, NOTEQ, GTE, LTE	el operando debe ser un entero
IN, NOTIN	el operando debe ser un array de enteros como [valor 1, valor 2, valor N]
BETWEEN	el operando debe ser un array de enteros como [valor_min, valor_max]
NOTSET	el tag no está establecido. No se considera el operando
ANY	el tag tiene cualquier valor. No se considera el operando

Tags de fecha

Operadores válidos: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

Operandos válidos:

• "YYYY-MM-DD 00:00" (cadena)
• marca de tiempo unix 1234567890 (entero)
• "hace N días" (cadena) para los operadores EQ, BETWEEN, GTE, LTE

Tags booleanos

Operadores válidos: EQ, NOTSET, ANY

Operandos válidos: 0, 1, true, false

Tags de lista

Operadores válidos: IN, NOTIN, NOTSET, ANY

Operandos válidos: el operando debe ser un array de cadenas como ["valor 1", "valor 2", "valor N"].

Importante

Recuerde que los parámetros “filter” y “conditions” no deben usarse juntos. Además, ambos serán ignorados si el parámetro “devices” se utiliza en la misma solicitud.

Tags de país e idioma

El valor del tag de idioma es un código de dos letras en minúsculas según ISO-639-1. El valor del tag de país es un código de dos letras en MAYÚSCULAS según ISO_3166-2.

Por ejemplo, para enviar una notificación push a suscriptores de habla portuguesa en Brasil, deberá especificar la siguiente condición: "conditions": [["Country", "EQ", "BR"],["Language", "EQ", "pt"]]

conditions_operator

Operador lógico para los arrays de condiciones. Valores posibles: AND | OR. AND es el valor por defecto.

Si el operador aplicado es AND (cuando no se especifica ningún operador, o el parámetro ‘conditions_operator’ tiene el valor ‘AND’), los dispositivos que cumplan simultáneamente con todas las condiciones recibirán la notificación push.

Si el operador es OR, los dispositivos que cumplan con cualquiera de las condiciones especificadas recibirán el mensaje.

data

Cadena JSON u objeto JSON utilizado para pasar cualquier dato personalizado en la carga útil del push; se pasa como parámetro “u” en la carga útil (convertido a cadena JSON).

devices

El array de tokens push o HWIDs para enviar notificaciones push dirigidas. Si se establece, el mensaje solo se enviará a los dispositivos de la lista.

dynamic_content

Marcadores de posición para Contenido dinámico que se utilizarán en lugar de los valores de los Tags del dispositivo. El siguiente ejemplo enviará el mensaje “¡Hola, John!” a cada usuario al que se dirija. Si no se establece, los valores de Contenido dinámico se toman de los Tags del dispositivo.

"content": "Hello, {firstname|CapitalizeFirst}!",
"dynamic_content_placeholders": {
  "firstname": "John",
  "lastname": "Doe"
},

filter

El nombre de un Segmento exactamente como se creó en el Panel de control de Pushwoosh o mediante una solicitud a la API /createFilter. Vaya a la sección Audiencia → Segmentos y verifique la lista de Segmentos creados.

Para obtener la lista de Segmentos a través de la API, llame al método de la API /listFilters. En respuesta a la solicitud /listFilters, recibirá la lista de todos los Segmentos creados en su cuenta de Pushwoosh, con los nombres, condiciones y fechas de vencimiento de los Segmentos.

ignore_user_timezone

Si se establece en ‘true’, envía el mensaje a la hora y fecha especificadas en el parámetro “send_date” según UTC-0.

Si se establece en ‘false’, los usuarios recibirán el mensaje a la hora local especificada según la configuración de su dispositivo.

inbox_date

La fecha hasta la cual el mensaje debe mantenerse en la Bandeja de entrada de los usuarios. Si no se especifica, el mensaje se eliminará de la Bandeja de entrada al día siguiente de la fecha de envío.

Nota

Para guardar el mensaje en la Bandeja de entrada, utilice al menos uno de los parámetros ‘inbox’: “inbox_date” o “inbox_image”.

Precaución

El mensaje se eliminará de la Bandeja de entrada a las 00:00:01 de la fecha especificada, por lo que la fecha anterior es el último día en que un usuario puede ver el mensaje en su Bandeja de entrada.

inbox_image

La URL de la imagen personalizada que se mostrará junto al mensaje en la Bandeja de entrada.

Nota

Para guardar el mensaje en la Bandeja de entrada, utilice al menos uno de los parámetros ‘inbox’: “inbox_date” o “inbox_image”.

inbox_days

La vida útil de un mensaje de la bandeja de entrada en días, hasta 30 días. Después de este período, el mensaje se eliminará de la bandeja de entrada. Se puede usar en lugar del parámetro inbox_date.

link

La URL que se abrirá una vez que un usuario abra una notificación push.

message_type

Especifica el tipo de mensaje push. Los valores disponibles son marketing y transactional. Consulte Mensajes de marketing vs. transaccionales para más detalles.

Este parámetro es opcional. Si se omite, el mensaje se trata como transaccional y se entrega a todos, incluido el grupo de control. Los mensajes de marketing no se entregan a los miembros del grupo de control.

minimize_link

Acortador para minimizar la URL enviada en el parámetro “link”. Tenga en cuenta que el tamaño de la carga útil de la notificación push es limitado, así que considere crear URL cortas para no exceder el límite. Valores disponibles: 0 — no minimizar, 2 — bitly. Por defecto = 2. El acortador de URL de Google está deshabilitado desde el 30 de marzo de 2019.

platforms

El array de códigos de plataforma para enviar el mensaje solo a plataformas específicas.

Los códigos de plataforma disponibles incluyen: 1 — iOS, 3 — Android, 7 — Mac OS X, 8 — Windows, 9 — Amazon, 10 — Safari, 11 — Chrome, 12 — Firefox, 14 — Email, 17 — Huawei, 18 — SMS y 21 — WhatsApp.

preset

El código de un Preset creado en el Panel de control de Pushwoosh o a través de la API. Para obtener un código de preset, vaya a Contenido → Presets, expanda el preset que va a utilizar y copie el Código de Preset de los detalles del preset.

rich_media

El código de una página de In-Apps que va a adjuntar a su mensaje. Para obtener un código, vaya a Contenido → In-Apps, abra la página que va a utilizar y copie el código de la barra de URL de su navegador. El código es un conjunto de 10 caracteres (letras y dígitos) separados por guiones.

send_rate

Limitación para restringir la velocidad de envío de pushes. Los valores válidos son de 100 a 1000 pushes/segundo.

timezone

Zona horaria que se debe tener en cuenta cuando el mensaje se envía en una fecha y hora particulares. Si se establece, se ignora la zona horaria del dispositivo. Si se ignora, el mensaje se envía en UTC. Consulte https://php.net/manual/timezones.php para ver las zonas horarias admitidas.

template_bindings

Marcadores de posición de plantilla para usar en su plantilla de contenido. Consulte la guía de Plantillas Liquid para más detalles.

transactionId

Identificador de mensaje único para evitar la duplicación de mensajes en caso de problemas de red. Puede asignar cualquier ID a un mensaje creado a través de la solicitud /createMessage o /createTargetedMessage. Se almacena en el lado de Pushwoosh durante 5 minutos.

use_latest_user_device

Si se establece en true, entrega un push por usuario en lugar de uno por dispositivo: solo lo recibe el dispositivo con la Apertura de Aplicación más reciente entre las plataformas en platforms. Si ninguno de los dispositivos de un usuario en esas plataformas tiene esos datos, el primer dispositivo coincidente lo recibe en su lugar, por lo que el envío nunca se pierde. Los dispositivos sin un ID de usuario no se ven afectados. Se aplica independientemente de cómo se haya dirigido la audiencia, ya sea por users, filter o conditions. Funciona de la misma manera que use_latest_user_device en la API de mensajería v2. El valor predeterminado es false (enviar a todos los dispositivos).

users

El array de IDs de usuario. El ID de usuario es un identificador de usuario único establecido por una solicitud a la API /registerUser, /registerDevice o /registerEmail.