スケジュールオブジェクト

キャンペーンとキャンバスのスケジュール作成エンドポイントのパラメータは、送信エンドポイントのパラメータを反映し、ターゲットユーザーにいつメッセージを受信させたいかを指定できるschedule パラメータを追加します。schedule オブジェクトにtime パラメータだけを含めると、その時点ですべてのユーザーにメッセージが送られます。

in_local_time をtrue に設定した場合、time パラメーターがすべてのタイムゾーンでパスした場合、エラー応答が返される。at_optimal_time 」を「true」に設定すると、ユーザーは指定された日付の最適な時間にメッセージを受け取ります（あなたが指定した時間に関係なく）。ローカル時間または最適時間送信を使用する場合、時間パラメータの値にタイムゾーン指定を指定しないでください（例えば、"2015-02-20T13:14:47-05:00" の代わりに"2015-02-20T13:14:47" を指定してください）。

この応答はschedule_id を提供します。後で予約したメッセージをキャンセルまたは更新する必要がある場合に備えて保存しておいてください：

オブジェクト本体

このオブジェクトを必要に応じて挿入し、メッセージのスケジューリングを行います。

1
2
3
4
5
"schedule": {
  "time": (required, datetime as ISO 8601 string) time to send the message,
  "in_local_time": (optional, bool),
  "at_optimal_time": (optional, bool),
}

スケジュール ID レスポンス

作成したスケジュールメッセージのschedule_id 。

1
2
3
4
5
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "schedule_id" : (required, string) identifier for the scheduled message that was created
}

サーバー間の呼び出しにAPIを使用する場合、サーバーがファイアウォールの内側にある場合は、適切なAPI URLをallowlistする必要があるかもしれない。

メッセージ・スケジューリング・エンドポイントのレスポンスには、メッセージのディスパッチに参照できるように、メッセージのdispatch_id が含まれます。dispatch_id はメッセージ発信のID（Brazeから送信される「送信」ごとにユニークなID）。