リクエスト

POST

/getMsgByRegID

なし

Content-Type: application/json; charset=UTF-8

以下の形式です。

{
    "regID":"登録ID",
    "startDate":"取得対象開始日",
    "endDate":"取得対象終了日",
    "getReadKind":"未読／既読の取得方法",
    "getReqFlag":"送信リクエストボディの取得有無"
}

変数名	説明	省略	型	指定値、または例
regID	登録ID	不可	String	最大4096byte 半角英数字＋記号
startDate	取得対象開始日	可	String	"YYYY-MM-DD"の形式で指定する。指定が省略された場合、現在のシステム日付とする。
endDate	取得対象終了日	可	String	"YYYY-MM-DD"の形式で指定する。指定が省略された場合、現在のシステム日付とする。
getReadKind	未読／既読の取得方法	可	String	デフォルト値："unread" "unread":未読だけ取得 "read":既読だけ取得 "all":未読＋既読の取得
getReqFlag	送信リクエストボディの取得有無	可	boolean	デフォルト値：false true:取得する false:取得しない

注意

リクエストのボディに指定された登録IDがプッシュデータベースに存在しない場合でも、レスポンスとして処理成功（ステータスコードが200）を返します。
定義ファイル(impush.properties)の既読機能の設定(fj_push_read_mode)に既読機能を全て利用する（all）以外が指定されている状態で、リクエストのボディに指定された“送信リクエストボディの取得有無”が“true”だった場合、パラメタエラーとなります。

A.12.1 リクエスト