Gruppen-Push-API

Funktionsbeschreibung

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

Das Attribut override_msg_id in option wird derzeit nicht unterstützt.

Gruppen-Push unterstützt geplante Aufgaben nur, wenn Nachrichten über die Konsole gesendet werden. Das Einrichten geplanter Aufgaben durch Aufruf der Schedule API wird nicht unterstützt.

Aufrufauthentifizierung

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

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Diesen Codeblock im schwebenden Fenster anzeigen

Mit anderen Worten: Die oben genannte base64_auth_string wird mit dem folgenden Algorithmus erzeugt: base64(username:password).

Der Header-Name ist Authorization, und der Wert ist das Base64-kodierte Paar username:password (mit einem Doppelpunkt in der Mitte).

Im Szenario der Group Push API ist username das Präfix group- plus der GroupKey, und password ist das Group Master Secret. Beide können in der Konsole unter Group Management > Edit eingesehen werden.

Request-URL

POST v4/grouppush

              
              POST v4/grouppush

Diesen Codeblock im schwebenden Fenster anzeigen

Anfragebeispiel

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

Diesen Codeblock im schwebenden Fenster anzeigen

Anforderungsparameter

Zu den Anforderungsparametern siehe 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-character string or does not exist" } }

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

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Einzelheiten finden Sie unter Create Push API - Call Response.