Gruppen-Push-API

Beschreibung

Diese API ermöglicht das Erstellen einer Gruppen-Push-Benachrichtigung. Mit einem Aufruf können Sie Nachrichten an alle Anwendungen innerhalb der Gruppe senden.

Das Attribut override_msg_id im Feld Option wird nicht unterstützt.

Das Einrichten geplanter Aufgaben ist nur über die Konsole möglich, nicht jedoch über die Schedule API.

Aufruf-Validierung

Fügen Sie dem HTTP-Header-Feld (Key/Value-Paar) Folgendes hinzu:

Authorization: Basic ${base64_auth_string}

              
                  Authorization: Basic ${base64_auth_string}

Diesen Codeblock im schwebenden Fenster anzeigen

Der base64_auth_string wird durch base64-Kodierung von Benutzername:Passwort erzeugt.
Der Header-Name lautet „Authorization“ und der Wert ist das base64-kodierte Paar „Benutzername:Passwort“ (mit Doppelpunkt als Trennzeichen).
Im Fall der Gruppen-Push-API besteht der Benutzername aus dem Präfix „group-“ gefolgt vom GroupKey, das Passwort ist das Gruppen-Master-Secret. Sie finden beide Werte in der Gruppenverwaltung unter dem Menüpunkt „Bearbeiten“ in der Konsole.

API-Endpunkt

POST v4/grouppush

Beispielanfrage

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": "" } }, "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
                }
            },
            "hmos":{
                "alert": "Hi, MTPush!",
                "title": ""
            }
        },
        "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==

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Weitere Informationen zu den Anfrageparametern finden Sie unter Push-API erstellen.

Antwortbeispiele

Erfolg

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

Fehler

{ "error":{ "code":400, "message":"Fehlermeldung" } }

              
              {
    "error":{
            "code":400,    
            "message":"Fehlermeldung"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabecodes

Weitere Informationen finden Sie unter Push-API erstellen – Aufruf und Rückgabe.