Фильтрация по id канала. Несколько значений передавайте через запятую

Фильтрация по assignee_id и group_id, значения которых можно передать массивом или по одному.

Существуют следующие кейсы поведения:

1. Возможность указать в параметре assignee_id айди агента и в параметре group_id айди группы - тогда система отдает все тикеты, в которых в качестве Исполнителя указан агент в рамках определенной группы
2. Возможность не указывать параметр group_id и указать в параметре assignee_id айди агента - тогда система отдает все тикеты, в которых в качестве Исполнителя указан агент, без учета в рамках какой группы он добавлен
3. Возможность указывать параметр assignee_id = unassinged – тогда система отдает все тикеты, в которых в качестве Исполнителя указана группа
4. Возможность указывать параметр assignee_id = unassinged и указать в параметре group_id = unassinged – тогда система отдает все тикеты, в которых в качестве Исполнителя указано "Нет исполнителя"

Deprecated (версия 1.0) не рекомендуем использовать устаревшие способы поведения:

1. Возможность указать строкой id агента
2. Возможность указать id группы+id агента для уточнения в рамках какой группы указан исполнитель: {ID группы}_{ID агента}

Фильтрация по id статуса

• 1 (открыт)
• 2 (выполнен)
• 3 (закрыт)
• 4 (удален)
• 5 (на удержании)
• 6 (в ожидании)
• 7 (спам)
• 8 (новый)
• 9 (рассылка)

Фильтрация по типу

• question
• task
• problem
• incident

Фильтрация по приоритету

• low
• medium
• urgent
• extreme

Фильтрация по id агента, учитывает права сотрудника.

Сервер возвращает переменную rights:

• write - если есть доступ работы с тикетом в текущем канале;
• read - если есть доступ просмотра тикета в текущем канале.

не принимает значение null

Смещение на 1, покажет следующие 100 записей

не принимает значение null

Фильтрация по значению тега. Если значений несколько передавать значения необходимо через запятую:

"tag" : "1,4,23"

не принимает значение null

Поисковая строка. Поиск осуществляется по теме тикета и содержанию во всех комментариях. Установлено ограничение на 10 запросов в минуту для запросов, содержащих, данный параметр.

не принимает значение null

Фильтрация по идентификатору и значению дополнительного поля. 

Массив содержит параметры:

• id - айди дополнительного поля;
• value - значение дополнительного поля

а) empty - при указании данного значения система отфильтрует все запросы, в которых есть хотя бы одно не заполненное поле. Для полей с типом checkbox "не заполнено" это значение - 0 или пустое значение " "

b) not_empty - при указании данного значения система отфильтрует все запросы, в которых есть хотя бы одно заполненное поле. Для полей с типом checkbox "заполнено" это значение - 1

c) value - при указании значения система отфильтрует все запросы, в которых в любом из дополнительных полей будет выбрано данное значение. Можно указать только одно значение

Deprecated (версия 1.0) не рекомендуем использовать устаревшие способы поведения:

field_id – Фильтрация по идентификатору дополнительного поля. При указании значения система отфильтрует все запросы, в которых данное поле будет заполнено. Можно указать только одно значение.

field_value – Фильтрация по значению дополнительного поля. 

• empty - при указании данного значения система отфильтрует все запросы, в которых есть хотя бы одно не заполненное поле
  • Для полей с типом checkbox "не заполнено" это значение - false
• not_empty - при указании данного значения система отфильтрует все запросы, в которых есть хотя бы одно заполненное поле.
  • Для полей с типом checkbox "заполнено" это значение - true
• value - при указании значения система отфильтрует все запросы, в которых в любом из дополнительных полей будет выбрано данное значение.
  • Можно указать только одно значение

Параметр сортировки, по которому можно сортировать список тикетов: id, status_id, client_id, assignee_id, group, last_updated_at, published_at

По умолчанию: id

Порядок сортировки тикетов:

• asc - по возрастанию
• desc - по убыванию

По умолчанию: desc

передает в ответ от сервера дату и время SLA по каждому параметру, если они заданы в запросах:

• время первого ответа (first_reply)
• время следующего ответа (next_reply)​
• время до выполнения​ (close)

Фильтрация по id агента, учитывает права сотрудника.

Сервер возвращает переменную rights:

• write - если есть доступ работы с тикетом в текущем канале;
• read - если есть доступ просмотра тикета в текущем канале.

передает в ответ от сервера дату и время SLA по каждому параметру, если они заданы в запросах:

• время первого ответа (first_reply)
• время следующего ответа (next_reply)​
• время до выполнения​ (close)

Сообщение тикета. Строка ~64kb. Поддерживается HTML разметка

