Skip to content

予定されているキャンペーンとキャンバスを一覧表示する

get

/messages/scheduled_broadcasts

このエンドポイントを使用して、現在と、リクエストで指定されたend_time の間にスケジュールされたキャンペーンとエントリキャンバスに関する情報のJSON リストを返します。

毎日、定期的なメッセージは、次回の発生時に一度だけ表示されます。このエンドポイントで返される結果は、Braze で作成およびスケジュールされたキャンペーンおよびキャンバスの場合のみです。

前提条件

このエンドポイントを使用するには、messages.schedule_broadcasts 権限を持つAPI キー が必要です。

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

要求パラメータ

パラメータ 必須 データ型 説明
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 boradcast,
      "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!