Parâmetros de /createMessage

Aqui você encontrará as descrições dos parâmetros da API /createMessage.

• Parâmetros obrigatórios devem ser incluídos para enviar com sucesso uma solicitação à API /createMessage e transmitir uma notificação push no horário especificado.

• Parâmetros opcionais permitem que você personalize as propriedades da notificação push.

Nota

Se você estiver usando /createMessage para enviar SMS, consulte Parâmetros para envio de SMS. Outros parâmetros não serão passados.

Parâmetros obrigatórios

Parâmetros obrigatórios são de uso obrigatório nas solicitações /createMessage. Caso contrário, a solicitação não será enviada.

application

Código único de um aplicativo criado em sua conta Pushwoosh. O código do aplicativo pode ser encontrado no canto superior esquerdo do Painel de Controle ou na resposta a uma solicitação /createApplication. O código do aplicativo é um conjunto de 10 caracteres (letras e dígitos) separados por hífen.

Ao criar um aplicativo via API, você receberá um código de aplicativo na resposta à sua solicitação /createApplication.

Para obter um código de um aplicativo criado anteriormente via API, chame /getApplications. Em resposta à solicitação /getApplications, você receberá a lista de todos os aplicativos criados em sua conta Pushwoosh com seus nomes e códigos.

auth

Token de acesso à API do Painel de Controle da Pushwoosh. Vá para Configurações → Acesso à API e copie um token que você gostaria de usar ou gere um novo.

Ao gerar um token de acesso, especifique suas permissões. Marque as caixas de seleção para os tipos de atividades com as quais você usará o token da API. Você pode criar tokens de API específicos do aplicativo marcando as caixas de seleção de Aplicativos.

content

A string ou objeto que define o conteúdo da mensagem. O parâmetro “content” enviado com um valor do tipo string enviará a mesma mensagem para todos os destinatários.

String

"content": "Hello world!",

Objetos JSON são usados para especificar o conteúdo usando Conteúdo Dinâmico, por exemplo, para mensagens em vários idiomas.

Object

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

notifications

O array JSON de propriedades de push. Deve incluir pelo menos os parâmetros obrigatórios content e send_date.

Parâmetros opcionais para usar dentro do 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

Data e hora em que a mensagem é enviada. Pode ser qualquer data e hora formatada como AAAA-MM-DD HH:mm ou ‘now’. Se definido como ‘now’, a mensagem será enviada imediatamente após o envio da solicitação.

Parâmetros opcionais

campaign

O código de uma Campanha. Para obter um código de Campanha, vá para Estatísticas → Estatísticas agregadas e selecione a Campanha que você vai usar. O código da campanha estará visível no final da URL da página no formato XXXXX-XXXXX.

Exemplo:

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

Código da campanha: XXXXX-XXXXX

Para obter uma lista de Campanhas com seus códigos, chame /getCampaigns. Em resposta à solicitação /getCampaigns, você receberá a lista de todas as Campanhas criadas para um aplicativo específico em sua conta Pushwoosh, com seus códigos, nomes e descrições.

capping_days

Período a ser aplicado para o limite de frequência, em dias (máximo de 30 dias). Consulte Limite de frequência para obter detalhes.

capping_count

O número máximo de pushes que podem ser enviados de um aplicativo específico para um dispositivo específico dentro de um período de “capping_days”. Caso a mensagem criada exceda o limite de “capping_count” para um dispositivo, ela não será enviada para esse dispositivo. Consulte Limite de frequência para obter detalhes.

conditions

Condições são arrays como [tagName, operator, operand] usados para enviar mensagens direcionadas com base em Tags e seus valores, onde:

