API de push de groupe

Présentation de la fonctionnalité

Cette API permet de créer un push pour un groupe d’applications. En un seul appel, les messages peuvent être envoyés à toutes les applications du groupe.

La propriété override_msg_id dans option n’est actuellement pas prise en charge.

Pour le push de groupe, les tâches planifiées ne peuvent être configurées que lors d’un envoi depuis la console. La configuration de tâches planifiées via la Schedule API n’est pas prise en charge.

Authentification

Ajoutez la paire clé/valeur suivante à l’en-tête HTTP :

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Afficher ce bloc de code dans la fenêtre flottante

L’algorithme de génération de base64_auth_string ci-dessus est le suivant : base64(username:password)
Le nom de l’en-tête est Authorization, et la valeur est la paire username:password convertie en Base64 (avec deux-points entre les deux).
Dans le scénario de la Group Push API, username correspond au préfixe group- suivi de GroupKey, et password correspond au Group Master Secret. Les deux peuvent être consultés dans la console sous [Group Management] - [Edit].

Point de terminaison

POST v4/grouppush

              
              POST v4/grouppush

Afficher ce bloc de code dans la fenêtre flottante

Exemple de requête

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

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la requête

Pour les paramètres de la requête, reportez-vous à la Create Push API.

Exemple de réponse

Réponse réussie

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

Afficher ce bloc de code dans la fenêtre flottante

Réponse d’échec

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

Afficher ce bloc de code dans la fenêtre flottante

Codes d’erreur

Pour plus de détails, reportez-vous à "Create Push API - Response".