B.4.2 レスポンス

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

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

ボディ

以下の形式です。

{
    "response": {
        "code": "HTTPのステータスコード",
        "message": "メッセージ"
    }
    "success": 成功数,
    "failure": 失敗数,
    "responses": [
        {
            "regID": "登録ID",
            "response": {
                "code": "各登録IDのステータスコード",
                "message": "各登録IDのメッセージ"
            }
        },
        ...
    ]
}

変数名	説明	型
response	レスポンス	－
code	HTTPのステータスコード	int
message	メッセージ	String
success	成功数	int
failure	失敗数	int
responses	送信結果	JSON配列
regID	登録ID	String
response	レスポンス	－
code	各登録IDのステータスコード	int
message	各登録IDのメッセージ	String

各登録IDのステータスコードについて

返却するHTTPのステータスコードは以下のとおりです。○は返却される値です。

コード	意味(W3C)	本APIでの意味	IMAPSプッシュ	APNs	GCM
200	OK	処理成功	○	○	○
400	Bad Request	リクエスト違反	○	○	○
404	Not Found	リソースがない	○	○	○
500	Internal Server Error	その他のエラー	○	○	○

メッセージの内容は以下のとおりです。

コードが200番台：空文字

コードが200番台以外：プッシュのエラーコード、メッセージ

メッセージが最大サイズを超えた場合の振る舞い: 定義ファイル情報（impush.properties）のfj_push_message_fail_send_exitのステータスがtrueの場合、送信メッセージの形式に誤りがあると指定した登録IDへ1件もメッセージを送りません。falseの場合は、送信可能な登録IDへはメッセージを送ります。

APNs、GCMへの送信に失敗した場合

APNsへのメッセージ送信に失敗した場合は、APNsの公式サイトやマニュアルを確認してください。
GCMへのメッセージ送信に失敗した場合は、GCMの公式サイトやマニュアルを確認してください。

リクエストの内容に問題があった場合の振る舞い

以下の場合、レスポンスで返ってくるsuccess,failureそれぞれの値は0となります。

リクエストのボディやFJP,APNs,GCMの送信メッセージがJSON形式でない場合
リクエストのボディにregIDsの変数名が存在しない又は宛先数が0件の場合