今後のスケジュールされた キャンペーンとキャンバスを一覧表示する
get
/messages/scheduled_broadcasts
このエンドポイントを使用して、現在からリクエストで指定された
end_time
までのスケジュールされたキャンペーンとエントリキャンバスに関する情報の JSON リストを返します。
毎日、繰り返し発生するメッセージは、次回発生時に一度だけ耳元をアプリします。このエンドポイントで返される結果には、Braze ダッシュボードで作成およびスケジュールされたキャンペーンとキャンバスが含まれます。
前提条件
このエンドポイントを使用するには、API キーとmessages.schedule_broadcasts
の権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメーター | required | データ型 | 説明 |
---|---|---|---|
end_time |
必須 | ISO-8601形式の文字列 | 今後予定されているキャンペーンとキャンバスを取得する範囲の終了日。これは、API によって UTC 時間の午前 0 時として扱われます。 |
例のリクエスト
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/messages/scheduled_broadcasts?end_time=2018-09-01T00:00:00-04:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
応答
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"scheduled_broadcasts": [
{
"name": (string) the name of the scheduled broadcast,
"id": (stings) the Canvas or campaign identifier,
"type": (string) the broadcast type either Canvas or Campaign,
"tags": (array) an array of tag names formatted as strings,
"next_send_time": (string) The next send time formatted in ISO 8601, may also include time zone if not local/intelligent delivery,
"schedule_type": (string) The schedule type, either local_time_zones, intelligent_delivery or the name of your company's time zone,
},
]
}
New Stuff!