API Push v4

• Envoyez une notification ou un message à un seul appareil ou à une liste d'appareils

• Le contenu du push ne peut être qu'un seul objet push au format JSON

• Pour les fonctions liées aux tags/alias, veuillez vous référer à AppPushAPI.

Limites de fréquence des requêtes

Notre API impose des limites sur la fréquence des appels 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 payante nécessite une limite QPS supérieure, veuillez contacter notre équipe commerciale : Sales@engagelab.com.

Validation des appels

Pour plus d'informations, consultez la méthode d'authentification

Adresse d'appel

              
              POST v4/push

            

Exemples de requêtes

En-tête de la requête

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

            

Corps de la requête

              
              {
    "from": "push",
    "to": "all",
    "body": {
        "platform": "web",
        "notification": {
            "alert": "Hi,MTPush !",
            "web": {
                "alert": "web_push",
                "title": "web_push",
                "url": "http://www.google.com",
                "extras": {
                    "web-key1": "web-value1"
                }
            }
        }
    },
    "request_id": "12345678",
    "custom_args": {
        "business": "info"
    }
}

            

Paramètres de la requête

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

from

L'expéditeur du business actuel. La valeur est de type String et est optionnelle.

Exemples de requêtes

              
              {
    "from": "push"
}

            

to

Objet de l'appareil cible du push, indiquant la liste des appareils à qui le push peut être envoyé. Confirmez l'objet de l'appareil cible. MTPush propose deux méthodes : Registration ID et diffusion.

Cible du push

"to" : {"tag" : [ "tag1", "tag2"],
"tag_and" : ["tag3", "tag4"],
"tag_not" : ["tag5", "tag6"]
}

Exemples de requêtes

• Push vers tous (diffusion)：

              
              {
  "to": "all"
}

            

• Push vers plusieurs registration_id：

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

            

body

Le corps de la requête. Les champs pris en charge sont les suivants：

platform

MTPush prend actuellement en charge uniquement le push sur la plateforme Web, donc la valeur du mot-clé platform est "web".

              
              { "platform" : "web" }

            

notification

L'objet notification est l'un des objets de contenu de push (l'autre étant message) et est envoyé sur le web en tant que notification.

web

Notifications sur la plateforme Web

              
              {
    "notification": {
        "web": {
            "alert": "hello, Push!",
            "title": "Test Push",
            "url": "http://www.google.com",
            "icon": "",
            "image": "",
            "extras": {
                "news_id": 134,
                "my_key": "une valeur"
            }
        }
    }
}

            

message

Messages In-App ou messages personnalisés. Cette partie du contenu n'est pas affichée dans le navigateur. Après réception, le SDK le transmet au Web, qui traite la logique business.

Le message contient les champs suivants：

Exemple：

              
              {
  "message": {
    "msg_content": "Hi,Push",
    "content_type": "text",
    "title": "msg",
    "extras": {
      "key": "valeur"
    }
  }
}

            

options

Options de push. Les options suivantes sont disponibles：

multi_language

Ce champ correspond à la fonction de push multilingue du service Push EngageLab. Il vous permet d'envoyer un contenu de notification personnalisé selon la langue de l'utilisateur. En spécifiant plusieurs langues et leur contenu, titre et sous-titre iOS dans la requête, vous pouvez envoyer la notification adaptée à la langue de l'utilisateur.

Paramètres de la requête

Exemple de requête

              
              {
  "options": {
    "multi_language": {
      "en": {
        "content": "",
        "title": ""
      }
    }
  }
}

            

Exemple de réponse

              
              En cas de succès :
{
   
}

En cas d'échec :
{   
    "code": 400,  
    "data": "",
  "message": "Information d'erreur"
}   

            

web_buttons

Utilisez le paramètre web_buttons pour décrire l'id, le texte, l'icône et l'url du bouton. Les descriptions des paramètres sont les suivantes :

Exemple d'appel :

              
              [
  {
    "id": "like-button",
    "text": "Like",
    "icon": "http://i.imgur.com/N8SN8ZS.png",
    "url": "https://yoursite.com"
  },
  {
    "id": "read-more-button",
    "text": "Read more",
    "icon": "http://i.imgur.com/MIxJp1L.png",
    "url": "https://yoursite.com"
  }
]

            

third_party_channel

Ce champ sert à renseigner l'information personnalisée du canal système Web. Le nom de la clé est w3push, la valeur est un Objet Json. L'Objet contient un seul champ distribution optionnel de type String

Exemple :

              
              {
  "third_party_channel": {
    "w3push": {
      "distribution": "mtpush"
    }
  }
}

            

request_id

L'id de la requête. Le client identifie la requête et la réponse

Exemples de requêtes

              
              {
  "request_id": "12345678"
}

            

Exemple de réponse

custom_args

Champ optionnel défini par l'utilisateur. Non retourné dans la réponse, mais retourné lors du callback.

              
              {
  "custom_args": {
        "business": "info"
    }
}

            

Paramètres de réponse

Réponse de succès

              
              < HTTP/1.1 200 OK
< Content-Type: application/json
{"request_id": "18", "msg_id": "1828256757"}

            

Réponse d'échec

Le code de statut http est 4xx ou 5xx et le corps de la réponse contient les champs suivants.

              
              {
    "code": 3002,
    "message": "Le champ Push.template doit être correctement défini lorsque le type est template"
}

            

Réponse

Code de statut HTTP

Références : HTTP-Status-Code

Code de retour

Restrictions de push

Code langue multi-langue