リクエスト

POST

/notify

なし

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

以下の形式です。

{
    "FJP":送信メッセージ(JSON形式) ,
    "APNs":送信メッセージ(JSON形式) ,
    "GCM":送信メッセージ(JSON形式) ,
    "regIDs":["登録ID",...],
    "extData":["拡張データ",...]
}

プッシュ部品を利用している場合の送信メッセージの形式は、6.2 受信したメッセージの表示の各プッシュのPayload仕様を参照してください。

変数名	説明	省略	型	指定値、または例
FJP	IMAPSプッシュに送信するメッセージ	可	String	最大サイズ:4096byte
APNs	APNsに送信するメッセージ	可	String	最大サイズ:2048byte
GCM	GCMに送信するメッセージ	可	String	最大サイズ:4096byte
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件指定した場合と同じ動作になります。
GCMの場合、通常は、registrationIDはJSON形式のメッセージ内の"registration_ids"変数に指定しますが、本APIでは使用できません。GCM送信メッセージ内にあるregistration_IDsの要素は、空にするか、または要素を指定せず、登録IDはregIDs変数に指定してください。
スマートデバイスからプッシュ基盤サーバへの初回の接続前は、メッセージ送信を行ってもメッセージの受信、蓄積は行われませんが、レスポンスはメッセージ送信成功が返ります。
最大登録ID数(fj_push_max_num_for_address)の最大値(1000件)より多くの登録IDに送信したい場合は、呼び出し元でメッセージの送信APIを繰り返すことになります。
FJPのメッセージbyte数の上限チェックは、FJPの送信メッセージ部分が対象となります。
APNsのメッセージbyte数の上限チェックは、APNsの送信メッセージ部分が対象となります。
GCMメッセージ文字数の上限チェックは、送信メッセージの内の変数名"data"部分が対象となります。
リクエストボディに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少なくなります。
本APIは、WNSへのメッセージ送信に対応しておりません。WNSへのメッセージ送信を行う場合はA.9 共通メッセージの送信のAPIをご利用ください。

A.14.1 リクエスト