Message Inbox API

getInboxMessages

Gibt die Liste der Inbox-Nachrichten für eine angegebene HWID zurück.

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

Request headers

Name	Erforderlich	Wert	Beschreibung
Authorization	Ja	Token XXXX	API Device Token für den Zugriff auf die Device API. Ersetzen Sie XXXX durch Ihr tatsächliches Device API Token.

Request Body

Name	Typ	Beschreibung
application*	string	Pushwoosh Application Code
userId*	string	Wenn keine benutzerdefinierte User ID festgelegt ist, verwenden Sie die HWID.
hwid	string	Hardware ID eines Geräts, für das die Inbox-Nachrichten abgerufen werden sollen.
last_code	string	Code der letzten Nachricht, die in der vorherigen Antwort abgerufen wurde. Wenn leer, werden die ersten Nachrichten zurückgegeben.
count	integer	Die Anzahl der Nachrichten, die in einer einzelnen Antwort angezeigt werden sollen; wird für die Paginierung verwendet. 0 zum Laden aller Nachrichten in der Inbox.

200

{
  "response": {
    "messages": [{                      // Array von Nachrichten, die aktuell in der Inbox des Benutzers gespeichert sind
      "inbox_id": "avde1c792cd",
      "rt": "146078676",                // Datum, an dem die Nachricht aus der Inbox entfernt wird
      "send_date": "1459758676",        // Datum, an dem die Nachricht in der Inbox gespeichert wurde
      "order": "59138176",              // Position in der Anzeigereihenfolge der Inbox
      "title": "New Rich Media in inbox!",
      "text": "Hi! New feature is available right now!",
      "action_type": "RichMedia",
      "action_params": {                // Payload, der die Aktionen beim Öffnen des Push beschreibt
        "rm": "{\"url\":\"https:\/\/richmedia.pushwoosh.com\/C82F7-51FC1.zip\",\"ts\":\"1459758676\",\"tags\":{\"tagName\":\"tagValue\"}}"
      },
      "status": 1,                      // 1 - zugestellt, 2 - gelesen, 3 - geöffnet,
                                        // 4 - gelöscht (vom Benutzer), 5 - gelöscht über das Control Panel
      "hash":"1C"                       // Hash-Code der Push-Benachrichtigung
    }, {
      ...
    }],
    "next":"afarew511",                 // der nächste Inbox-Code, der von der
                                        // folgenden /getInboxMessages-Anfrage zurückgegeben wird
    "deleted": ["bbaf85ab", "a41957b"], // die Liste der über das Control Panel gelöschten Nachrichten
    "new_inbox": 6                      // die Anzahl der zugestellten Inbox-Nachrichten für diesen Benutzer (kann für Badges verwendet werden)
  }
}

Example Request

{
  "request": {
    "application": "XXXXX-XXXXX", // erforderlich. Pushwoosh Application Code
     "userId": "user_name_1",     // erforderlich. In Pushwoosh registrierte User ID
     "device_type": 1             // optional. Für Gerätetypen siehe /registerDevice
  }
}

Hinweis

Stellen Sie für iOS sicher, dass Sie die Notification Service Extension zu Ihrem Projekt hinzugefügt haben, um die Push-Zustellung zu tracken. Mehr erfahren

inboxStatus

Aktualisiert den Status einer bestimmten Inbox-Nachricht.

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

Request headers

Name	Erforderlich	Wert	Beschreibung
Authorization	Ja	Token XXXX	API Device Token für den Zugriff auf die Device API. Ersetzen Sie XXXX durch Ihr tatsächliches Device API Token.

Request Body

Name	Typ	Beschreibung
application*	string	Pushwoosh Application Code
inbox_code*	string	kann aus den Nachrichtendetails im Control Panel oder aus dem Parameter „order“ der /getInboxMessages-Anfrage abgerufen werden
hash	string	Hash-Code der Inbox-Nachricht.
hwid	string	Hardware ID des Geräts, für das der Inbox-Status aktualisiert werden soll.
time	string	Zeitstempel des Sendedatums.
userID*	string	Wenn keine benutzerdefinierte User ID festgelegt ist, verwenden Sie die HWID.
status*	integer	1 - zugestellt, 2 - gelesen, 3 - geöffnet, 4 - vom Benutzer gelöscht.
device_type	integer	Siehe mögliche Werte.

200

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

Example

{
  "request": {
    "application": "XXXXX-XXXXX",    // erforderlich. Pushwoosh Application Code
    "inbox_code": "874393934032909", // erforderlich. Parameter "order" der /getInboxMessages-Anfrage
    "hash": "1C",                    // optional.
    "userId": "some_user",           // erforderlich.
    "status": 2,                     // erforderlich. Zu setzender Status: 1-zugestellt, 2-gelesen, 3-geöffnet, 4-gelöscht (vom Benutzer)
    "device_type": 3                 // optional.
  }
}