Skip to content

Envio de mensagens SMS usando a REST API

Use a REST API da Braze para enviar mensagens SMS transacionais do seu backend em tempo real. Essa abordagem permite que você construa um serviço que envia mensagens SMS programaticamente enquanto rastreia a análise de entrega junto com suas outras campanhas e Canvas no dashboard da Braze.

Isso pode ser especialmente útil para envio de mensagens transacionais de alto volume, onde o conteúdo é definido nos seus sistemas de backend. Por exemplo, você pode notificar os consumidores quando eles receberem uma mensagem de outro usuário, convidando-os a visitar seu site e verificar sua caixa de entrada.

Com essa abordagem, você pode:

  • Disparar mensagens SMS do seu backend em tempo real.
  • Rastrear análises junto com todas as suas Campaigns e Canvas de marketing.
  • Ampliar o caso de uso com recursos adicionais da Braze, como postergação de mensagens, redirecionamento de acompanhamento e testes A/B.
  • Opcionalmente, mudar para entrega disparada por API para definir seus modelos de mensagem no dashboard da Braze enquanto ainda dispara envios do seu backend.

Para enviar uma mensagem SMS pela REST API, você precisa configurar uma Campanha da API no dashboard da Braze e então usar o endpoint /messages/send para enviar a mensagem.

Pré-requisitos

Para completar este guia, você precisa de:

Etapa 1: Criar uma Campanha da API

  1. No dashboard da Braze, acesse Messaging > Campaigns.
  2. Selecione Create Campaign e depois selecione API Campaigns.
  3. Digite um nome e uma descrição para sua campanha, como “notificação de mensagem SMS”.
  4. Adicione tags relevantes para identificação e rastreamento.
  5. Selecione Add Messaging Channel e depois selecione SMS.
  6. Anote o Campaign ID e o Message Variation ID exibidos na página da campanha. Você precisará de ambos os valores ao construir sua solicitação de API.

Etapa 2: Enviar uma mensagem SMS usando a API

Construa uma solicitação POST para o endpoint /messages/send. Inclua o ID da campanha, o ID de usuário externo do destinatário e o conteúdo do SMS na carga útil da solicitação.

Exemplo de solicitação

1
2
3

POST YOUR_REST_ENDPOINT/messages/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

Substitua YOUR_REST_ENDPOINT pela URL do endpoint REST do seu espaço de trabalho.

1
2
3
4
5
6
7
8
9
10
11
12

{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "external_user_ids": ["user123"],
  "messages": {
    "sms": {
      "app_id": "YOUR_APP_ID",
      "subscription_group_id": "YOUR_SMS_SUBSCRIPTION_GROUP_ID",
      "message_variation_id": "YOUR_MESSAGE_VARIATION_ID",
      "body": "Hi {{${first_name}}}, you have a new message in your inbox. Check it out at https://yourwebsite.com/messages. Text STOP to opt out."
    }
  }
}

Substitua os valores de espaço reservado pelos seus IDs reais. O campo body suporta personalização Liquid, para que você possa adaptar o conteúdo da mensagem para cada destinatário. Para a lista completa de parâmetros suportados pelo objeto de envio de SMS, consulte objeto SMS.

Após construir a solicitação, envie a solicitação POST do seu serviço de backend para a REST API da Braze.

Etapa 3: Verificar sua integração

Após concluir a configuração, verifique sua integração:

  1. Envie uma solicitação de API conforme descrito na Etapa 2, usando seu próprio ID de usuário como destinatário.
  2. Confirme se a mensagem SMS foi entregue ao seu telefone.
  3. No dashboard da Braze, acesse a página de resultados da campanha e confirme se o envio está registrado.
  4. Monitore os resultados de perto à medida que você expande sua campanha.

Considerações
New Stuff!