• tagName — o nome de uma tag a ser aplicada,
• operator — um operador de comparação de valor (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
• operand — Valores de Tag de qualquer um dos seguintes tipos: string | integer | array | date | boolean | list

Descrição do operador

EQ	o valor da tag é igual ao operando.
IN	o valor da tag cruza com o operando (o operando deve ser sempre um array).
NOTEQ	o valor da tag não é igual a um operando.
NOTIN	o valor da tag não cruza com o operando (o operando deve ser sempre um array).
GTE	o valor da tag é maior ou igual ao operando.
LTE	o valor da tag é menor ou igual ao operando.
BETWEEN	o valor da tag é maior ou igual ao valor mínimo do operando, mas menor ou igual ao valor máximo do operando (o operando deve ser sempre um array).
NOTSET	a tag não está definida. O operando não é considerado.
ANY	a tag tem qualquer valor. O operando não é considerado.

Tags de string

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

Operandos válidos:

EQ, NOTEQ	o operando deve ser uma string
IN, NOTIN	o operando deve ser um array de strings como ["valor 1", "valor 2", "valor N"]
NOTSET	a tag não está definida. O operando não é considerado
ANY	a tag tem qualquer valor. O operando não é considerado

Tags de inteiro

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

Operandos válidos:

EQ, NOTEQ, GTE, LTE	o operando deve ser um inteiro
IN, NOTIN	o operando deve ser um array de inteiros como [valor 1, valor 2, valor N]
BETWEEN	o operando deve ser um array de inteiros como [valor_min, valor_max]
NOTSET	a tag não está definida. O operando não é considerado
ANY	a tag tem qualquer valor. O operando não é considerado

Tags de data

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

Operandos válidos:

• "AAAA-MM-DD 00:00" (string)
• timestamp unix 1234567890 (inteiro)
• "N days ago" (string) para os operadores EQ, BETWEEN, GTE, LTE

Tags booleanas

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: o operando deve ser um array de strings como ["valor 1", "valor 2", "valor N"].

Importante

Lembre-se de que os parâmetros “filter” e “conditions” não devem ser usados juntos.
Além disso, ambos serão ignorados se o parâmetro “devices” for usado na mesma solicitação.

Tags de País e Idioma

O valor da tag de idioma é um código de duas letras minúsculas de acordo com ISO-639-1. O valor da tag de país é um código de duas letras MAIÚSCULAS de acordo com ISO_3166-2.

Por exemplo, para enviar uma notificação push para assinantes de língua portuguesa no Brasil, você precisará especificar a seguinte condição: "conditions": [["Country", "EQ", "BR"],["Language", "EQ", "pt"]]

conditions_operator

Operador lógico para arrays de condições. Valores possíveis: AND | OR. AND é o padrão.

Se o operador aplicado for AND (quando nenhum operador for especificado, ou o parâmetro ‘conditions_operator’ tiver o valor ‘AND’), os dispositivos que cumprirem simultaneamente todas as condições receberão a notificação push.

Se o operador for OR, os dispositivos que cumprirem qualquer uma das condições especificadas receberão a mensagem.

data

String JSON ou objeto JSON usado para passar quaisquer dados personalizados no payload do push; é passado como parâmetro “u” no payload (convertido para string JSON).

devices

O array de tokens de push ou HWIDs para enviar notificações push direcionadas. Se definido, a mensagem será enviada apenas para os dispositivos da lista.

dynamic_content

Placeholders para Conteúdo Dinâmico a serem usados em vez dos valores da Tag do dispositivo. O exemplo abaixo enviará a mensagem “Olá, João!” para cada usuário que você segmentar. Se não for definido, os valores do Conteúdo Dinâmico são retirados das Tags do dispositivo.

"content": "Olá, {firstname|CapitalizeFirst}!",
"dynamic_content_placeholders": {
  "firstname": "João",
  "lastname": "Silva"
},

filter

O nome de um Segmento exatamente como foi criado no Painel de Controle da Pushwoosh ou via uma solicitação à API /createFilter. Vá para a seção Público → Segmentos e verifique a lista de Segmentos criados.

Para obter a lista de Segmentos via API, chame o método da API /listFilters. Em resposta à solicitação /listFilters, você receberá a lista de todos os Segmentos criados em sua conta Pushwoosh, com os nomes, condições e datas de expiração dos Segmentos.

ignore_user_timezone

Se definido como ‘true’, envia a mensagem na hora e data especificadas no parâmetro “send_date” de acordo com UTC-0.

Se definido como ‘false’, os usuários receberão a mensagem na hora local especificada de acordo com as configurações de seus dispositivos.

inbox_date

A data até a qual a mensagem deve ser mantida na Caixa de Entrada dos usuários. Se não for especificado, a mensagem será removida da Caixa de Entrada no dia seguinte à data de envio.

Nota

Para salvar a mensagem na Caixa de Entrada, use pelo menos um dos parâmetros ‘inbox’: “inbox_date” ou “inbox_image”.

Cuidado

A mensagem será removida da Caixa de Entrada às 00:00:01 da data especificada, portanto, a data anterior é o último dia em que um usuário pode ver a mensagem em sua Caixa de Entrada.

inbox_image

A URL da imagem personalizada a ser exibida perto da mensagem na Caixa de Entrada.

Nota

Para salvar a mensagem na Caixa de Entrada, use pelo menos um dos parâmetros ‘inbox’: “inbox_date” ou “inbox_image”.

inbox_days

O tempo de vida de uma mensagem na caixa de entrada em dias, até 30 dias. Após este período, a mensagem será removida da caixa de entrada. Pode ser usado em vez do parâmetro inbox_date.

link

A URL a ser aberta assim que um usuário abrir uma notificação push.

minimize_link

Encurtador para minimizar a URL enviada no parâmetro “link”. Observe que o tamanho do payload da notificação push é limitado, portanto, considere criar URLs curtas para não exceder o limite. Valores disponíveis: 0 — não minimizar, 2 — bitly. Padrão = 2. O encurtador de URL do Google está desativado desde 30 de março de 2019.

platforms

O array de códigos de plataforma para enviar a mensagem apenas para plataformas específicas.

Os códigos de plataforma disponíveis incluem: 1 — iOS, 3 — Android, 7 — Mac OS X, 8 — Windows, 9 — Amazon, 10 — Safari, 11 — Chrome, 12 — Firefox, 14 — Email, 17 — Huawei, 18 — SMS e 21 — WhatsApp.

preset

O código de uma Predefinição criada no Painel de Controle da Pushwoosh ou via API. Para obter um código de predefinição, vá para Conteúdo → Predefinições, expanda a predefinição que você vai usar e copie o Código da Predefinição dos detalhes da predefinição.

rich_media

O código de uma página de Rich Media que você vai anexar à sua mensagem. Para obter um código, vá para Conteúdo → Rich Media, abra uma página de Rich Media que você vai usar e copie o código da barra de URL do seu navegador. O código é um conjunto de 10 caracteres (letras e dígitos) separados por hífen.

send_rate

Limitação para restringir a velocidade de envio de push. Os valores válidos são de 100 a 1000 pushes/segundo.

timezone

Fuso horário a ser levado em conta quando a mensagem é enviada em uma data e hora específicas. Se definido, o fuso horário do dispositivo é ignorado. Se ignorado, a mensagem é enviada em UTC. Consulte https://php.net/manual/timezones.php para fusos horários suportados.

template_bindings

Placeholders de modelo para usar em seu modelo de conteúdo. Consulte o guia de Modelos Liquid para obter detalhes.

transactionId

Identificador de mensagem único para evitar a duplicação de mensagens em caso de problemas de rede. Você pode atribuir qualquer ID a uma mensagem criada via solicitação /createMessage ou /createTargetedMessage. Armazenado do lado da Pushwoosh por 5 minutos.

users

O array de User IDs. O User ID é um identificador de usuário único definido por uma solicitação à API /registerUser, /registerDevice ou /registerEmail.