ページの先頭行へ戻る
Interstage Mobile Application Server V1.2.0 アプリケーション開発ガイド
FUJITSU Software

B.9.1 リクエスト

メソッド
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)に格納されているファイルが対象
  • ファイルが存在しない場合はエラー
  • テンプレートファイルの記述内容は、7.6.1.1 テンプレートファイルを指定を参照

messageOptions

送信メッセージのオプション

String

regIDs

メッセージ送信先として登録IDをリストで指定

  • IMAPSプッシュの場合、IMAPSプッシュID
  • APNsの場合、デバイストークン
  • GCMの場合、registrationID

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は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)の値を超えるとエラーとなります。
  • メッセージの上限チェックはmessageおよびreplace、messageOptions、テンプレートファイルで指定した情報が対象となります。上限を超えた場合はエラーとなります。
  • messageOptionsで指定する型が異なっている場合、エラーとなり、1件もメッセージを送信されません。指定可能な型は、7.6.1 共通メッセージ送信アプリケーションの開発を参照してください。
  • テンプレートファイルとmessageOptionsの両方に値が設定されている場合は、messageOptionsの値が優先されます。ただし、テンプレートファイルに異なる型が指定されるとエラーとなります。