Crie uma campanha SMS usando a API

Prev Next

Se ainda não fez isso, primeiro revise a visão geral sobre o uso dos métodos de criar e enviar campanhas para enviar mensagens via API.

Para criar um SMS, você precisará adicionar uma mensagem SMS nos seus parâmetros POST ao chamar o create método. Os parâmetros usados no conteúdo das mensagens SMS estão listados abaixo:

Parâmetros

Parâmetro

Descrição

Mensagens

Defina para o número 9 para SMS, ou seja,

"messages": {
  "9": { "SMS_CONTENT PARAMS" }
}

Um objeto JSON contendo os parâmetros SMS

SMS

"sms": {
  "from": "xtremepush",
  "text": "Hello"
}

de

O cabeçalho from que é usado para identificar sua marca

Texto

O texto principal da mensagem SMS

SMS a partir de nomes

SMS de nomes substitui o número do remetente na sua mensagem SMS vista pelo seu público e é capturada pelo from parâmetro. Esses precisam ser pré-configurados na página de configurações do SMS .

Exemplo

O canal SMS é ativado com "sms": 1 e o SMS tipo 9 é adicionado ao objeto mensagens com parâmetros para o conteúdo do SMS. Neste exemplo "broadcast": 1 , é usado para atingir toda a sua base de usuários disponíveis. Condições que miram uma subseção do seu público, além de opções de agendamento e outras podem ser adicionadas conforme descrito no guia de modelos de campanha.

Neste exemplo, uma tag de personalização foi adicionada no texto do SMS para puxar os primeiros nomes dos usuários.

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/create/campaign \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "title": "SMS example via API",
    "sms": 1,
    "broadcast": 1,
    "messages": {
      "9": {
        "sms": {
          "from": "xtremepush",
          "text": "{{first_name}}, check out our SMS API test"
        }
      }
    }
  }'

Seu SMS resultante acima seria algo parecido com este:

750