API de notification de groupe

Description

Cette API est utilisée pour créer un envoi groupé. Un appel peut envoyer des messages à toutes les applications du groupe.

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

L'envoi groupé ne permet de définir des tâches planifiées que lors de l'envoi via la console, mais ne prend pas en charge l'appel de l'API Schedule pour définir des tâches planifiées.

Validation de l'appel

Ajoutez un champ (paire Clé/Valeur) dans l'en-tête HTTP (Header) :

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 est base64(username:password)

Le nom de l'en-tête est "Authorization" et la valeur est une paire "username:password" convertie en base64 (avec deux-points au milieu).
Dans le cas de l'API d'envoi groupé, le nom d'utilisateur est le préfixe "group-" suivi de GroupKey, et le mot de passe est le Master Secret du groupe. Vous pouvez consulter ces deux informations dans la gestion du groupe - édition dans la console.

Adresse d'appel

POST v4/grouppush

Exemples de requêtes

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": "Envoyer sur 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": "informations commerciales" }' > 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": "Envoyer sur 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": "informations commerciales"
}'
> 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 plus d'informations sur les paramètres de la requête, consultez Créer Push API.

Exemple de réponse

Succès

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

Échec

{ "error":{ "code":400, "message":"Message d'erreur" } }

              
              {
    "error":{
            "code":400,    
            "message":"Message d'erreur"
    }
}

Afficher ce bloc de code dans la fenêtre flottante

Codes

Pour plus d'informations, consultez Créer Push API - Appel et Retour.