Возвращает список событий в формате отчета по действиям сотрудников.
API ver.10.0.0 Пользователь
| Запрос | |||
| Параметр | Тип | Значение | Описание |
class * | String | notification | |
method * | String | get_report_history | |
sid * | String | — | Идентификатор сессии пользователя. |
lang | String | ru | Код языка интерфейса. |
param * | Object | — | Объект с параметрами запроса. |
obj_name | String[] | — | Массив типов объекта. Допустимые значения: order contact job |
funnel_id | Number[] | — | Массив ID воронок. |
order | Number[] | — | Массив ID сделок. |
order_user_creator | Number[] | — | Массив ID пользователей-создателей сделок. |
order_user_mentor | Number[] | — | Массив ID пользователей-исполнителей сделок. |
notification_type | String[] | — | Массив типов действий. |
notification_date_send | Number | — | Минимальная дата события для выборки. |
notification_date_end_period | Number | — | Максимальная дата события для выборки. |
user_id | Number[] | — | См. параметр initiator. Параметр аналогичен ему. |
initiator_id | Number[] | — | Массив ID пользователей — авторов событий. |
read | Boolean | — | Не учитывается (deprecated). Возвращать только просмотренные или не просмотренные уведомления. Если не указывать, то возвращает все уведомления. Допустимые значения: true false |
last_id | Number | — | ID уведомления, с которого нужно возвращать результат. |
limit | Number | — | Максимальное число записей, которые нужно вернуть. На данный момент опционально, в перспективе будет установлено значение по умолчанию. |
offset | Number | — | Сколько уведомлений пропустить сверху выборки (верхний отступ). Используется в сценариях для загрузки «порциями». Важно: Используется только совместно с param.limit. |
get_total | Boolean | — | Добавить в конец выборки суммарное число найденных записей событий без учета LIMIT. Допустимые значения: true false |
| * – обязательные параметры | |||
| Ответ | ||
| Параметр | Тип | Описание |
response * | Object[] | Массив объектов событий. |
notification_id * | Number | ID события. |
notification_text * | String | Текст события. |
notification_href * | String|Null | Ссылка события. |
notification_date_send * | Number | Дата события. |
notification_obj * | String | Тип объекта события. |
notification_obj_id * | Number | ID объекта события. |
initiator_id * | Number|Null | ID автора события. |
order_id * | Number|Null | ID сделки. |
order_user_mentor * | Number|Null | ID ответственного по сделке. |
order_user_creator * | Number|Null | ID создателя сделки. |
funnel_id * | Number|Null | ID воронки. |
contact_id * | Number|Null | ID контакта. |
job_id * | Number|Null | ID задачи. |
total * | Number | Суммарное количество найденных событий, если передан get_total. |
| * – обязательные параметры | ||
| Коды ошибок | |
| Номер | Описание |
750 | Отсутствуют обязательные параметры или некорректные данные. |
751 | Запрашиваемый объект или пользователь не найден. |
753 | Указан недопустимый тип объекта. |
[
{
"code": 751,
"response": null
},
{
"code": 200,
"response": {
"errs": {
"751": "Некорректный ID пользователя: не найден."
}
}
}
]
curl -X POST https://domain.laxo.one/notification/get_report_history \
-H "Content-Type: application/json" \
-d '{"sid": "YOUR_API_SID", "lang": "ru", "param": "OBJECT WITH PARAMS"}