グループプッシュAPI

機能説明

このAPIは、アプリケーショングループ向けのプッシュ通知を作成するために使用します。1回の呼び出しで、グループ内のすべてのアプリケーションにメッセージをプッシュできます。

option 内の override_msg_id 属性は現在サポートされていません。

グループプッシュでスケジュールタスクがサポートされるのは、コンソールからメッセージを送信する場合のみです。Schedule API を呼び出してスケジュールタスクを設定することはサポートされていません。

呼び出し認証

HTTPヘッダーに次のフィールド（キーと値のペア）を追加します。

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

このコードブロックはフローティングウィンドウ内に表示されます

つまり、上記の base64_auth_string は、次のアルゴリズム base64(username:password) を使用して生成されます。

ヘッダー名は Authorization、値は Base64 エンコードされた username:password のペア（中央にコロンを含む）です。

Group Push API のシナリオでは、username は GroupKey に group- プレフィックスを付加したもの、password は Group Master Secret です。いずれもコンソールの Group Management > Edit で確認できます。

リクエストURL

POST v4/grouppush

              
              POST v4/grouppush

このコードブロックはフローティングウィンドウ内に表示されます

リクエスト例

curl --insecure -X POST -v https://pushapi-sgp.engagelab.com/v4/grouppush -H "Content-Type: application/json" -u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" -d '{ "from": "push", "to": "all", "body": { "platform": "all", "notification": { "android": { "alert": "Hi, Push!", "title": "Send to Android", "builder_id": 1, "extras": { "newsid": 321 } }, "ios": { "alert": "Hi, MTPush!", "sound": "default", "badge": "+1", "extras": { "newsid": 321 } }, "hmos": { "alert": "Hi, MTPush!", "title": "", "category": "", "intent": {"url": ""}, "badge_add_num": 1, "test_message": true, "receipt_id": "", "extras": {}, "style": 0, "inbox_content": [], "push_type": 0, "extra_data": "", "display_foreground": "" } } }, "options": { "time_to_live": 60, "apns_production": false }, "request_id": "12345678", "custom_args": "business info" }' > POST /v4/grouppush HTTP/1.1 > Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

              
              curl --insecure -X POST -v https://pushapi-sgp.engagelab.com/v4/grouppush -H "Content-Type: application/json" -u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" -d 
'{
    "from": "push",
    "to": "all",
    "body": {
        "platform": "all",
        "notification": {
            "android": {
                "alert": "Hi, Push!",
                "title": "Send to Android",
                "builder_id": 1,
                "extras": {
                    "newsid": 321
                }
            },
            "ios": {
                "alert": "Hi, MTPush!",
                "sound": "default",
                "badge": "+1",
                "extras": {
                    "newsid": 321
                }
            },
            "hmos": {
                "alert": "Hi, MTPush!",
                "title": "",
                "category": "",
                "intent": {"url": ""},
                "badge_add_num": 1,
                "test_message": true,
                "receipt_id": "",
                "extras": {},
                "style": 0,
                "inbox_content": [],
                "push_type": 0,
                "extra_data": "",
                "display_foreground": ""
            }
        }
    },
    "options": {
        "time_to_live": 60,
        "apns_production": false
    },
    "request_id": "12345678",
    "custom_args": "business info"
}'
> POST /v4/grouppush HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

リクエストパラメータの詳細については、Create Push API を参照してください。

レスポンス例

成功レスポンス

{ "0c3de43c6a6b68c9f4261b06": {"request_id":"12345678","msg_id":"2460001"}, "35c424abde12f475566ca8af": {"request_id":"12345678","msg_id":"2460001"}, "8f02a4fa717a6235734d92de": {"request_id":"12345678","msg_id":"2460001"}, "group_msgid": "cbou2uum98lps87rtic0" }

              
              {
    "0c3de43c6a6b68c9f4261b06": {"request_id":"12345678","msg_id":"2460001"},
    "35c424abde12f475566ca8af": {"request_id":"12345678","msg_id":"2460001"},
    "8f02a4fa717a6235734d92de": {"request_id":"12345678","msg_id":"2460001"},
    "group_msgid": "cbou2uum98lps87rtic0"
}

このコードブロックはフローティングウィンドウ内に表示されます

失敗レスポンス

{ "error": { "code": 21037, "message": "group_key is not a 24-character string or does not exist" } }

              
              {
    "error": {
        "code": 21037,
        "message": "group_key is not a 24-character string or does not exist"
    }
}

このコードブロックはフローティングウィンドウ内に表示されます

エラーコード

詳細については、Create Push API - Call Response を参照してください。