グループプッシュ API

グループプッシュAPI

説明

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

オプションのoverride_msg_id属性はサポートされていません。

グループプッシュはコンソールでのプッシュ時にスケジュールタスクの設定のみをサポートし、Schedule APIを呼び出してスケジュールタスクを設定することはサポートしていません。

呼び出し認証

HTTPヘッダー（Header）にフィールド（キー/値のペア）を追加します：

Authorization: Basic ${base64_auth_string}

              
                  Authorization: Basic ${base64_auth_string}

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

つまり、base64_auth_stringの生成アルゴリズムはbase64(username:password)です

ヘッダー名は「Authorization」で、値はbase64で変換された「username:password」のペア（途中にコロンが付きます）です。
グループプッシュAPIのシナリオでは、usernameは「group-」の接頭辞にGroupKeyを加えたもので、passwordはグループのMaster Secretです。この2つはコンソールのグループ管理-編集で確認できます。

呼び出しアドレス

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 } } }, "message": { "msg_content": "Hi,MTPush", "content_type": "text", "title": "msg", "extras": { "key": "value" } }, "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
                }
            }
        },
        "message": {
            "msg_content": "Hi,MTPush",
            "content_type": "text",
            "title": "msg",
            "extras": {
                "key": "value"
            }
        },
        "options": {
            "time_to_live": 60,
            "apns_production": false
        }
    },
    "request_id": "12345678",
    "custom_args": "business info"
}'
> POST /v4/grouppush HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

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

リクエストパラメータ

リクエストパラメータの詳細については、プッシュ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":400, "message":"エラー情報" } }

              
              {
    "error":{
            "code":400,    
            "message":"エラー情報"
    }
}

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

コード

詳細については、「プッシュAPIの作成 - 呼び出しと戻り」を参照してください。