Envoyez des messages de campagne à l’aide de la réception/distribution déclenchée par l’API.

Utilisez cet endpoint pour envoyer des messages immédiats et ponctuels à des utilisateurs désignés en utilisant la réception/distribution déclenchée par l’API.

La réception/distribution déclenchée par l’API vous permet d’héberger le contenu des messages dans le tableau de bord de Braze tout en dictant quand un message est envoyé, et à qui, à l’aide de votre API.

Si vous ciblez un segmentation, un enregistrement de votre demande est stocké dans la console de développement. Pour envoyer des messages avec cet endpoint, vous devez disposer d’un ID de campagne créé lorsque vous créez une campagne déclenchée par l’API.

Conditions préalables

Pour utiliser cet endpoint, vous devrez générer une clé API avec l’autorisation campaigns.trigger.send.

Limite de débit

Lorsque vous spécifiez un segment ou une audience connectée dans votre demande, nous appliquons une limitation du débit de 250 demandes par minute à cet endpoint. Sinon, si vous spécifiez un external_id, cet endpoint présente une limitation du débit par défaut de 250 000 requêtes par heure, partagées entre /messages/send, /campaigns/trigger/send et /canvas/trigger/send, comme documenté dans Limites de débit de l’API.

Les endpoints Braze prennent en charge les requêtes d’API en lots. Une seule demande aux endpoints de messagerie peut atteindre n’importe lequel des éléments suivants :

• Jusqu’à 50 external_ids spécifiques, chacun avec des paramètres de message individuels
• Un segment d’audience de toute taille, défini dans la requête en tant qu’objet audience connectée

Corps de la demande

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "campaign_id": (required, string) see campaign identifier,
  "send_id": (optional, string) see send identifier,
  "trigger_properties": (optional, object) personalization key-value pairs that apply to all users in this request,
  "broadcast": (optional, boolean) see broadcast -- defaults to false on 8/31/17, must be set to true if "recipients" is omitted,
  "audience": (optional, connected audience object) see connected audience,
  // Including 'audience' sends to only users in the audience
  "recipients": (optional, array; if not provided and broadcast is not set to `false`, message sends to the entire segment targeted by the campaign)
    [
      {
      // Either "external_user_id" or "user_alias" or "email" is required. Requests must specify only one.
      "user_alias": (optional, user alias object) user alias of user to receive message,
      "external_user_id": (optional, string) external identifier of user to receive message,
      "email": (optional, string) email address of user to receive message,
      "prioritization": (optional, array) prioritization array; required when using email,
      "trigger_properties": (optional, object) personalization key-value pairs that apply to this user (these key-value pairs override any keys that conflict with the parent trigger_properties),
      "send_to_existing_only": (optional, boolean) defaults to true, can't be used with user aliases; if set to `false`, an attributes object must also be included,
      "attributes": (optional, object) fields in the attributes object create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values are overwritten
    }
  ],
  "attachments": (optional, array) array of JSON objects that define the files you need attached, defined by "file_name" and "url",
    [
      {
       "file_name": (required, string) the name of the file you want to attach to your email, excluding the extension (for example, ".pdf"). Attach files up to 2 MB. This is required if you use "attachments",
       "url": (required, string) the corresponding URL of the file you want to attach to your email. The file name's extension is detected automatically from the URL defined, which should return the appropriate "Content-Type" as a response header. This is required if you use "attachments",
      }
    ]
}

Paramètres de demande

• Le tableau d’objets peut contenir jusqu’à 50 objets, chaque objet contenant une chaîne de caractères external_user_id et un objet trigger_properties.
• Lorsque send_to_existing_only est true (par défaut), Braze envoie le message uniquement aux utilisateurs existants. Lorsque la valeur est false et qu’un objet d’attributs est fourni, Braze crée un nouvel utilisateur s’il n’en existe pas. Notez que le réglage de send_to_existing_only sur false n’est pas pris en charge pour les alias d’utilisateurs - il n’est pas possible de créer de nouveaux utilisateurs uniquement par le biais de cet endpoint. Pour envoyer un message à un alias d’utilisateur, l’utilisateur doit déjà exister dans Braze.

Le statut du groupe d’abonnement d’un utilisateur peut être mis à jour en incluant un paramètre subscription_groups dans l’objet attributes. Pour plus de détails, consultez Objet Attributs d’utilisateur.

Exemple de demande

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "campaign_id": "campaign_identifier",
  "send_id": "send_identifier",
  "trigger_properties": "",
  "broadcast": false,
  "audience": {
    "AND": [
      {
        "custom_attribute": {
          "custom_attribute_name": "eye_color",
          "comparison": "equals",
          "value": "blue"
        }
      },
      {
        "custom_attribute": {
          "custom_attribute_name": "favorite_foods",
          "comparison": "includes_value",
          "value": "pizza"
        }
      },
      {
        "OR": [
          {
            "custom_attribute": {
              "custom_attribute_name": "last_purchase_time",
              "comparison": "less_than_x_days_ago",
              "value": 2
            }
          },
          {
            "push_subscription_status": {
              "comparison": "is",
              "value": "opted_in"
            }
          }
        ]
      },
      {
        "email_subscription_status": {
          "comparison": "is_not",
          "value": "subscribed"
        }
      },
      {
        "last_used_app": {
          "comparison": "after",
          "value": "2019-07-22T13:17:55+0000"
        }
      }
    ]
  },
  "recipients": [
    {
      "user_alias": {
        "alias_name" : "example_name",
        "alias_label" : "example_label"
      },
      "external_user_id": "external_user_identifier",
      "trigger_properties": "",
      "send_to_existing_only": true,
      "attributes": {
        "first_name" : "Alex"
      }
    }
  ],
  "attachments": [
    {
      "file_name" : "YourFileName",
      "url" : "https://exampleurl.com/YourFileName.pdf"
    }
  ]
}'

Informations relatives à la réponse

Les réponses des points d’extrémité d’envoi de messages comprennent le site dispatch_id, qui renvoie à l’envoi du message. Le dispatch_id est l’ID de l’envoi de messages, un ID unique pour chaque transmission envoyée depuis Braze. Lorsque vous utilisez cet endpoint, vous recevez un seul dispatch_id pour un ensemble complet d’utilisateurs regroupés. Pour plus d’informations sur dispatch_id, consultez notre documentation sur le comportement du Dispatch ID.

Si votre demande rencontre une erreur fatale, reportez-vous à la section Erreurs et réponses pour connaître le code d’erreur et sa description.

Objet d’attributs pour les campagnes

Braze dispose d’un objet d’envoi de messages appelé attributes qui vous permet d’ajouter, de créer ou de mettre à jour les attributs et les valeurs d’un utilisateur avant de lui envoyer une campagne déclenchée par l’API. En utilisant l’endpoint campaign/trigger/send, cet appel API traite l’objet des attributs de l’utilisateur avant de traiter et d’envoyer la campagne. Cela permet de minimiser le risque de problèmes causés par des conditions de concurrence.