プッシュWeb API

プッシュ通知が提供するプッシュWeb APIについて説明します。
プッシュWeb APIの呼び出し形式は以下のとおりです。

http(s)://<IMAPSサーバ>:<ポート番号>/pushidmng/機能パス

※ポート番号はデフォルトでは8153番です。

APIが返却するステータスコードは、表 A.1 APIが返却するステータスコードに示すとおりです。○は返却される値です。

表 A.1 APIが返却するステータスコード
コード	意味(W3C)	本APIでの意味	登録ID情報取得	登録IDの一覧取得	登録IDの削除	メッセージ送信	蓄積メッセージ参照	共通メッセージ送信	登録IDの検索	IMAPSプッシュID更新	デバイストークン登録/更新	registrationID登録/更新
200	OK	処理成功	○	○	○	○	○	○	○	○	－	－
201	Created	生成処理成功	－	－	－	－	－	－	－	－	○	○
400	Bad Request	リクエスト違反	○	○	○	○	○	○	○	○	○	○
404	Not Found	リソースがない	○	○	○	○	○	○	○	○	○	○
500	Internal Server Error	そのほかのエラー	○	○	○	○	○	○	○	○	○	○

表 A.2 APIが返却するステータスコード
コード	意味(W3C)	本APIでの意味	チャネルURI登録/更新	メッセージIDからのメッセージ情報の取得	登録IDからのメッセージ情報の取得	既読件数の取得
200	OK	処理成功	－	○	○	○
201	Created	生成処理成功	○	－	－	－
400	Bad Request	リクエスト違反	○	○	○	○
404	Not Found	リソースがない	○	○	○	○
500	Internal Server Error	そのほかのエラー	○	○	○	○

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

ステータスコードへの対処方法は以下のとおりです。

コード	対処方法
200(注)	処理成功です。特に対処は必要ありません。
201	生成処理成功です。特に対処は必要ありません。
400	パラメーターが誤っています。レスポンスのメッセージを元に、メッセージ集を参照して対処を実施してください。メッセージログ(im_msg.log)を参照し、Web APIを実行した時間帯にメッセージが出力されていないか確認してください。
404	正しいURLを指定しているか確認してください。レスポンスのメッセージを元に、メッセージ集を参照して対処を実施してください。メッセージログ(im_msg.log)を参照し、Web APIを実行した時間帯にメッセージが出力されていないか確認してください。
500	レスポンスのメッセージを元に、メッセージ集を参照して対処を実施してください。メッセージログ(im_msg.log)を参照し、Web APIを実行した時間帯にメッセージが出力されていないか確認してください。

注）A.14 メッセージの送信（非推奨）の場合、ステータスコード、メッセージの他、各登録IDのステータスコード、メッセージがレスポンスとして返ります。ステータスコードが200の場合であっても、各登録IDのステータスコード、メッセージを確認する必要があります。

注意

付録A プッシュWeb API