Créer une API push

Poussez une notification ou un message vers un seul appareil ou une liste d'appareils. Le contenu envoyé ne peut être qu'un objet push représenté en JSON.

Limites de fréquence des requêtes

Notre API impose des limites de fréquence d'appel afin de garantir la stabilité et l'équité du service. Les limites QPS (requêtes par seconde) pour chaque AppKey sont les suivantes :

• Limite standard : 500 requêtes maximum par seconde.
• Limite avancée : Si vous êtes abonné à notre offre payante et que votre AppKey payant nécessite une limite QPS plus élevée, veuillez contacter notre équipe commerciale : Sales@engagelab.com.

Méthode de requête

POST

Adresse d'appel

L'adresse du service d'interface correspond point à point au point d'accès sélectionné du centre de données. Veuillez sélectionner l'adresse d'appel correspondant au point d'accès de service de votre application.

Actuellement, EngageLab a déployé et prend en charge deux points d'accès de centres de données, et les données entre différents points d'accès de service sont totalement isolées. Vous pouvez sélectionner l'adresse d'appel en fonction du point d'accès du centre de données choisi lors de la création du produit.

              
              POST v4/push

            

Validation de l'appel

Pour plus d'informations, consultez la vue d'ensemble de l'API REST dans la description de la Méthode d'authentification.

Exemple de requête

En-tête de requête

              
              > POST /v4/push HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

            

Corps de la requête

              
              {
    "from": "push",
    "to": "all",
    "body": {
        "platform": "all",
        "notification": {
            "alert" :"Hello, Push!",
            "android": {
                "alert": "Hi, Push!",
                "title": "Envoyer à Android",
                "builder_id": 1,
                "extras": {
                    "newsid": 321
                }
            },
            "ios": {
                "alert": "Hi, MTPush!",
                "sound": "default",
                "badge": "+1",
                "extras": {
                    "newsid": 321
                }
            }
        },
        "options": {
            "time_to_live": 60,
            "apns_production": false
        }
    },
    "request_id": "12345678",
    "custom_args":{
             "Engagelab": "push to you"
    }
}

            

Paramètres de la requête

La structure des paramètres du push, comme détaillé dans le tableau suivant :

from

Expéditeur du service actuel, de type String, champ optionnel.

Exemple de requête

              
              {
    "from":"push"
}

            

to

Objet Appareil Push, qui indique la liste des appareils vers lesquels un push peut être envoyé. Pour confirmer l'objet appareil push, App Push propose plusieurs méthodes, telles que : alias, tag, registration ID, sous-groupe, diffusion, etc.

Cible de push

Il existe plusieurs façons de choisir un équipement en dehors de la diffusion, comme suit :

Exemple

• Push vers tous (diffusion) :

              
              {
  "to": "all"
}

            

• Push vers plusieurs tags (si l'un des tags est satisfait) : à Shenzhen, Guangzhou ou Pékin

              
              {
    "to":{
        "tag":[
            "Shenzhen",
            "Guangzhou",
            "Beijing"
        ]
    }
}

            

• Push vers plusieurs tags (doit être dans la plage de plusieurs tags en même temps) : à Shenzhen et "femme"

              
              {
    "to":{
        "tag_and":[
            "Shenzhen",
            "female"
        ]
    }
}

            

• Push vers plusieurs alias :

              
              {
    "to":{
        "alias":[
            "4314",
            "892",
            "4531"
        ]
    }
}

            

• Push vers plusieurs IDs d'inscription :

              
              {
  "to": {
    "registration_id": [
      "4312kjklfds2",
      "8914afd2",
      "45fdsa31"
    ]
  }
}

            

• Peut être poussé simultanément vers plusieurs types de cibles : à Shenzhen ou Guangzhou et sont "femmes" "membres"

              
              {
    "to":{
        "tag":[
            "Shenzhen",
            "Guangzhou"
        ],
        "tag_and":[
            "female",
            "members"
        ]
    }
}

            

• Push d'un message d'activité en temps réel

              
                {
      "to": {
          "live_activity_id": "LiveActivity-1"
      }
  }

            

Push vers un ID de segmentation utilisateur :

              
              {
  "to": {
    "seg": {
      "id":"segid"
    }
  }
}

            

Body

Corps de la requête d'envoi. Les champs pris en charge sont les suivants :

Plateforme

MTPush prend actuellement en charge le push pour les plateformes Android, iOS et HarmonyOS. Les mots-clés sont : "android", "ios", "hmos".

Push vers toutes les plateformes :

              
              { "platform" : "all" }

            

Désignation de plateformes spécifiques :

              
              {
  "platform": [
    "android",
    "ios",
    "hmos"
  ]
}

            

Notification

L'objet "Notification", qui est l'un des objets de contenu d'une push (l'autre étant "Message"), est envoyé au client en tant que "Notification".

Alert

La propriété "alert" à cet emplacement (directement sous l'objet notification) est une définition raccourcie, et si le message d'alerte est identique sur toutes les plateformes, l'alerte peut ne pas être définie sous la plateforme, et cette valeur primera. Si une définition est présente pour chaque plateforme, elle la remplacera.

              
              {
  "notification" : {
    "alert" : "Hello, Push!"
  }
}

            

L'objet notification défini ci-dessus sera envoyé vers plusieurs plateformes spécifiées par "platform" et toutes auront le même message d'alerte.

Android

Les notifications sur la plateforme Android sont affichées par le SDK MTPush selon des styles spécifiques de barre de notification. Les champs pris en charge sont les suivants :

              
              {
    "notification": {
        "android": {
            "alert": "hello, MTPush!",
            "title": "Test push",
            "builder_id": 3,
            "style": 1,
            "big_text": "contenu grand texte",
            "inbox": Objet JSON,
            "big_pic_path": "url image",
            "priority": 0,
            "category": "catégorie str",
            "large_icon": "http://pushapi-sgp.engagelab.comlargeIcon.jpg",
            "small_icon": "http://www.small.com/small_icon.jpg",
            "intent": {
                "url": "intent:#Intent;component=push.pushapi-sgp.engagelab.com/com.example.mtpushdemo.SettingActivity;end"
            },
            "extras": {
                "news_id": 134,
                "my_key": "a value"
            }
        }
    }
}