Skip to content

APIのみを使用してメッセージを即座に送信する

post

/messages/send

core endpoint

このエンドポイントを使用して、Braze API で指定したユーザーに即時メッセージを送信します。

セグメントをターゲットにしている場合、リクエストの記録は開発者コンソールに保存されます。

See me in Postman

API送信で新規ユーザーを作成する

APIを使用して送信の一部としてユーザーを作成する必要がある場合、次の2つの方法があります。

オプション 1: /users/track を使用してから送信する

まず、/users/track エンドポイントでユーザーを作成し、データが伝播するのを待ちます（通常、数分間待つことを推奨します）。その後に APIのみの送信を開始します。Braze は /users/track のデータ処理時間を保証しないため、これらの呼び出し間に十分な時間を設けない場合、競合が発生する可能性があります。

オプション 2: APIトリガー型キャンペーンまたはキャンバスを使用する

APIトリガー型キャンペーンまたはキャンバスワークフローを使用します。これらを使用すると、受信者がまだ存在しない場合に作成できます。このオプションはバックエンドのプロセスを簡素化しますが、Braze ダッシュボードでキャンペーンまたはキャンバスを設定する必要があります。

前提条件

このエンドポイントを使用するには、messages.send 権限を持つ API キーを生成する必要があります。

レート制限

リクエストで Connected Audience フィルターを使用する場合、このエンドポイントには1分あたり250リクエストのレート制限が適用されます。それ以外の場合、external_id を指定すると、API レート制限に記載されているように、/messages/send、/campaigns/trigger/send、および /canvas/trigger/send 間で共有される1時間あたり250,000リクエストのデフォルトのレート制限が適用されます。

Braze のエンドポイントは API リクエストのバッチ処理をサポートしています。メッセージングエンドポイントへの単一のリクエストは、次のいずれかに到達できます。

  • それぞれに個別のメッセージパラメーターを持つ、最大50個の特定の external_ids
  • リクエスト内で Connected Audience オブジェクトとして定義された、任意のサイズのオーディエンスセグメント

Braze のエンドポイントは API リクエストのバッチ処理をサポートしています。メッセージングエンドポイントへの単一のリクエストは、次のいずれかに到達できます。

  • 最大50個の特定の external_ids
  • segment_id で指定される、Braze ダッシュボードで作成された任意のサイズのセグメント
  • リクエストで Connected Audience オブジェクトとして定義された、任意のサイズのオーディエンスセグメント

リクエスト本文

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

{
   // You will need to include at least one of 'segment_id', 'external_user_ids', and 'audience'
   // Including 'segment_id' will send to members of that segment
   // Including 'external_user_ids' and/or 'user_aliases' will send to those users
   // Including both will send to the provided users if they are in the segment
   "broadcast": (optional, boolean) see broadcast -- defaults to false on 8/31/17, must be set to true if no external_user_ids or aliases are provided,
   "external_user_ids": (optional, array of strings) see external user identifier,
   "user_aliases": (optional, array of user alias object) see user alias,
   "segment_id": (optional, string) see segment identifier,
   "audience": (optional, connected audience object) see connected audience,
   "campaign_id": (optional*, string) *required if you wish to track campaign stats (for example, sends, clicks, bounces, etc). see campaign identifier,
   "send_id": (optional, string) see send identifier,
   "override_frequency_capping": (optional, bool) ignore frequency_capping for campaigns, defaults to false,
   "recipient_subscription_state": (optional, string) use this to send messages to only users who have opted in ('opted_in'), only users who have subscribed or are opted in ('subscribed') or to all users, including unsubscribed users ('all'), the latter being useful for transactional email messaging. Defaults to 'subscribed',
   "messages": {
     "android_push": (optional, android push object),
     "apple_push": (optional, apple push object),
     "content_card": (optional, content card object),
     "email": (optional, email object),
     "kindle_push": (optional, kindle/fireOS push object),
     "web_push": (optional, web push object),
     "webhook": (optional, webhook object),
     "whats_app": (optional, WhatsApp object),
     "sms": (optional, SMS object)
   }
 }

リクエストパラメーター

リクエスト例

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

curl --location --request POST 'https://rest.iad-01.braze.com/messages/send' \
--data-raw '{
  "broadcast": "false",
  "external_user_ids": "external_user_identifiers",
  "user_aliases": {
    "alias_name": "example_name",
    "alias_label": "example_label"
  },
  "segment_id": "segment_identifier",
  "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"
        }
      }
    ]
  },
  "campaign_id": "campaign_identifier",
  "send_id": "send_identifier",
  "override_frequency_capping": "false",
  "recipient_subscription_state": "all",
  "messages": {
    "android_push": "(optional, Android Push Object)",
    "apple_push": "(optional, Apple Push Object)",
    "content_card": "(optional, Content Card Object)",
    "email": "(optional, Email Object)",
    "kindle_push": "(optional, Kindle/FireOS Push Object)",
    "web_push": "(optional, Web Push Object)"
  }
}'

応答の詳細

メッセージ送信エンドポイントの応答には、メッセージのディスパッチを参照するための dispatch_id が含まれます。dispatch_id はメッセージディスパッチの ID であり、Braze から送信される各「送信」に固有の ID です。詳しくは、ディスパッチ ID の動作を参照してください。
Github   GitHub でこのページを編集
New Stuff!