Перейти к содержанию

API для Message Inbox

getInboxMessages

Возвращает список сообщений из Message Inbox для указанного HWID.

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

Заголовки запроса

Имя	Обязательно	Значение	Описание
Authorization	Да	Token `XXXX`	Токен API устройства для доступа к Device API. Замените `XXXX` на ваш фактический токен API устройства.

Тело запроса

Имя	Тип	Описание
application*	string	Код приложения Pushwoosh
userId*	string	Если не задан кастомный User ID, используйте HWID.
hwid	string	Аппаратный идентификатор (HWID) устройства, для которого нужно получить сообщения из Message Inbox.
last_code	string	Код последнего сообщения, полученного в предыдущем ответе. Если поле пустое, возвращаются первые сообщения.
count	integer	Количество сообщений, которое будет показано в одном ответе; используется для пагинации. 0 — для загрузки всех сообщений из Message Inbox.

200

{
  "response": {
    "messages": [{                      // массив сообщений, хранящихся в Message Inbox пользователя
      "inbox_id": "avde1c792cd",
      "rt": "146078676",                // дата удаления сообщения из Message Inbox
      "send_date": "1459758676",        // дата сохранения сообщения в Message Inbox
      "order": "59138176",              // позиция в порядке отображения в Message Inbox
      "title": "New Rich Media in inbox!",
      "text": "Hi! New feature is available right now!",
      "action_type": "RichMedia",
      "action_params": {                // полезная нагрузка, описывающая действия при открытии пуша
        "rm": "{\"url\":\"https:\/\/richmedia.pushwoosh.com\/C82F7-51FC1.zip\",\"ts\":\"1459758676\",\"tags\":{\"tagName\":\"tagValue\"}}"
      },
      "status": 1,                      // 1 - доставлено, 2 - прочитано, 3 - открыто,
                                        // 4 - удалено (пользователем), 5 - удалено из Панели управления
      "hash":"1C"                       // хеш-код пуш-уведомления
    }, {
      ...
    }],
    "next":"afarew511",                 // следующий код Message Inbox, который будет возвращен
                                        // следующим запросом /getInboxMessages
    "deleted": ["bbaf85ab", "a41957b"], // список сообщений, удаленных из Панели управления
    "new_inbox": 6                      // количество доставленных сообщений в Message Inbox для этого пользователя (может использоваться для бейджа)
  }
}

{
  "request": {
    "application": "XXXXX-XXXXX", // обязательно. Код приложения Pushwoosh
     "userId": "user_name_1",     // обязательно. User ID, зарегистрированный в Pushwoosh
     "device_type": 1             // опционально. Типы устройств см. в /registerDevice
  }
}

inboxStatus

Обновляет статус определенного сообщения в Message Inbox.

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

Заголовки запроса

Имя	Обязательно	Значение	Описание
Authorization	Да	Token `XXXX`	Токен API устройства для доступа к Device API. Замените `XXXX` на ваш фактический токен API устройства.

Тело запроса

Имя	Тип	Описание
application*	string	Код приложения Pushwoosh
inbox_code*	string	можно получить из деталей сообщения в Панели управления или из параметра “order” запроса /getInboxMessages
hash	string	Хеш-код сообщения в Message Inbox.
hwid	string	Аппаратный идентификатор (HWID) устройства, для которого нужно обновить статус в Message Inbox.
time	string	Временная метка даты отправки.
userID*	string	Если не задан кастомный User ID, используйте HWID.
status*	integer	1 - доставлено, 2 - прочитано, 3 - открыто, 4 - удалено пользователем.
device_type	integer	Возможные значения см. ниже.

200

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

{
  "request": {
    "application": "XXXXX-XXXXX",    // обязательно. Код приложения Pushwoosh
    "inbox_code": "874393934032909", // обязательно. Параметр "order" из запроса /getInboxMessages
    "hash": "1C",                    // опционально.
    "userId": "some_user",           // обязательно.
    "status": 2,                     // обязательно. устанавливаемый статус: 1-доставлено, 2-прочитано, 3-открыто, 4-удалено (пользователем)
    "device_type": 3                 // опционально.
  }
}