プッシュ送信API

指定されたデバイストークンへプッシュを送信する。

メソッド

POST

パス

/push/send

リクエストボディ

Name	型	概要
tenant_id(必須)	文字列	テナントID ※別途お渡しした内容をご利用ください。
contents.search_condition	オブジェクト	検索条件 ※配信対象の顧客検索条件を指定してください。
contents.push_title	文字列	タイトル 最大256文字
contents.push_message(必須)	文字列	メッセージ 最大256文字
contents.push_url	文字列	通知URL
contents.push_custom_vars	文字列	Pushカスタム情報JSON カスタムペイロード情報をJSON文字列にて指定 最大 2,000 Byte
contents.badge_num	数値	バッジ数 iOS のみサポート
contents.push_start_dte	文字列	プッシュ開始日時 yyyy-mm-dd hh:mi:ss形式 ※未指定時は、次回プッシュバッチ実行時配信となります。
contents.multilang_messages	多言語メッセージオブジェクト	多言語メッセージ

ヒント

push_message、multilang_messages.push_message.{language_cd}はどちらかを必ず指定してください。どちらも指定されている場合、multilang_messageの内容が優先されます。

多言語メッセージオブジェクト

Name	型	概要
push_title.{language_cd}	文字列	タイトル 最大256文字
push_message.{language_cd}(必須)	文字列	メッセージ 最大256文字

ヒント

language_cdには ja、enなどの言語コードを指定してください。

レスポンスボディ

Name	型	概要
status(必須)	文字列	ステータスコード
message(必須)	文字列	実行メッセージ
contents.push_send_cnt	数値	送信件数
contents.detail_message	文字列、配列	エラーメッセージ

レスポンスの例

{
  "status": "1001",
  "message": "正常終了",
  "contents": {
    "push_send_cnt": 100
  }
}