B.2.2 レスポンス

ステータスコード: 「APIが返却するHTTPのステータスコード」を参照してください。

ヘッダー: Content-Type: application/json; charset=UTF-8

ボディ

以下の形式です。

{
    "response": {
        "code": " HTTPのステータスコード",
        "message": "メッセージ"
    },
    "dataCount": {
        "totalCount": "全件数",
        "currentCount": "通知件数"
    },
    "regIDs": [
        {
          "regID": "登録ID",
          "extData":"拡張データ"
        },
        {
          "regID": "登録ID",
          "extData":"拡張データ"
        },
        {
          "regID": "登録ID",
          "extData":"拡張データ"
        },
        ...
    ]
}

変数名	説明	型	指定値、または例
response	レスポンス	－
code	HTTPのステータスコード	int
message	メッセージ	String
dataCount	件数	－
totalCount	全件数	int	条件に一致する件数
currentCount	通知件数	int	レスポンスに含む件数
regIDs	登録IDのリスト	配列	IMAPSプッシュ、APNs、GCMの全ての登録IDを出力する
regID	登録ID	String
extData	拡張データ。受信対象の識別情報を追加する場合に使用する。	String	最大1024byte 半角英数字＋記号

注意事項

一覧取得処理中に登録IDが削除されると、以下の不整合が発生する場合があります。登録IDの削除業務との同時実行は行わないようにしてください。

全件数が通知件数より少ない。
削除された登録ID以降の数件のデータが通知されない。