Campanhas acionadas pela API

Qualquer canal de saída disponível pode ser acionado por uma execução de API e múltiplos canais podem ser usados no seu modelo, se necessário.

Depois que seu template estiver configurado com os marcadores apropriados, use a API Campaign Execute para acioná-lo e passe os valores de atributo no ponto de disparo. Veja o exemplo abaixo para ver como isso funciona na prática.

Envie e-mails transacionais ou SMS

Se você quiser usar a API para enviar e-mails transacionais ou SMS, os princípios seriam os mesmos em ambos os casos. Primeiro, você cria uma campanha modelo de API com os marcadores necessários para conteúdo que muda dinamicamente. Para ilustrar como isso é usado, abaixo está um exemplo transacional clássico de enviar uma atualização do portão para um cliente de companhia aérea via SMS:

Neste exemplo, você usaria o método de execução de campanha para acionar a campanha quando informações de portão ficarem disponíveis no backend. Token de aplicativo e ID de campanha são usados para direcionar a campanha correta no seu projeto, e os parâmetros são definidos para a informação do voo (flight_num, time e gate_num). Por fim, para direcionar usuários que estão registrados para o voo, estamos adicionando uma condição na aba de segmento para direcionar usuários que estão na lista do voo, direcionando por ID de usuário e fornecendo um array de IDs de clientes para direcionar.

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/execute/campaign \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "apptoken": "APP_TOKEN",
    "id": "CAMPAIGN_ID",
    "params": {
      "flight_num": "EI105", 
      "time": "10:30",
      "gate_num": "B100" 
    },
    "target_by": "user_id",
    "target": ["USER_ID"]
}

Se você quiser construir o conteúdo completo da mensagem no backend, pode simplesmente colocar parâmetros individuais nos vários campos de conteúdo do template da plataforma Xtremepush, como no exemplo abaixo, onde {{from}} está incluído no campo nome de de de partir para gerar dinamicamente o nome de partir e {{text}} no campo de texto:

O mesmo princípio descrito acima para SMS pode ser aplicado ao e-mail; a principal diferença com o e-mail é o potencial de ter conteúdo mais complexo no corpo do e-mail, como uma lista de recomendações personalizadas de produtos com imagens, etc. Existem exemplos de conteúdo mais dinâmico que pode ser adicionado a e-mails usando essa abordagem nos seguintes guias de usuário:

• Conteúdo dinâmico

  • Incluindo conteúdo dinâmico obtido de uma fonte externa

Para qualquer jornada acionada pela API, parâmetros passados params ou target_with_params estão disponíveis para cada nó de mensagem na jornada. Cada nó de mensagem resolve apenas os marcadores de atributos referenciados nele. Parâmetros não utilizados são ignorados.

Por exemplo, considere uma jornada em que um usuário recebe uma notificação SMS sobre uma promoção, seguida de uma notificação Web Push.

Neste exemplo, as mensagens usam três variáveis: promo_name e match_name, que são iguais para todos os usuários, e promo_code, que é única para cada usuário. As mensagens em cada nó são as seguintes:

• SMS Node: "Olá {{first_name}}, sua {{promo_name}} oferta {{match_name}} está ativa."

• Nó Web-Push: "Faça sua aposta em {{match_name}}. Use o código {{promo_code}} para reivindicar sua {{promo_name}} oferta."

Neste exemplo, você deve usar todos os três parâmetros (promo_name, match_name, promo_code) na chamada de API de Execução de Campanha :

{
  "apptoken": "APP_TOKEN",
  "id": "Campaign_ID",
  "target_by": "user_id",
  "target": ["user_1", "user_2", "user_3"],
  "params": {
    "promo_name": "Play-X-Get-Y",
    "match_name": "Man Utd vs Liverpool"
  },
  "target_with_params": {
    "user_1": {"promo_code": "PLAY50X"},
    "user_2": {"promo_code": "PLAY75Y"},
    "user_3": {"promo_code": "PLAY100Z"}
  }
}

• {{first_name}} 'já está armazenado no perfil do usuário e não precisa ser passado na chamada API.

• promo_name e expiry_date são passados em parâmetros, pois são iguais para todos os usuários

• promo_code é repassado target_with_params por ser único por usuário.

Neste exemplo, no nó SMS, {{promo_name}} e {{match_name}}são resolvidos, e {{promo_code}} é ignorado por não ser referenciado na mensagem SMS. Isso significa que apenas {{first_name}} ,{{promo_name}} , e {{match_name}} renderizam na mensagem SMS.

No nó Web Push, {{match_name}}, {{promo_name}}, e {{promo_code}} são resolvidos, e somente esses valores de atributos são renderizados.