リモート通知の送信を RESTful API で行う
概要
RESTful API を用いて、ユーザー宛にリモート通知を送信することが出来ます。
 | リモート通知は定型文のみの利用が可能です。 |
 | RESTful API を用いたリモート通知送信のサンプルはこちらになります。RemoteNotificationSample-Server_20160112.zip ※ Client Credentials Grant でブロードキャスト通知送信を行ったサンプルになります。 |
URI Fragment
Sandbox
https://sb-app.mobage.jp/social/api/restful/v2/remote_notification/@app/\{groupId\}
https://sb-app.mobage.jp/social/api/restful/v2/remote_notification/@app/@all/\{recipientId\}
本番環境
https://app.mobage.jp/social/api/restful/v2/remote_notification/@app/\{groupId\}
https://app.mobage.jp/social/api/restful/v2/remote_notification/@app/@all/\{recipientId\}
| パラメータ名 | 型 | 説明 |
|---|---|---|
| groupId | 文字列 | @all、@android、@ios のいずれか指定できます。 |
| recipientId | ユーザ ID | 単一ユーザ指定でリモート通知を送信する場合、送信対象のユーザ ID |
署名方式
- Client Credentials Grant
- Authorization Code Grant
 | Authorization Code Grant ではブロードキャスト（@all、@android、@ios）送信ができません。 |
HTTP メソッド
- Client Credentials Grant
- POST Remote Notification の送信
- Authorization Code Grant
- POST Remote Notification の送信
リクエストヘッダー
- Authorization ヘッダーは必須になります。
- Content-Type: application/json; charset=utf-8
URL クエリパラメータ
なし
リクエスト本文
下記パラメータを持つ JSON 文字列。詳細については下記実例をご参照下さい。
| 名前 | 型 | 説明 | 必須 |
|---|---|---|---|
| recipientId | ユーザ ID 配列 | ユーザ指定でリモート通知を送信する場合、最大 1000 人のユーザを対象に配列に指定できます。 @all、@android、@iOS と併用。 | No |
| payload | オブジェクト | 下記リモート通知の内容や設定などを含むオブジェクト。 | Yes |
| payload.message | 文字列 | リモート通知のメッセージ内容です。通知バーに表示されます。 UTF-8の文字列で指定してください。 | Yes |
| payload.badge | 数値 | iOS のみ。 iOS端末にリモート通知が送信された場合、badge の数値は受信側のアイコンのバッジとして 使用されます。badge が指定されない場合は数字は特に送信されません。 Android端末の場合は、badge が送信されても影響は有りません。 | No |
| payload.sound | 文字列 | iOS のみ。 iOS端末にリモート通知が送信された場合、受信側の警告音として使用されます。 sound はアプリケーションに含まれた音声ファイル名になります。 音声ファイルが存在しない場合、"default"が指定された場合、デフォルトの警告音が再生されます。 Android端末の場合は、sound が指定されていても無視され音は再生されません。 | No |
| payload.collapseKey | 文字列 | Android のみ。 | No |
| payload.style | 文字列 | Android のみ。 Android端末にリモート通知が送信された場合、通知領域のスタイルとして使用されます。 スタイルが指定されていない、またはスタイルが使用できない場合は、 デフォルトのスタイルが指定されます。有効なスタイルは"normal"と"largeIcon"になります。 Native / Unity SDK の場合、Android 2.3以上でのみ使用できます。 詳細につきましては、こちらをご確認下さい。iOS端末の場合は、style が指定されていても無視されます。 | No |
| payload.iconUrl | 文字列 | Android のみ。 Android端末にリモート通知が送信された場合、かつ style が指定されている場合、iconUrl は、 Androidの通知領域に表示されるイメージを決定するために使用されます。 iOS端末の場合は、iconUrl が指定されていても無視されます。 | No |
| payload.extras | オブジェクト | 任意の1階層分の連想配列を Key/Value の形式で設定することができます。 例）{ "foo" : "1", "bar" : "twenty one" } | No |
レスポンスコード
HTTP ステータスコード |
HTTP ステータスメッセージ |
説明 |
|---|---|---|
201 |
Created |
データの作成が成功した場合 |
202 |
Accepted |
データの更新が成功した場合 |
400 |
Bad Request |
クライアント側のリクエストデータが不正です |
401 |
Unauthorized |
認証エラーです |
403 |
Forbidden |
リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
404 |
Not Found |
存在しないリソースです |
429 |
Too Many Requests |
リクエスト数が制限を超えた場合です |
500 |
Internal Server Error |
API サーバー側のエラーです |
503 |
Service Unavailable |
一時的に API が利用不可となっている場合です |
レスポンス本文
- リモート通知の送信結果。空の場合があります。
- Content-Type: application/json; charset=utf-8
実例
アプリの全ユーザにブロードキャスト通知送信（Client Credentials Grant）
限定された複数ユーザにブロードキャスト通知送信（Client Credentials Grant）
Game-to-User リモート通知を一人のユーザに送信します（Client Credentials Grant）
User-to-User リモート通知を一人のユーザに送信します（Authorization Code Grant）
更新履歴
- 2015/01/12
- リクエスト方法が Client Credentials Grant 、Authorization Code Grant になっていなかったため修正。