Envio de mensagens SMS usando a API REST

Use a API REST do 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 Canvases no dashboard do Braze.

Isso pode ser especialmente útil para mensagens transacionais de alto volume, onde o conteúdo é definido em 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 campanhas e Canvases de marketing.
• Ampliar o caso de uso com recursos adicionais do Braze, como atrasos de mensagens, redirecionamento de acompanhamento e testes A/B.
• Opcionalmente, mude para entrega acionada por API para definir seus modelos de mensagem no dashboard do Braze enquanto ainda dispara envios do seu backend.

Para enviar uma mensagem SMS através da API REST, você precisa configurar uma campanha de API no dashboard do Braze, e então usar o /messages/send endpoint para enviar a mensagem.

Pré-requisitos

Para completar este guia, você precisa:

Etapa 1: Criar uma campanha de API

1. No painel do Braze, acesse Envio de Mensagens > Campanhas.
2. Selecione Criar Campanha, depois selecione Campanhas de API.
3. Digite um nome e descrição para sua campanha, como “notificação de mensagem SMS”.
4. Adicione tags relevantes para identificação e rastreamento.
5. Selecione Adicionar Canal de Envio de Mensagens, depois selecione SMS.
6. Anote o ID da Campanha e o ID da Variação da Mensagem exibidos na página da campanha. Você precisará de ambos os valores ao construir sua solicitação de API.

Etapa 2: Envie uma mensagem SMS usando a API

Construa uma solicitação POST para o /messages/send endpoint. Inclua o ID da campanha, o ID do 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 para 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, veja objeto SMS.

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

Etapa 3: Verifique sua integração

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

1. Envie uma solicitação de API conforme descrito em 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 do 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

• Confirme que suas campanhas de SMS estão em conformidade com as regulamentações relevantes e os requisitos da operadora. Inclua instruções de opt-out (como “Envie STOP para cancelar”) em cada mensagem. Para saber mais, veja leis e regulamentações de SMS e palavras-chave de aceitação e cancelamento.
• Use os recursos de personalização do Braze para adaptar o conteúdo de SMS para consumidores individuais, incluindo conteúdo dinâmico e dados específicos do usuário.
• A API REST do Braze oferece endpoints de envio de mensagens adicionais para agendar mensagens, acionar campanhas e mais.