notification.get_history

Возвращает список событий с привязкой к объекту (Контакт, Сделка, Задача, Сообщение и другое), параметры которого были переданы в запросе.

API ver.10.0.0 Пользователь

Запрос
Параметр	Тип	Значение	Описание
`class` ^*	String	notification
`method` ^*	String	get_history
`sid` ^*	String	—	Идентификатор сессии пользователя.
`lang`	String	ru	Код языка интерфейса.
`param` ^*	Object	—	Объект с параметрами запроса.
`obj_name` ^*	String	order	Тип объекта. Допустимые значения: `order` `contact` `job`
`order_id`	Number	—	ID сделки (если передан тип объекта сделки).
`contact_id`	Number	—	ID контакта (если передан тип объекта контакта).
`job_id`	Number	—	ID задачи (если передан тип объекта задачи).
`read`	Boolean	—	Не учитывается (deprecated). Возвращать только просмотренные или не просмотренные уведомления. Если не указывать, то возвращает все уведомления. Допустимые значения: `true` `false`
`last_id`	Number	—	ID уведомления, с которого нужно возвращать результат.
`user`	Boolean	—	Не учитывается (deprecated). См. параметр initiator. Допустимые значения: `true` `false`
`user_id`	Boolean	—	Не учитывается (deprecated). См. параметр initiator. Допустимые значения: `true` `false`
`initiator`	Boolean	false	Отображать только те события, которые имеют автора (инициатора). По умолчанию возвращает все события. Допустимые значения: `true` `false`
`initiator_id`	Number[]	—	Массив ID пользователей — авторов событий.
`notification_date_send`	Number	—	Минимальная дата события для выборки.
`notification_date_end_period`	Number	—	Максимальная дата события для выборки.
`limit`	Number	—	Максимальное число записей, которые нужно вернуть. На данный момент опционально, в перспективе будет установлено значение по умолчанию.
`offset`	Number	—	Сколько уведомлений пропустить сверху выборки (верхний отступ). Используется в сценариях для загрузки «порциями». Важно: Используется только совместно с `param.limit`.
`get_total`	Boolean	—	Добавить в конец выборки суммарное число найденных записей событий без учета LIMIT. Допустимые значения: `true` `false`
^* – обязательные параметры

Ответ
Параметр	Тип	Описание
`response` ^*	Object[]	Массив объектов событий.
`notification_id` ^*	Number	ID события.
`notification_text` ^*	String	Текст события.
`notification_date_send` ^*	Number	Дата события.
`notification_obj` ^*	String	Тип объекта события.
`notification_obj_id` ^*	Number	ID объекта события.
`initiator_id` ^*	Number\|Null	ID автора события.
`order_id` ^*	Number\|Null	ID сделки, если событие связано со сделкой.
`total` ^*	Number	Суммарное количество найденных событий, если передан get_total.
^* – обязательные параметры

Коды ошибок
Номер	Описание
`750`	Отсутствуют обязательные параметры или некорректные данные.
`751`	Запрашиваемый объект или пользователь не найден.
`753`	Указан недопустимый тип объекта.

                [
      {
        "notification_id": 5001,
        "notification_text": "Иванов Иван создал сделку",
        "notification_date_send": 1708761600,
        "notification_obj": "order",
        "notification_obj_id": 1042,
        "initiator_id": 1
      },
      {
        "notification_id": 5002,
        "notification_text": "Петров Петр изменил статус",
        "notification_date_send": 1708762200,
        "notification_obj": "order",
        "notification_obj_id": 1042,
        "initiator_id": 2
      },
      {"total": 2}
    ]

            [
  {
    "code": 750,
    "response": null
  },
  {
    "code": 200,
    "response": {
      "errs": {
        "750": "Отсутствуют некоторые обязательные параметры запроса."
      }
    }
  }
]

        
curl -X POST https://domain.laxo.one/notification/get_history \
-H "Content-Type: application/json" \
-d '{"sid": "YOUR_API_SID", "lang": "ru", "param": "OBJECT WITH PARAMS"}

Остались вопросы? Спросите в чате В нашем сообществе в Telegram можно быстро задать вопрос, получить подсказку от команды Laxo или обменяться опытом с другими пользователями.

Задать вопрос