Возвращает список уведомлений пользователя.
API ver.10.0.0 Пользователь
| Запрос | |||
| Параметр | Тип | Значение | Описание |
class * | String | notification | |
method * | String | get_list | |
sid * | String | — | Идентификатор сессии пользователя. |
lang | String | ru | Код языка интерфейса. |
param * | Object | — | Объект с параметрами запроса. |
last_id | Number | — | ID уведомления, с которого нужно возвращать результат. |
read | Boolean | — | Возвращать только просмотренные или не просмотренные уведомления. Если не указывать, то возвращает все уведомления. Допустимые значения: true false |
read_date | Number | — | Метка времени (UNIXTIME) о прочтении, уведомления с которой нужно возвращать результат (т.е. возвращаются только прочитанные с этой даты, param.read = true). |
typesend | String | db_insert | Тип способа получения уведомления, которые нужно вернуть. По умолчанию возвращаются только те, на которые пользователь подписан получать в области уведомлений. Допустимые значения: db_insert email push all |
limit | Number | — | Максимальное число записей, которые нужно вернуть. На данный момент опционально, в перспективе будет установлено значение по умолчанию. |
offset | Number | — | Сколько уведомлений пропустить сверху выборки (верхний отступ). Используется в сценариях для загрузки «порциями». Важно: Используется только совместно с param.limit. |
| * – обязательные параметры | |||
| Ответ | ||
| Параметр | Тип | Описание |
response * | Object[] | Массив объектов уведомлений. В первом объекте также возвращается unread_total. |
notification_id * | Number | ID уведомления. |
notification_text * | String | Текст уведомления. |
user_id * | Number | ID пользователя-получателя. |
initiator_id * | Number|Null | ID автора действия. |
notification_type_send * | String|Null | Тип способа отправки уведомления. |
notification_read_date * | Number|Null | Дата прочтения уведомления. |
notification_date_send * | Number | Дата отправки уведомления. |
notification_obj * | String|Null | Тип объекта уведомления. |
notification_obj_id * | Number|Null | ID объекта уведомления. |
notification_href * | String|Null | Ссылка уведомления. |
chat_id * | Number|Null | ID чата, если уведомление связано с сообщением. |
role_id * | Number | ID роли текущего пользователя. |
unread_total * | Number | Общее количество непрочитанных уведомлений. |
| * – обязательные параметры | ||
| Коды ошибок | |
| Номер | Описание |
750 | Отсутствуют обязательные параметры или некорректные данные. |
751 | Запрашиваемый объект или пользователь не найден. |
753 | Указан недопустимый тип объекта. |
[
{
"code": 750,
"response": null
},
{
"code": 200,
"response": {
"errs": {
"751": "Некорректный ID пользователя: не найден."
}
}
}
]
curl -X POST https://domain.laxo.one/notification/get_list \
-H "Content-Type: application/json" \
-d '{"sid": "YOUR_API_SID", "lang": "ru", "param": "OBJECT WITH PARAMS"}