API de push de groupe

Description de la fonctionnalité

Cette API est utilisée pour créer des notifications push pour un groupe d’applications. En un seul appel, des messages peuvent être envoyés à toutes les applications du groupe.

L’attribut override_msg_id dans option n’est actuellement pas pris en charge.

Le push de groupe prend en charge les tâches planifiées uniquement lorsque les messages sont envoyés depuis la console. La configuration de tâches planifiées via l’appel de la Schedule API n’est pas prise en charge.

Vérification de l’appel

Ajoutez le champ suivant (paire clé/valeur) à 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

Autrement dit, le base64_auth_string ci-dessus est généré à l’aide de l’algorithme suivant : base64(username:password).

Le nom de l’en-tête est Authorization, et la valeur est la paire username:password encodée en Base64 (avec deux-points au milieu).

Dans le scénario de l’API de push de groupe, username correspond au préfixe group- suivi du GroupKey, et password correspond au Group Master Secret. Les deux peuvent être consultés dans la console sous Gestion des groupes > Modifier.

URL de requête

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

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de requête

Pour les paramètres de 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 en cas d’échec

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

Afficher ce bloc de code dans la fenêtre flottante

Codes d’erreur

Pour plus de détails, reportez-vous à Create Push API - Réponse à l’appel.