Gruppen-Push-API

Funktionsübersicht

Diese API wird verwendet, um einen Push für eine Anwendungsgruppe zu erstellen. Mit einem einzigen Aufruf können Nachrichten an alle Anwendungen in der Gruppe gesendet werden.

Die Eigenschaft override_msg_id in option wird derzeit nicht unterstützt.

Für Gruppen-Push können geplante Aufgaben nur beim Pushen über die Konsole konfiguriert werden. Das Festlegen geplanter Aufgaben über die Schedule-API wird nicht unterstützt.

Authentifizierung

Fügen Sie das folgende Schlüssel-Wert-Paar zum HTTP-Header hinzu:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Diesen Codeblock im schwebenden Fenster anzeigen

Der Erzeugungsalgorithmus für das oben genannte base64_auth_string lautet: base64(username:password)
Der Header-Name ist Authorization, und der Wert ist das Base64-kodierte Paar username:password (mit einem Doppelpunkt dazwischen).
Im Szenario der Gruppen-Push-API ist username das Präfix group- plus GroupKey, und password ist das Group Master Secret. Beide können in der Konsole unter [Group Management] - [Edit] eingesehen werden.

Endpunkt

POST v4/grouppush

              
              POST v4/grouppush

Diesen Codeblock im schwebenden Fenster anzeigen

Anfragebeispiel

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==

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Informationen zu den Anfrageparametern finden Sie in der Create Push API.

Antwortbeispiel

Erfolgreiche Antwort

{ "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"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlgeschlagene Antwort

{ "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"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Einzelheiten finden Sie unter "Create Push API - Response".