Parámetros de /createMessage

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

• Los parámetros obligatorios deben incluirse para enviar con éxito una solicitud a la API /createMessage y emitir una notificación push a la hora especificada.

• Los 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 deben utilizarse 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 (tanto letras como 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 Settings → API Access y copie un token que desee utilizar 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 los 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 para todos los destinatarios.

String

"content": "Hello world!",

Los objetos JSON se utilizan para especificar el contenido utilizando Contenido Dinámico, por ejemplo, para mensajes multilingües.

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
• 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 AAAA-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 Statistics → Aggregated statistics 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 frequency capping, en días (máximo 30 días). Consulte Frequency capping para más detalles.

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 Frequency capping 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 una etiqueta 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 de la etiqueta es igual al operando.
IN	el valor de la etiqueta se cruza con el operando (el operando siempre debe ser un array).
NOTEQ	el valor de la etiqueta no es igual a un operando.
NOTIN	el valor de la etiqueta no se cruza con el operando (el operando siempre debe ser un array).
GTE	el valor de la etiqueta es mayor o igual que el operando.
LTE	el valor de la etiqueta es menor o igual que el operando.
BETWEEN	el valor de la etiqueta 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	la etiqueta no está establecida. El operando no se considera.
ANY	la etiqueta tiene cualquier valor. El operando no se considera.

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 ["value 1", "value 2", "value N"]
NOTSET	la etiqueta no está establecida. El operando no se considera
ANY	la etiqueta tiene cualquier valor. El operando no se considera

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 [value 1, value 2, value N]
BETWEEN	el operando debe ser un array de enteros como [min_value, max_value]
NOTSET	la etiqueta no está establecida. El operando no se considera
ANY	la etiqueta tiene cualquier valor. El operando no se considera

Tags de fecha

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

Operandos válidos:

• "AAAA-MM-DD 00:00" (cadena)
• marca de tiempo unix 1234567890 (entero)
• "N days ago" (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 ["value 1", "value 2", "value 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 de la etiqueta de idioma es un código de dos letras en minúsculas según ISO-639-1. El valor de la etiqueta 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 predeterminado.

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 el payload del push; se pasa como parámetro “u” en el payload (convertido a cadena JSON).

devices

El array de push tokens 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 las etiquetas 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 las etiquetas 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 a través de una solicitud a la API /createFilter. Vaya a la sección Audience → Segments 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 el Inbox de los usuarios. Si no se especifica, el mensaje se eliminará del Inbox al día siguiente de la fecha de envío.

Nota

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

Precaución

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

inbox_image

La URL de la imagen personalizada que se mostrará junto al mensaje en el Inbox.

Nota

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

inbox_days

El tiempo de vida de un mensaje de inbox en días, hasta 30 días. Después de este período, el mensaje se eliminará del inbox. 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.

minimize_link

Acortador para minimizar la URL enviada en el parámetro “link”. Tenga en cuenta que el tamaño del payload 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. Predeterminado = 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 Content → Presets, expanda el preset que va a utilizar y copie el Preset Code de los detalles del preset.

rich_media

El código de una página de Rich Media que va a adjuntar a su mensaje. Para obtener un código, vaya a Content → Rich Media, abra una página de Rich Media que vaya a utilizar y copie el código de la barra de URL de su navegador. El código es un conjunto de 10 caracteres (tanto letras como 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 tendrá en cuenta cuando el mensaje se envíe 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.

users

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