• Если это внутренний комментарий (private_comment = true), то можете добавить упоминание сотрудника [~test@gmail.com]

Необязательный параметр, если указан, то система проверит нет ли компании с таким именем

Если такой компании нет - создается новая компания с таким именем и привязывается к клиенту по которому пришло обращение

Если такая компания есть - клиент привязывается к этой компании

Если у клиента есть компания - клиент перепривязывается к той что была передана

true. Необязательный параметр для создания приватного комментария. 

Системное поле которое не видно в карточке. Отдается в запросах получения информации о тикете.

Необязательный параметр

Строка (255 символов)

Принимает следующие параметры:

• question
• task
• problem
• incident

По умолчанию: question

Строка (10 символов)

Принимает следующие параметры:

• low
• medium
• urgent
• extreme

По умолчанию: medium

Строка (10 символов)

Принимает число, которое соответствует идентификатору статуса в системе.

Возможные статусы:

• 1 (открыт)
• 2 (выполнен)
• 3 (закрыт)
• 4 (удален)
• 5 (на удержании)
• 6 (в ожидании)
• 7 (спам)
• 8 (новый)
• 9 (рассылка)

По умолчанию: 8 (новый)

Числовое значение 

Идентификатор агента, на которого будет назначен запрос в рамках группы по умолчанию.

• если передан параметр group_id и агент есть в этой группе, то назначение будет в рамках указанной группы
• если был указан неверный id система не очистит поле, а вернет ошибку

Числовой идентификатор. 32 бита.

Идентификатор группы, на которую будет назначен запрос. Числовой идентификатор. 32 бита

Строка, которая содержит значения дополнительных полей, разделенные точкой с запятой (;). 

Для текстовых полей значение не должно превышать 255 символов
Для чекбокс полей – true/false
Для лист полей – id варианта

Пример строки в которой передаются 3 значения:  'любое значение;true;93',

Для редактирования вложенных списков. Массив содержащий параметры:

• id - айди поля
• value - значение поля

Важно соблюдать структуру вложенных списков То есть для изменения второго уровня нужно обязательно передать значение первого уровня

Id группы, на которую будет назначен тикет

Id юзера, который будет назначен исполнителем

• если передан параметр group_id и агент есть в этой группе, то назначение будет в рамках указанной группы
• если был указан неверный id система не очистит поле, а вернет ошибку
• если в group_id  и assignee_id передан "null", назначение будет "Не назначено"

статус тикета, числовой параметр.  Возможные значения поля status:

Строка, которая содержит идентификаторы одного и более дополнительных полей, разделенные точкой с запятой (;).

Строка, которая содержит значения одного и более дополнительных полей, разделенные точкой с запятой (;). 

Для текстовых полей значение не должно превышать 256 символов
Для чекбокс полей – true/false
Для лист полей — id варианта или значение поля

lists

Для редактирования вложенных списков. Массив содержащий параметры:

• id - айди поля
• value - значение поля

Важно соблюдать структуру вложенных списков. То есть для изменения второго уровня нужно обязательно передать значение первого уровня

Для очистки поля используйте пустое значение или "null"

Системное поле которое не видно в карточке. Отдается в запросах получения информации о тикете.

Необязательный параметр

Строка (255 символов)

Принимает следующие параметры:

• question
• task
• problem
• incident

По умолчанию: question

Строка (10 символов)

Принимает следующие параметры:

• low
• medium
• urgent
• extreme

По умолчанию: medium

Строка (10 символов)

Принимает число, которое соответствует идентификатору статуса в системе.

Возможные статусы:

• 1 (открыт)
• 2 (выполнен)
• 3 (закрыт)
• 4 (удален)
• 5 (на удержании)
• 6 (в ожидании)
• 7 (спам)
• 8 (новый)
• 9 (рассылка)

По умолчанию: 8 (новый)

Числовое значение 

Строка, которая содержит значения дополнительных полей, разделенные точкой с запятой (;). 

Для текстовых полей значение не должно превышать 255 символов
Для чекбокс полей – true/false
Для лист полей — id варианта

Пример строки в которой передаются 3 значения:  'любое значение;true;93',

Сообщение 

• Если это внутренний комментарий, то можете добавить упоминание сотрудника [~test@gmail.com]

Параметр определяет автора комментария. Принимает "user","client", "trigger". При передаче "client", автором комментария будет назначен клиент, на которого заведен тикет. Если передается параметр отличный от "client", то в запросе должны содержаться параметры с нужными идентификаторами (user_id, trigger_id). 

Если user_id не указан, то комментарий будет создан от лица бота

Идентификатор триггера.

ВАЖНО: В данный момент вне зависимости от того какой выбран триггер - комментарий будет создан от лица Бота