API de notification de groupe

Description

Cette API est utilisée pour créer une notification push de groupe. Un appel peut envoyer des messages à toutes les applications du groupe.

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

La notification push de groupe ne prend en charge la planification des tâches programmées que lors de l'envoi depuis la console, mais ne prend pas en charge l'appel de l'API Schedule pour définir des tâches programmé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 la paire "username:password" convertie en base64 (avec deux-points au milieu).
Dans le scénario de l'API de notification push de groupe, le username est le préfixe "group-" suivi de GroupKey, et le password est le Master Secret du groupe. Vous pouvez consulter ces deux éléments dans Gestion de groupe > Modifier dans la console.

Adresse d'appel

POST v4/grouppush

Exemples de requêtes

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": "all", "notification": { "android": { "alert": "Hi, Push!", "title": "Envoyer à Android", "builder_id": 1, "extras": { "newsid": 321 } }, "ios": { "alert": "Hi, MTPush!", "sound": "default", "badge": "+1", "extras": { "newsid": 321 } } }, "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 business" }' > 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": "all",
        "notification": {
            "android": {
                "alert": "Hi, Push!",
                "title": "Envoyer à Android",
                "builder_id": 1,
                "extras": {
                    "newsid": 321
                }
            },
            "ios": {
                "alert": "Hi, MTPush!",
                "sound": "default",
                "badge": "+1",
                "extras": {
                    "newsid": 321
                }
            }
        },
        "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 business"
}'
> 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 une API Push.

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

{ "code":400, "data":"", "message":"message d'erreur" }

              
              {   
    "code":400,    
    "data":"",
  "message":"message d'erreur"
}

Afficher ce bloc de code dans la fenêtre flottante

Codes

Pour plus d'informations, consultez 「Créer une API Push - Réponse」.