リクエスト

POST

/notifyCommon

なし

Content-Type: application/json; charset=UTF-8

以下の形式です。

{
    "message":"メッセージ",
    "replace":{"置換変数名":"置換文字列",…}（JSON形式）,
    "templateFile":"テンプレートファイル名",
    "messageOptions":メッセージオプション（JSON形式）,
    "regIDs":["登録ID",...],
    "extData":["拡張データ",...]
}

変数名	説明	省略	型	指定値、または例
message	送信する共通のメッセージ	可	String	replaceを使用する場合の例 "message":"%%name%%さん、%%age%%歳の誕生日おめでとうございます" %%は文字列として使用不可「\」を表記するときは「\\」と指定テンプレートファイルのmessageも同時指定した際は、当指定値が優先して設定される
replace	置換変数名:置換文字列のJSON形式で指定 message内の「%%」で囲まれた文字列(置換変数名)を、置換文字列に置き換える	可	String	{"name":"富士通太郎","age":"30"} messageで「%%」で囲まれた文字列がある場合は省略不可
templateFile	テンプレートファイル名	可	String	定義ファイル(impush.properties)のテンプレートファイルの格納先ディレクトリ(fj_push_template_file_dir)に格納されているファイルが対象ファイルが存在しない場合はエラーテンプレートファイルの記述内容は、6.6.1.1 テンプレートファイルを指定を参照
messageOptions	送信メッセージのオプション	可	String	GCM,APNs,FJP,WNSのメッセージに関するオプションを指定指定可能なオプションは、6.6.1.2 messageOptionsを指定を参照
regIDs	メッセージ送信先として登録IDをリストで指定 IMAPSプッシュの場合、IMAPSプッシュID APNsの場合、デバイストークン GCMの場合、registrationID WNSの場合、チャネルURI	可	Stringの配列	最大件数:定義ファイル(impush.properties)の同時指定可能な最大登録ID数(fj_push_max_num_for_address) extDataと排他
extData	メッセージ送信先として拡張データをリストで指定	可	Stringの配列	最大件数:定義ファイル(impush.properties)の同時指定可能な最大登録ID数(fj_push_max_num_for_address) regIDsと排他

注意

FJP,APNs,WNSは1件ごと（シリアル）に情報送信を行うため時間がかかります。APNs経由でメッセージを送信する時は、1件送信するごとにインターバルを設定するため、GCMやFJPと比べると特に時間がかかります。
APNsにメッセージ送信する際は、フィードバック情報も取得し、ログに出力します。
regIDsに同じ登録IDを複数件指定した場合、対象の登録IDを1件指定した場合と同じ動作になります。
スマートデバイスからプッシュ基盤サーバへの初回の接続前には、メッセージ送信を行ってもメッセージの受信、蓄積は行われませんが、レスポンスはメッセージ送信成功が返ります。
最大登録ID数(fj_push_max_num_for_address)の最大値(1000件)より多くの登録IDに送信したい場合は、呼び出し元でメッセージの送信APIを繰り返すことになります。
リクエストボディにregIDsを指定した場合、レスポンスのextDataは空文字が返ります。
リクエストボディにextDataを指定した場合、レスポンスはextDataとそれに紐付くregID情報が返ります。
extDataに同じ拡張データを複数件指定した場合、対象の拡張データを1件指定した場合と同じ動作になります。
リクエストボディにextDataを指定した場合、指定したextData、またはextDataに紐付く登録IDの件数の合計が定義ファイル(impush.properties)の最大登録ID数(fj_push_max_num_for_address)の値を超えるとエラーとなります。
msgIDは、responseのcodeが200の場合で、かつsuccessが1件以上ある場合にメッセージIDが返されます。条件を満たさない場合は空文字が返されます。
msgIDの情報が送信メッセージに付加されるため、既読機能を使用する場合は送信可能メッセージサイズが72Byte少なくなります。
メッセージサイズの上限チェックはmessageおよびreplace、messageOptions、テンプレートファイルで指定した情報に基づいて生成されたPayload情報が対象となります。上限を超えた場合はエラーとなります。上限値については下記のとおりです。
- FJP: 4096byte (FJPのPayloadがチェック対象となります)
- APNs: 2048byte (APNsのPayloadがチェック対象となります)
- GCM: 4096byte (GCMのPayloadのうち"data"部分がチェック対象となります)
- WNS: 5119byte (WNSのPayloadがチェック対象となります)
messageOptionsで指定する型が異なっている場合、エラーとなり、1件もメッセージを送信されません。指定可能な型は、6.6.1 共通メッセージ送信アプリケーションの開発を参照してください。
messageOptionsで指定するキーが未定義の場合、指定した情報は処理されません(パラメータエラーとならずクライアントにも配信されません)。指定可能な定義名は、6.6.1 共通メッセージ送信アプリケーションの開発を参照してください。
このため、プッシュのPayload仕様をユーザーアプリ側で拡張するような使い方はできません。
テンプレートファイルとmessageOptionsの両方に値が設定されている場合は、messageOptionsの値が優先されます。ただし、テンプレートファイルに異なる型が指定されるとエラーとなります。

A.9.1 リクエスト