使用例

使用する登録ID、拡張データの一覧表

プッシュ種別	登録ID	拡張データ
IMAPSプッシュ	fjpRegID001	fjpExtData001
APNs	abc001	apnsExtData001
GCM	gcmRegID001	gcmExtData001
GCM	gcmRegID002	gcmExtData00
GCM	gcmRegID003	gcmExtData00

使用するテンプレートファイルの内容

message=%%replace%%message
gcm_collapse_key=abcde
gcm_time_to_live=10000
gcm_delay_while_idle=false
gcm_title=default_title
apns_sound=bingbong.aiff
apns_badge=1
fjp_action= http://example.com/

例1-1) IMAPSプッシュの登録ID(fjpRegID001)、APNsの登録ID(abc001)、GCM（gcmRegID001）にテンプレートファイル名を指定して同一のメッセージを送信する場合

http(s)://(server):(port)/pushidmng/notifyCommon
{
"message":"メッセージ001",
"templateFile":"exampleTmp.template",
"regIDs":["fjpRegID001","abc001","gcmRegID001"]
}

例1-2) 実際に送信されるメッセージ情報

- IMAPSプッシュ
{
    "message":"メッセージ001",
    "action":"http://example.com/"
}

- APNs
{
    "aps":{
        "alert":{
              "body":"メッセージ001"
        },
    "sound":"bingbong.aiff",
    "badge":1
    }
}

- GCM
{
    "collapse_key":"abcde",
    "time_to_live":10000,
    "delay_while_idle":"false",
    "data":{
        "title":"default_title"
         "message":"メッセージ001"
    },
    "registration_ids":["gcmRegID001"]
}

例1-3) レスポンス例

{
    "response": {"code": "200", "message": ""},
    "success": 3,
    "failure": 0,
    "responses": [
        { "regID":"fjpRegID001","extData":"","response": {"code": "200", "message": ""}},
        { "regID":"abc001","extData":"","response": {"code": "200", "message": ""}},
        { "regID":"gcmRegID001","extData":"","response": {"code": "200", "message": ""}}
    ]
}

例2-1) IMAPSプッシュの拡張データ(fjpExtData001)、APNsの拡張データ(apnsExtData001)、GCMの拡張データ（gcmExtData001）にメッセージを送信し、messageOptionsも合わせて指定する場合

http(s)://(server):(port)/pushidmng/notifyCommon
{
    "message":"メッセージ002",
    "messageOptions":{
        "gcm_title":"タイトル002",
        "apns_action":"http://example.com/",
        "apns_badge":5
    },
    "extData":["fjpExtData001","apnsExtData001","gcmExtData001"]
}

例2-2) 実際に送信されるメッセージ情報

- IMAPSプッシュ
{
    "message":"メッセージ002"
}

- APNs
{
    "aps":{
        "alert":{
              "body":"メッセージ002"
        },
    "badge":5
    },
    "action":"http://example.com/"
}

- GCM
{
    "data":{
        "title":"タイトル002",
        "message":"メッセージ002"
    },
    "registration_ids":["gcmRegID001"]
}

例2-3) レスポンス例

{
    "response": {"code": "200", "message": ""},
    "success": 3,
    "failure": 0,
    "responses": [
        { "regID":"fjpRegID001","extData":"fjpExtData001","response": {"code": "200", "message": ""}},
        { "regID":"abc001","extData":"apnsExtData001","response": {"code": "200", "message": ""}},
        { "regID":"gcmRegID001","extData":"gcmExtData001","response": {"code": "200", "message": ""}}
    ]
}

例3-1) IMAPSプッシュの登録ID(fjpRegID001)、APNsの登録ID(abc001)、GCM（gcmRegID001）にテンプレートファイルを指定し、置換文字列を指定してメッセージを送信する場合

http(s)://(server):(port)/pushidmng/notifyCommon
{
    "message":"%%replaceStr%%メッセージ003",
    "replace":{"replaceStr":"ExampleMsg"},
    "templateFile":" exampleTmp.template ",
    "regIDs":["fjpRegID001","abc001","gcmRegID001"]
}

例3-2) 実際に送信されるメッセージ情報

- IMAPSプッシュ
{
    "message":"ExampleMsgメッセージ003",
    "action":"http://example.com/"
}

- APNs
{
    "aps":{
        "alert":{
              "body":"ExampleMsgメッセージ003"
        },
    "sound":"bingbong.aiff",
    "badge":1
    }
}

- GCM
{
    "collapse_key":"abcde",
    "time_to_live":10000,
    "delay_while_idle":"false",
    "data":{
        "title":"default_title"
         "message":"ExampleMsgメッセージ003"
    },
    "registration_ids":["gcmRegID001"]
}

例3-3) レスポンス例

{
    "response": {"code": "200", "message": ""},
    "success": 3,
    "failure": 0,
    "responses": [
        { "regID":"fjpRegID001","extData":"","response": {"code": "200", "message": ""}},
        { "regID":"abc001","extData":"","response": {"code": "200", "message": ""}},
        { "regID":"gcmRegID001","extData":"","response": {"code": "200", "message": ""}}
    ]
}

B.9.3 使用例