グループプッシュAPI

機能概要

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

option 内の override_msg_id プロパティは、現在サポートされていません。

グループプッシュでは、スケジュールタスクを設定できるのはコンソールからプッシュする場合のみです。Schedule API によるスケジュールタスクの設定はサポートされていません。

認証

HTTP ヘッダーに以下の Key/Value ペアを追加します。

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

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

上記の base64_auth_string の生成アルゴリズムは base64(username:password) です。
ヘッダー名は Authorization、値は Base64 変換された username:password のペアです（間にコロンが入ります）。
Group Push API のシナリオでは、username は group- プレフィックスに GroupKey を加えたもので、password は Group Master Secret です。どちらもコンソールの [Group Management] - [Edit] で確認できます。

エンドポイント

POST v4/grouppush

              
              POST v4/grouppush

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

リクエスト例

curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/grouppush \ -H "Content-Type: application/json" \ -u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" \ -d '{ "from": "push", "to": "all", "body": { "platform": "web", "notification": { "alert": "Hi,MTPush !", "web": { "title": "web_push", "url": "http://www.google.com", "extras": { "web-key1": "web-value1" } } } }, "request_id": "12345678", "custom_args": "business info" }' > POST /v4/grouppush HTTP/1.1 > Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

              
              curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/grouppush \
-H "Content-Type: application/json" \
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" \
-d '{
    "from": "push",
    "to": "all",
    "body": {
        "platform": "web",
        "notification": {
            "alert": "Hi,MTPush !",
            "web": {
                "title": "web_push",
                "url": "http://www.google.com",
                "extras": {
                    "web-key1": "web-value1"
                }
            }
        }
    },
    "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 size string or does not exist" } }

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

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

エラーコード

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