APIのみを使用してメッセージを即座に送信する
このエンドポイントを使用して、Braze APIを使用して指定したユーザーに即時メッセージを送信する。
リクエストを完了させるために、必ずメッセージング・オブジェクトを本文に含めること。
セグメントをターゲットにしている場合、リクエストの記録は開発者コンソール に保存されます。
前提条件
このエンドポイントを使用するには、messages.send 権限を持つ API キーを生成する必要があります。
レート制限
リクエストでセグメントまたは接続済みのオーディエンスを指定する際、このエンドポイントには1分あたり250リクエストのレート制限が適用されます。それ以外の場合、external_id を指定すると、このエンドポイントは、API レート制限 に記載されているように、/messages/send、/campaigns/trigger/send、および /canvas/trigger/send 間で共有される1時間あたり250,000リクエストのデフォルトのレート制限が適用されます。
要求本文:
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)
}
}
リクエストパラメーター
| パラメーター | required | データ型 | 説明 |
|---|---|---|---|
broadcast |
オプション | ブール値 | キャンペーンまたはキャンバスが対象とするSegment全体にメッセージを送信する場合は、broadcast をtrue に設定する必要があります。このパラメーターはデフォルトで false です (2017 年 8 月 31 日現在)。broadcast が true に設定されている場合、recipients リストを含めることはできません。ただし、設定 broadcast: true の場合は注意が必要です。意図せずにこのフラグを設定すると、想定よりも大きなオーディエンスにメッセージが送信される可能性があるためです。 |
external_user_ids |
オプション | 文字列の配列 | 外部ユーザーIDを参照してください。 |
user_aliases |
オプション | ユーザー別名オブジェクトの配列 | ユーザー別名オブジェクトを参照してください。 |
segment_id |
オプション | 文字列 | セグメント識別子を参照してください。 |
audience |
オプション | 接続されたオーディエンスオブジェクト | 接続オーディエンスを参照してください。 |
campaign_id |
オプション* | 文字列 | 詳細はキャンペーン識別子を参照のこと。 *Brazeのダッシュボードでキャンペーンの統計情報（送信、クリック、バウンスなど）を追跡したい場合に必要。 |
send_id |
オプション | 文字列 | 送信識別子を参照してください。 |
override_frequency_capping |
オプション | ブール値 | キャンペーンではfrequency_capping を無視する。デフォルトはfalse 。 |
recipient_subscription_state |
オプション | 文字列 | これを使用して、オプトインしたユーザーのみ (opted_in)、配信登録済みかオプトインしているユーザーのみ (subscribed)、または配信停止済みのユーザーを含むすべてのユーザー (all) にメッセージを送信します。all ユーザーは、トランザクションメールメッセージングに使用すると便利です。デフォルトは subscribed です。 |
messages |
オプション | メッセージングオブジェクト | 利用可能なメッセージングオブジェクトを参照してください。 |
例のリクエスト
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 でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!