Passer au contenu

API de la boîte de réception des messages

getInboxMessages

Renvoie la liste des messages de la boîte de réception pour un HWID spécifié.

POST https://api.pushwoosh.com/json/1.3/getInboxMessages

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token `XXXX`	Jeton d’API de l’appareil pour accéder à l’API de l’appareil. Remplacez `XXXX` par votre véritable jeton d’API de l’appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
userId*	string	Si aucun User ID personnalisé n’est défini, utilisez le HWID.
hwid	string	Hardware ID d’un appareil pour lequel obtenir les messages de la boîte de réception.
last_code	string	Code du dernier message récupéré dans la réponse précédente. S’il est vide, les premiers messages sont renvoyés.
count	integer	Le nombre de messages à afficher dans une seule réponse ; utilisé pour la pagination. 0 pour charger tous les messages de la boîte de réception.

200

{
  "response": {
    "messages": [{                      // tableau des messages actuellement stockés dans la boîte de réception de l'utilisateur
      "inbox_id": "avde1c792cd",
      "rt": "146078676",                // date de suppression du message de la boîte de réception
      "send_date": "1459758676",        // date à laquelle le message a été enregistré dans la boîte de réception
      "order": "59138176",              // position dans l'ordre de présentation de la boîte de réception
      "title": "New Rich Media in inbox!",
      "text": "Hi! New feature is available right now!",
      "action_type": "RichMedia",
      "action_params": {                // charge utile décrivant les actions à l'ouverture du push
        "rm": "{\"url\":\"https:\/\/richmedia.pushwoosh.com\/C82F7-51FC1.zip\",\"ts\":\"1459758676\",\"tags\":{\"tagName\":\"tagValue\"}}"
      },
      "status": 1,                      // 1 - délivré, 2 - lu, 3 - ouvert,
                                        // 4 - supprimé (par un utilisateur), 5 - supprimé depuis le Control Panel
      "hash":"1C"                       // code de hachage de la notification push
    }, {
      ...
    }],
    "next":"afarew511",                 // le prochain code de boîte de réception à renvoyer par
                                        // la requête /getInboxMessages suivante
    "deleted": ["bbaf85ab", "a41957b"], // la liste des messages supprimés depuis le Control Panel
    "new_inbox": 6                      // le nombre de messages de la boîte de réception délivrés à cet utilisateur (peut être utilisé pour un badge)
  }
}

{
  "request": {
    "application": "XXXXX-XXXXX", // requis. Code d'application Pushwoosh
     "userId": "user_name_1",     // requis. User ID enregistré dans Pushwoosh
     "device_type": 1             // optionnel. Pour les types d'appareils, référez-vous à /registerDevice
  }
}

inboxStatus

Met à jour le statut d’un message spécifique de la boîte de réception.

POST https://api.pushwoosh.com/json/1.3/inboxStatus

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token `XXXX`	Jeton d’API de l’appareil pour accéder à l’API de l’appareil. Remplacez `XXXX` par votre véritable jeton d’API de l’appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
inbox_code*	string	peut être obtenu à partir des détails du message dans le Control Panel ou à partir du paramètre “order” de la requête /getInboxMessages
hash	string	Code de hachage du message de la boîte de réception.
hwid	string	Hardware ID de l’appareil pour lequel mettre à jour le statut de la boîte de réception.
time	string	Timestamp de la date d’envoi.
userID*	string	Si aucun User ID personnalisé n’est défini, utilisez le HWID.
status*	integer	1 - délivré, 2 - lu, 3 - ouvert, 4 - supprimé par un utilisateur.
device_type	integer	Voir les valeurs possibles ci-dessous.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

{
  "request": {
    "application": "XXXXX-XXXXX",    // requis. Code d'application Pushwoosh
    "inbox_code": "874393934032909", // requis. paramètre "order" de la requête /getInboxMessages
    "hash": "1C",                    // optionnel.
    "userId": "some_user",           // requis.
    "status": 2,                     // requis. statut à définir : 1-délivré, 2-lu, 3-ouvert, 4-supprimé (par un utilisateur)
    "device_type": 3                 // optionnel.
  }
}