Freshservice (предварительная версия)
Freshservice — это облачное решение для ит-службы и управления службами, которое легко настроить и использовать, чтобы преобразовать взаимодействие сотрудников в организации.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка приложений Freshworks |
| URL | https://www.freshworks.com |
| Адрес электронной почты | appsupport-ex@freshworks.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
| Веб-сайт | https://www.freshworks.com/freshservice/lp/home/ |
| Политика конфиденциальности | https://www.freshworks.com/privacy |
| Категории | ИТ-операции |
Authentication
Это важно
Проверка подлинности на основе имени пользователя и пароля больше не поддерживается FreshService. Соединитель теперь поддерживает только один тип проверки подлинности — ключ API. Документация по миграции API FreshService
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| Ключ API | Тип проверки подлинности ключа API | Все регионы | Недоступен для совместного использования |
| По умолчанию [не рекомендуется] | Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. | Все регионы | Недоступен для совместного использования |
Ключ API
Идентификатор проверки подлинности: базовый
Применимо: все регионы
Тип проверки подлинности ключа API
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | струна | Ключ API для этого API | True |
| URL-адрес сайта | струна | URL-адрес корневого сайта (пример: https://sample.freshservice.com ) | True |
По умолчанию [не рекомендуется]
Применимо: все регионы
Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Имя пользователя | струна | Имя пользователя для этого API | True |
| Пароль | securestring | Пароль для этого API | True |
| URL-адрес сайта | струна | URL-адрес корневого сайта (пример: https://sample.freshservice.com ) | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
| Частота опросов триггеров | 1 | 120 секунд |
Действия
| Добавление заметки к билету (V2) |
Добавьте к билету частную или общедоступную заметку. |
| Добавление заметки к билету [DEPRECATED] |
Добавьте к билету частную или общедоступную заметку. |
| Обновление билета (версия 2) |
Обновите билет (будут обновлены только указанные значения). |
| Обновление билета [DEPRECATED] |
Обновите билет (будут обновлены только указанные значения). |
| Создание билета (V2) |
Создайте билет. |
| Создание билета [DEPRECATED] |
Создайте билет. |
Добавление заметки к билету (V2)
Добавьте к билету частную или общедоступную заметку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор билета
|
ticketId | True | integer |
Идентификатор билета для обновления. |
|
Замечание
|
body | True | string |
Заметка, добавляемая в билет. |
|
Является частным
|
private | boolean |
Задайте значение true, если сообщение закрыто. |
Возвращаемое значение
- Тело
- AddNote_ResponseV2
Добавление заметки к билету [DEPRECATED]
Добавьте к билету частную или общедоступную заметку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор билета
|
ticketId | True | integer |
Идентификатор билета для обновления. |
|
Замечание
|
body | True | string |
Заметка, добавляемая в билет. |
|
Является частным
|
private | boolean |
Задайте значение true, если сообщение закрыто. |
Возвращаемое значение
- Тело
- AddNote_Response
Обновление билета (версия 2)
Обновите билет (будут обновлены только указанные значения).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор билета
|
ticketId | True | integer |
Идентификатор билета для обновления. |
|
Идентификатор запрашивающего объекта
|
requester_id | integer |
Идентификатор пользователя запрашивающего средства. Для существующих контактов requester_id можно передать вместо электронной почты. |
|
|
Тема
|
subject | string |
Тема билета. |
|
|
Состояние
|
status | string |
Состояние билета. |
|
|
Priority
|
priority | string |
Приоритет билета (например, низкий, средний или высокий). |
|
|
"Срочность";
|
urgency | string |
Срочность проблемы (например, низкая, средняя или высокая). |
|
|
Воздействие
|
impact | string |
Влияние проблемы (например, низкий, средний или высокий). |
|
|
Исходный материал
|
source | string |
Канал, через который был создан билет. |
Возвращаемое значение
Обновление билета [DEPRECATED]
Обновите билет (будут обновлены только указанные значения).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор билета
|
ticketId | True | integer |
Идентификатор билета для обновления. |
|
Идентификатор запрашивающего объекта
|
requester_id | integer |
Идентификатор пользователя запрашивающего средства. Для существующих контактов requester_id можно передать вместо электронной почты. |
|
|
Тема
|
subject | string |
Тема билета. |
|
|
Состояние
|
status | string |
Состояние билета. |
|
|
Priority
|
priority | string |
Приоритет билета (например, низкий, средний или высокий). |
|
|
"Срочность";
|
urgency | string |
Срочность проблемы (например, низкая, средняя или высокая). |
|
|
Воздействие
|
impact | string |
Влияние проблемы (например, низкий, средний или высокий). |
|
|
Исходный материал
|
source | string |
Канал, через который был создан билет. |
Возвращаемое значение
Создание билета (V2)
Создайте билет.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор запрашивающего объекта
|
requester_id | integer |
Идентификатор пользователя запрашивающего средства. Требуется один из идентификаторов запрашивающего пользователя, электронной почты и запрашивающего телефона |
|
|
Электронная почта запрашивающего средства
|
string |
Электронная почта запрашивающего средства. Требуется один из идентификаторов запрашивающего пользователя, электронной почты и запрашивающего телефона |
||
|
Телефон запрашивающего устройства
|
phone | string |
Номер телефона запрашивающего средства. Требуется один из идентификаторов запрашивающего пользователя, электронной почты и запрашивающего телефона |
|
|
Имя запрашивающего средства
|
name | string |
Имя запрашивающего объекта. Это обязательное поле только в том случае, если задано значение телефона запроса |
|
|
Тема
|
subject | True | string |
Тема билета. |
|
Состояние
|
status | True | string |
Состояние билета. |
|
Priority
|
priority | True | string |
Приоритет билета (например, низкий, средний или высокий). |
|
Description
|
description | True | string |
Описание билета. |
|
"Срочность";
|
urgency | string |
Срочность проблемы (например, низкая, средняя или высокая). |
|
|
Воздействие
|
impact | string |
Влияние проблемы (например, низкий, средний или высокий). |
|
|
Исходный материал
|
source | string |
Канал, через который был создан билет. |
Возвращаемое значение
Создание билета [DEPRECATED]
Создайте билет.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор запрашивающего объекта
|
requester_id | True | integer |
Идентификатор пользователя запрашивающего средства. Для существующих контактов requester_id можно передать вместо электронной почты. |
|
Тема
|
subject | True | string |
Тема билета. |
|
Состояние
|
status | True | string |
Состояние билета. |
|
Priority
|
priority | True | string |
Приоритет билета (например, низкий, средний или высокий). |
|
Description
|
description | True | string |
Описание билета. |
|
"Срочность";
|
urgency | string |
Срочность проблемы (например, низкая, средняя или высокая). |
|
|
Воздействие
|
impact | string |
Влияние проблемы (например, низкий, средний или высокий). |
|
|
Исходный материал
|
source | string |
Канал, через который был создан билет. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
helpdesk_ticket
|
item.helpdesk_ticket | Ticket_Response |
Триггеры
| При создании билета (V2) |
Активирует при создании нового билета. |
| При создании билета [DEPRECATED] |
Активирует при создании нового билета. |
При создании билета (V2)
При создании билета [DEPRECATED]
Определения
Ticket_Response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в Date-Time
|
created_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Удаляется
|
deleted | boolean |
Задайте значение true, если билет удаляется или корзина. Удаленные билеты не будут считаться в представлениях, кроме фильтра "удаленный". |
|
Идентификатор отдела
|
department_id_value | integer | |
|
Идентификатор билета
|
display_id | integer |
Идентификатор билета, характерный для вашей учетной записи. |
|
Из-за Date-Time
|
due_by | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор группы
|
group_id | integer |
Идентификатор группы, которой назначен билет. |
|
Идентификатор
|
id | integer |
Уникальный идентификатор билета. |
|
Воздействие
|
impact | integer |
Число, представляющее влияние проблемы. |
|
Эскалировано
|
isescalated | boolean |
Установите значение true, если была отправлена эскалация. |
|
Идентификатор владельца
|
owner_id | string |
Идентификатор агента, которому назначена проблема. |
|
Priority
|
priority | integer |
Число, представляющее приоритет билета. |
|
Идентификатор запрашивающего объекта
|
requester_id | integer |
Идентификатор пользователя запрашивающего средства. Для существующих контактов requester_id можно передать вместо электронной почты. |
|
Идентификатор ответа
|
responder_id | integer |
Идентификатор агента, которому назначен билет. |
|
Исходный материал
|
source | integer |
Число, представляющее канал, с помощью которого был создан билет. |
|
Спам
|
spam | boolean |
Задайте значение true, если билет помечается как спам. |
|
Состояние
|
status | integer |
Число, представляющее состояние билета. |
|
Тема
|
subject | string |
Тема билета. |
|
Тип билета
|
ticket_type | string |
Поле свойства type, определенное в полях билетов. |
|
Сообщение электронной почты
|
to_email | string |
Адрес электронной почты, на который был отправлен входящий адрес электронной почты. |
|
Обновлено в Date-Time
|
updated_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
"Срочность";
|
urgency | integer |
Число, представляющее срочность проблемы. |
|
Description
|
description | string |
Описание проблемы. |
|
Описание HTML
|
description_html | string |
HTML-содержимое билета. Описание и description_html не должны передаваться вместе. |
|
Название статуса
|
status_name | string |
Состояние билета. |
|
Имя приоритета
|
priority_name | string |
Приоритет билета. |
|
Имя источника
|
source_name | string |
Канал, через который был создан билет. |
|
Имя ответа
|
responder_name | string |
Имя агента, которому назначен билет. |
|
Сообщения электронной почты
|
to_emails | array of string |
Адреса электронной почты, на которые был отправлен входящий адрес электронной почты. |
|
Название отдела
|
department_name | string |
Название отдела. |
|
Идентификатор связанной проблемы
|
assoc_problem_id | integer |
Идентификатор связанной проблемы с билетом. |
|
Связанный идентификатор изменения
|
assoc_change_id | integer |
Идентификатор связанного изменения проблемы. |
|
Идентификатор связанной причины изменения
|
assoc_change_cause_id | integer |
Идентификатор изменения, вызывающего билет. |
|
Связанный идентификатор ресурса
|
assoc_asset_id | integer |
Идентификатор ресурса, связанного с билетом. |
|
Имя срочности
|
urgency_name | string |
Срочность проблемы. |
|
Имя влияния
|
impact_name | string |
Влияние проблемы. |
CreateUpdateTicket_ResponseV2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в Date-Time
|
ticket.created_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор отдела
|
ticket.department_id | integer | |
|
Из-за Date-Time
|
ticket.due_by | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор группы
|
ticket.group_id | integer |
Идентификатор группы, которой назначен билет. |
|
Идентификатор
|
ticket.id | integer |
Уникальный идентификатор билета. |
|
Эскалировано
|
ticket.is_escalated | boolean |
Установите значение true, если была отправлена эскалация. |
|
Priority
|
ticket.priority | integer |
Число, представляющее приоритет билета. |
|
Идентификатор запрашивающего объекта
|
ticket.requester_id | integer |
Идентификатор пользователя запрашивающего средства. Для существующих контактов requester_id можно передать вместо электронной почты. |
|
Идентификатор ответа
|
ticket.responder_id | integer |
Идентификатор агента, которому назначен билет. |
|
Исходный материал
|
ticket.source | integer |
Число, представляющее канал, с помощью которого был создан билет. |
|
Спам
|
ticket.spam | boolean |
Задайте значение true, если билет помечается как спам. |
|
Состояние
|
ticket.status | integer |
Число, представляющее состояние билета. |
|
Тема
|
ticket.subject | string |
Тема билета. |
|
Тип билета
|
ticket.type | string |
Поле свойства type, определенное в полях билетов. |
|
Обновлено в Date-Time
|
ticket.updated_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Description
|
ticket.description_text | string |
Описание проблемы. |
|
Описание HTML
|
ticket.description | string |
HTML-содержимое билета. Описание и description_html не должны передаваться вместе. |
|
Сообщения электронной почты
|
ticket.to_emails | array of string |
Адреса электронной почты, на которые был отправлен входящий адрес электронной почты. |
ListTicket_ResponseV2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в Date-Time
|
created_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор отдела
|
department_id | integer | |
|
Из-за Date-Time
|
due_by | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор группы
|
group_id | integer |
Идентификатор группы, которой назначен билет. |
|
Идентификатор
|
id | integer |
Уникальный идентификатор билета. |
|
Эскалировано
|
is_escalated | boolean |
Установите значение true, если была отправлена эскалация. |
|
Priority
|
priority | integer |
Число, представляющее приоритет билета. |
|
Идентификатор запрашивающего объекта
|
requester_id | integer |
Идентификатор пользователя запрашивающего средства. Для существующих контактов requester_id можно передать вместо электронной почты. |
|
Идентификатор ответа
|
responder_id | integer |
Идентификатор агента, которому назначен билет. |
|
Исходный материал
|
source | integer |
Число, представляющее канал, с помощью которого был создан билет. |
|
Спам
|
spam | boolean |
Задайте значение true, если билет помечается как спам. |
|
Состояние
|
status | integer |
Число, представляющее состояние билета. |
|
Тема
|
subject | string |
Тема билета. |
|
Тип билета
|
type | string |
Поле свойства type, определенное в полях билетов. |
|
Обновлено в Date-Time
|
updated_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Description
|
description_text | string |
Описание проблемы. |
|
Описание HTML
|
description | string |
HTML-содержимое билета. Описание и description_html не должны передаваться вместе. |
|
Сообщения электронной почты
|
to_emails | array of string |
Адреса электронной почты, на которые был отправлен входящий адрес электронной почты. |
UpdateTicket_Response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Удаляется
|
ticket.deleted | boolean |
Задайте значение true, если билет удаляется или корзина. Удаленные билеты не будут считаться в представлениях, кроме фильтра "удаленный". |
|
Идентификатор билета
|
ticket.display_id | integer |
Идентификатор билета, характерный для вашей учетной записи. |
|
Тема
|
ticket.subject | string |
Тема билета. |
|
Description
|
ticket.description | string |
Описание билета. |
|
Описание HTML
|
ticket.description_html | string |
HTML-содержимое билета. Описание и description_html не должны передаваться вместе. |
|
Название статуса
|
ticket.status_name | string |
Состояние билета. |
|
Имя приоритета
|
ticket.priority_name | string |
Приоритет билета. |
|
Имя источника
|
ticket.source_name | string |
Канал, через который был создан билет. |
|
Имя ответа
|
ticket.responder_name | string |
Имя агента, которому назначен билет. |
|
Сообщения электронной почты
|
ticket.to_emails | array of string |
Адреса электронной почты, на которые был отправлен входящий адрес электронной почты. |
|
Название отдела
|
ticket.department_name | string |
Название отдела. |
|
Идентификатор связанной проблемы
|
ticket.assoc_problem_id | integer |
Идентификатор связанной проблемы с билетом. |
|
Связанный идентификатор изменения
|
ticket.assoc_change_id | integer |
Идентификатор связанного изменения проблемы. |
|
Идентификатор связанной причины изменения
|
ticket.assoc_change_cause_id | integer |
Идентификатор изменения, вызывающего билет. |
|
Связанный идентификатор ресурса
|
ticket.assoc_asset_id | integer |
Идентификатор ресурса, связанного с билетом. |
|
Имя срочности
|
ticket.urgency_name | string |
Срочность проблемы. |
|
Имя влияния
|
ticket.impact_name | string |
Влияние проблемы. |
AddNote_Response
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в Date-Time
|
note.created_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Удаляется
|
note.deleted | boolean |
Задайте значение true, если билет удаляется или корзина. Удаленные билеты не будут считаться в представлениях, кроме фильтра "удаленный". |
|
Идентификатор
|
note.id | integer |
Уникальный идентификатор заметки. |
|
Частный
|
note.private | boolean |
Задайте значение true, если примечание является частным. |
|
Исходный материал
|
note.source | integer |
Число, представляющее канал, с помощью которого был создан билет. |
|
Обновлено в Date-Time
|
note.updated_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор пользователя
|
note.user_id | integer |
User_id агента, добавляющего заметку. |
|
Тело
|
note.body | string |
Содержимое заметки в виде обычного текста. |
|
HTML-код текста
|
note.body_html | string |
Содержимое заметки в формате HTML. Необходимо передать текст или body_html. |
|
attachments
|
note.attachments | array of string |
AddNote_ResponseV2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в Date-Time
|
conversation.created_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор
|
conversation.id | integer |
Уникальный идентификатор заметки. |
|
Частный
|
conversation.private | boolean |
Задайте значение true, если примечание является частным. |
|
Обновлено в Date-Time
|
conversation.updated_at | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор пользователя
|
conversation.user_id | integer |
User_id агента, добавляющего заметку. |
|
Тело
|
conversation.body_text | string |
Содержимое заметки в виде обычного текста. |
|
HTML-код текста
|
conversation.body | string |
Содержимое заметки в формате HTML. Необходимо передать текст или body_html. |
|
attachments
|
conversation.attachments | array of string | |
|
Идентификатор билета
|
conversation.ticket_id | integer |
Уникальный идентификатор билета. |