helpdesk.message.list

Scope: helpdesk

Кто может вызывать: Доступ к обращению; скрытые сообщения видны admin/support/responsible.

Список сообщений обращения (без лог-записей, IS_LOG=N)

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
ticketId / TICKET_ID int да* ID обращения (*или filter[ticketId][$eq])
limit, offset, fetchAll, filter нет Пагинация и Mongo-фильтр

Поля filter (Mongo)

Помимо обязательного контекста обращения: id, ticketId, ownerId, createdBy, createdAt, timestampX, isHidden, isLog, isOverdue, cNumber, sourceId. Поле ticketId в filter используется, если не передан query-параметр.

Возвращаемые данные

  • result.result — массив сообщений (без files в list)
  • total / next — верхний уровень HTTP-ответа; next только если есть следующая страница (overview)

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INVALID_ID Не указан ticketId
TICKET_NOT_FOUND Обращение не найдено
ACCESS_DENIED Нет доступа
UNAUTHORIZED Пользователь не авторизован
INVALID_LIMIT limit < 1
LIMIT_TOO_LARGE limit > 500
INVALID_OFFSET offset < 0
INVALID_FILTER Некорректный filter или неизвестное поле
INVALID_FILTER_OPERATOR Неизвестный оператор фильтра
FETCHALL_LIMIT_EXCEEDED При fetchAll=true подходящих записей больше защитного лимита (5000)
INTERNAL Внутренняя ошибка сервера

Пример запроса (GET)

curl -G "https://76575.dev.wehive.digital/rest/1/lus1tijk9ll7mg7h/helpdesk.message.list.json" -H "Accept: application/json" --data-urlencode "ticketId=2" --data-urlencode "limit=20"
        

Пример ответа

{
          "result": {
            "result": [
              {
                "id": 7,
                "ticketId": 2,
                "cNumber": 1,
                "message": "Created from Postman",
                "createdAt": "28.08.2026 09:55:50",
                "timestampX": "28.08.2026 09:55:50",
                "isHidden": false,
                "isLog": false,
                "isOverdue": false,
                "ownerId": 1,
                "createdBy": null,
                "modifiedBy": null,
                "sourceId": 0,
                "bySupportTeam": true,
                "taskTime": null
              }
            ],
            "error": null
          },
          "total": 1
        }
        

См. также

Предыдущая
Следующая