プッシュ通知が提供するプッシュWeb APIについて説明します。
プッシュWeb APIの呼び出し形式は以下のとおりです。
http(s)://<IMAPSサーバ>:<ポート番号>/pushidmng/機能パス
※ポート番号はデフォルトでは8153番です。
APIが返却するHTTPのステータスコードは以下のとおりです。○は返却される値です。
コード | 意味(W3C) | 本APIでの意味 | 登録ID情報取得 | 登録IDの一覧取得 | 登録IDの削除 | メッセージ送信 | 蓄積メッセージ参照 |
|---|---|---|---|---|---|---|---|
200 | OK | 処理成功 | ○ | ○ | ○ | ○ | ○ |
201 | Created | 生成処理成功 | － | － | － | － | － |
400 | Bad Request | リクエスト違反 | ○ | ○ | ○ | ○ | ○ |
404 | Not Found | リソースがない | ○ | ○ | ○ | ○ | ○ |
500 | Internal Server Error | その他のエラー | ○ | ○ | ○ | ○ | ○ |
メッセージの内容は以下のとおりです。
コードが200番台 ：空文字
コードが200番台以外：プッシュのエラーコード、メッセージ
HTTPのステータスコードへの対処方法は以下のとおりです。
コード | 対処方法 |
200(注) | 処理成功です。特に対処は必要ありません。 |
201 | 生成処理成功です。特に対処は必要ありません。 |
400 | ・パラメーターが誤っています。レスポンスのメッセージを元に、メッセージ集を参照して対処を実施してください。 ・メッセージログ(im_msg.log)を参照し、Web APIを実行した時間帯にメッセージが出力されていないか確認してください。 |
404 | ・正しいURLを指定しているか確認してください。 ・レスポンスのメッセージを元に、メッセージ集を参照して対処を実施してください。 ・メッセージログ(im_msg.log)を参照し、Web APIを実行した時間帯にメッセージが出力されていないか確認してください。 |
500 | ・レスポンスのメッセージを元に、メッセージ集を参照して対処を実施してください。 ・メッセージログ(im_msg.log)を参照し、Web APIを実行した時間帯にメッセージが出力されていないか確認してください。 |
注）B.4 メッセージの送信 の場合、HTTPのステータスコード、メッセージの他、各登録IDのステータスコード、メッセージがレスポンスとして返ります。HTTPのステータスコードが200の場合であっても、各登録IDのステータスコード、メッセージを確認する必要があります。
