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

Vous pouvez envoyer des messages depuis votre backend en temps réel à l’aide de deux endpoints Braze différents. Chacune a une forme de requête différente : l’une nécessite le contenu complet du message dans la requête ; l’autre nécessite un ID de campagne et envoie le contenu défini dans le tableau de bord.

Cette approche est compatible avec tous les canaux de communication pris en charge par l’API (WhatsApp, e-mail, SMS, notifications push, cartes de contenu, webhooks, etc.).

Deux méthodes pour envoyer

Pour obtenir tous les détails relatifs aux requêtes et aux réponses, veuillez consulter les références Envoyer des messages immédiatement (API uniquement) et Envoyer des campagnes à l’aide d’un endpoint de réception/distribution déclenché par l’API.

Option 1 : Veuillez envoyer le contenu du message dans la requête (/messages/send)

Veuillez utiliser cet endpoint lorsque vous souhaitez spécifier le contenu complet du message dans la requête API. Vous devez inclure unmessagesobjet (par exemple,messages.whats_app messages.email, ou messages.sms). Vous pouvez omettrecampaign_idl’envoi sans suivi de campagne ou inclure un ID de campagne API etmessage_variation_iddans chaque message afin de suivre les envois dans le tableau de bord (consultez la référence de l’endpoint pour plus de détails).

Obligatoire : Clé API avec messages.sendl’autorisation requise.

Exemple : Modèle de message WhatsApp

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "external_user_ids": ["user123"],
  "messages": {
    "whats_app": {
      "app_id": "YOUR_APP_ID",
      "subscription_group_id": "YOUR_WHATSAPP_SUBSCRIPTION_GROUP_ID",
      "message_type": "template_message",
      "message": {
        "template_name": "new_message_received",
        "template_language_code": "en_US"
      }
    }
  }
}

Pour obtenir la spécification complète de l’objet WhatsApp, veuillez consulter Objet WhatsApp.

Exemple : E-mail

1
2
3
4
5
6
7
8
9
10
11
{
  "external_user_ids": ["user123"],
  "messages": {
    "email": {
      "app_id": "YOUR_APP_ID",
      "subject": "Your order has shipped",
      "from": "[email protected]",
      "body": "<p>Your order #12345 is on its way.</p>"
    }
  }
}

Pour les autres canaux, veuillez consulter la section Objets d’envoi de messages.

Option 2 : Déclenchez une campagne avec du contenu dans le tableau de bord./campaigns/trigger/send

Veuillez utiliser cet endpoint lorsque le contenu du message est créé dans le tableau de bord de Braze (campagne déclenchée par API). Vous envoyez un champ obligatoirecampaign_idet les destinataires ; vous n’envoyez pas messagesd’objet.

Obligatoire : Clé API avec campaigns.trigger.sendl’autorisation requise.

Étape 1 : Créer une campagne déclenchée par API

1. Dans le tableau de bord de Braze, veuillez vous rendre dans Envoi de messages > Campagnes.
2. Veuillez sélectionner Créer une campagne, puis Campagne déclenchée par API (et non « Campagne API »).
3. Veuillez ajouter votre canal de communication (WhatsApp, e-mail, SMS, etc.) et créer le contenu du message dans le tableau de bord.
4. Veuillez noter l’identifiant de la campagne (et l’identifiant d’envoi si vous utilisez plusieurs variantes de message). Vous les utiliserez dans la requête API.

Pour plus d’informations sur la création de campagnes déclenchées par API, veuillez consulter la section Réception/distribution déclenchée par API.

Étape 2 : Veuillez déclencher la campagne via l’API.

Veuillez envoyer une requête POST à/campaigns/trigger/send aveccampaign_id etrecipients (ou broadcast/audience). Veuillez ne pas inclure messagesd’objet — le contenu provient de la campagne.

1
2
3
POST YOUR_REST_ENDPOINT/campaigns/trigger/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
8
{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "recipients": [
    {
      "external_user_id": "user123"
    }
  ]
}

Pour obtenir le corps complet de la requête (y compris trigger_properties, send_to_existing_only, attributes, etc.), veuillez consulter la référence relative à l’envoi de campagnes à l’aide de l’endpoint de réception/distribution déclenché par l’API.

Veuillez vérifier votre intégration.

1. Veuillez envoyer une demande en utilisant l’une des options ci-dessus, en indiquant votre propre ID utilisateur comme destinataire.
2. Veuillez confirmer que le message a bien été transmis.
3. Si vous utilisez l’option 2, veuillez vérifier la campagne dans le tableau de bord de Braze afin de confirmer que l’envoi a bien été enregistré.

Considérations

• Veuillez utiliser les fonctionnalités de personnalisation de Braze pour adapter le contenu lorsque cela est possible.
• Veuillez vous assurer que l’envoi de messages est conforme aux réglementations applicables et qu’il inclut les options de désabonnement et les avis de confidentialité requis.
• Pour plus de points de terminaison (planification, déclencheurs Canvas, etc.), veuillez consulter la section Points de terminaison d’envoi de messages.