Skip to content

Envoi de messages SMS à l’aide de la REST API

Utilisez la REST API Braze pour envoyer des messages SMS transactionnels depuis votre backend en temps réel. Cette approche vous permet de créer un service qui envoie des SMS de manière programmatique tout en suivant les analyses de distribution parallèlement à vos autres Campaigns et Canvas dans le tableau de bord de Braze.

Cela peut s’avérer particulièrement utile pour l’envoi de messages transactionnels à haut volume dont le contenu est défini dans vos systèmes backend. Par exemple, vous pouvez informer les consommateurs lorsqu’ils reçoivent un message d’un autre utilisateur, en les invitant à visiter votre site web et à consulter leur boîte de réception.

Grâce à cette approche, vous pouvez :

  • Déclencher l’envoi de SMS depuis votre backend en temps réel.
  • Suivre les analyses parallèlement à toutes vos Campaigns et Canvas marketing.
  • Étendre le champ d’application avec des fonctionnalités Braze supplémentaires, telles que les retards de message, le reciblage de suivi et les tests A/B.
  • Optionnellement, passer à la distribution déclenchée par API afin de définir vos modèles de message dans le tableau de bord de Braze tout en continuant à déclencher les envois depuis votre backend.

Pour envoyer un SMS via la REST API, vous devez configurer une campagne API dans le tableau de bord de Braze, puis utiliser l’endpoint /messages/send pour envoyer le message.

Conditions préalables

Pour suivre ce guide, vous aurez besoin des éléments suivants :

Condition Description
Clé de REST API Braze Une clé avec l’autorisation messages.send. Pour en créer une, rendez-vous dans Paramètres > API et identifiants > Clés API.
Groupe d’abonnement SMS Un groupe d’abonnement SMS configuré dans votre espace de travail Braze.
Service backend Un service backend ou un environnement de script capable d’effectuer des requêtes HTTP POST vers la REST API Braze.

Étape 1 : Créer une campagne API

  1. Dans le tableau de bord de Braze, rendez-vous dans Messaging > Campaigns.
  2. Sélectionnez Create Campaign, puis API Campaigns.
  3. Saisissez un nom et une description pour votre campagne, par exemple « Notification par SMS ».
  4. Ajoutez des étiquettes pertinentes pour l’identification et le suivi.
  5. Sélectionnez Add Messaging Channel, puis choisissez SMS.
  6. Notez l’ID de la campagne et l’ID de la variante du message affichés sur la page de la campagne. Vous aurez besoin de ces deux valeurs pour construire votre requête API.

Étape 2 : Envoyer un message SMS à l’aide de l’API

Construisez une requête POST vers l’endpoint /messages/send. Incluez l’ID de la campagne, l’ID utilisateur externe du destinataire et le contenu du SMS dans le payload de la requête.

Exemple de requête

1
2
3

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

Remplacez YOUR_REST_ENDPOINT par l’URL de l’endpoint REST de votre espace de travail.

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."
    }
  }
}

Remplacez les valeurs de marque substitutive par vos ID réels. Le champ body prend en charge la personnalisation Liquid, ce qui vous permet d’adapter le contenu du message à chaque destinataire. Pour obtenir la liste complète des paramètres pris en charge par l’objet d’envoi de messages SMS, consultez l’objet SMS.

Une fois la requête construite, envoyez la requête POST depuis votre service backend vers la REST API Braze.

Étape 3 : Vérifier votre intégration

Une fois la configuration terminée, vérifiez votre intégration :

  1. Envoyez une requête API comme indiqué à l’étape 2, en utilisant votre propre ID utilisateur comme destinataire.
  2. Vérifiez que le message SMS a bien été reçu sur votre téléphone.
  3. Dans le tableau de bord de Braze, rendez-vous sur la page des résultats de la campagne et confirmez que l’envoi a bien été enregistré.
  4. Surveillez attentivement les résultats à mesure que vous développez votre campagne.

Considérations
New Stuff!