Содержание
SOAP-сервис InformationCenterIntegration
Для доступа к обращениям пользователей от лица пользователей сервисов и работе с этими обращениями, приложение 1С:Управление службой поддержки предоставляет веб-сервис ImformationICenterIntegration.
Веб-сервис построен по технологии SOAP и может использоваться как приложениями облачных сервисов Фреш, так и сервисами на основе других технологий. Контракт работы с веб-сервисом описан в этом документе. Примеры работы с веб-сервисом можно посмотреть и в конфигурации 1С:Библиотека технологии сервиса .
Операции веб-сервиса
Операция getIncidents
Операция предназначена для получения списка обращений.
Возвращаемое значение: IncidentListPresentation
| Параметр | Тип | Описание |
|---|---|---|
| UserID | string | Идентификатор пользователя сервиса |
| PageNumber | int | Номер страницы пагинатора для получения |
| Filter | Filter | Фильтр |
| Sort | Sort | Порядок сортировки |
Пример вызова операции на языке 1С:Предприятие при использовании библиотеки 1С:Библиотека технологии сервиса:
WSПрокси = ИнформационныйЦентрСервер.ПолучитьПроксиСлужбыПоддержки(); Результат = WSПрокси.getIncidents(Строка(ИдПользователя), ТекущаяСтраница, "New", "LastInteractionDate");
Операция getIncident
Операция предназначена для получения одного обращения.
Возвращаемое значение: Incident
| Параметр | Тип | Описание |
|---|---|---|
| UserID | string | Идентификатор пользователя |
| IncidentId | string | Идентификатор обращения |
Пример вызова операции на языке 1С:Предприятие при использовании библиотеки 1С:Библиотека технологии сервиса:
WSПрокси = ИнформационныйЦентрСервер.ПолучитьПроксиСлужбыПоддержки(); Результат = WSПрокси.getInteraction(Строка(ИдПользователя), Строка(ИдВзаимодействия), ТипВзаимодействия, Входящее);
Операция getInteractions
Операция предназначена для получения списка взаимодействий.
Возвращаемое значение: string
| Параметр | Тип | Описание |
|---|---|---|
| UserID | string | Идентификатор пользователя |
| IncidentID | string | Идентификатор обращения |
| PageNumber | int | Номер страницы пагинатора для получения |
Пример вызова операции на языке 1С:Предприятие при использовании библиотеки 1С:Библиотека технологии сервиса:
WSПрокси = ИнформационныйЦентрСервер.ПолучитьПроксиСлужбыПоддержки(); Результат = WSПрокси.getInteractions(Строка(ИдПользователя), Строка(ИдОбращения), ТекущаяСтраница);
Операция getInteraction
Операция предназначена для получения одного взаимодействия.
Возвращаемое значение: Interaction
| Параметр | Тип | Описание |
|---|---|---|
| UserID | string | Идентификатор пользователя |
| InteractionID | string | Идентификатор взаимодействия |
| TypeInteracion | TypeInteracion | Тип взаимодействия |
| Incoming | boolean | Признак, что взаимодействие предназначается пользователю |
Пример вызова операции на языке 1С:Предприятие при использовании библиотеки 1С:Библиотека технологии сервиса:
WSПрокси = ИнформационныйЦентрСервер.ПолучитьПроксиСлужбыПоддержки(); Результат = WSПрокси.getInteraction(Строка(ИдПользователя), Строка(ИдВзаимодействия), ТипВзаимодействия, Входящее);
Операция getInteractionFile
Операция предназначена для получения присоединенного файла из взаимодействия.
Возвращаемое значение: File
| Параметр | Тип | Описание |
|---|---|---|
| UserID | string | Идентификатор пользователя |
| InteractionID | string | Идентификатор обращения |
| FileID | string | Идентификатор файла |
| TypeInteracion | TypeInteracion | Тип взаимодействия |
| Incoming | boolean | Признак, что взаимодействие предназначено пользователю |
Пример вызова операции на языке 1С:Предприятие при использовании библиотеки 1С:Библиотека технологии сервиса:
// Получение файла WSПрокси = ИнформационныйЦентрСервер.ПолучитьПроксиСлужбыПоддержки(); Результат = WSПрокси.getInteractionFile(Строка(ИдПользователя), Строка(ИдВзаимодействия), Строка(ИдФайла), ТипВзаимодействия, Входящее); // Помещение ответа во временное хранилище АдресХранилища = ПоместитьВоВременноеХранилище(Результат.Data, УникальныйИдентификатор); ИмяФайла = Результат.Name + "." + Результат.Extension;
Операция setInteractionsViewed
Операция предназначена для установки признака просмотренности для списка взаимодействий.
Возвращаемое значение: boolean
| Параметр | Тип | Описание |
|---|---|---|
| UserId | string | Идентификатор пользователя |
| ListInteraction | ListInteraction | Список взаимодействия, для установки признака просмотренности |
Пример вызова операции на языке 1С:Предприятие при использовании библиотеки 1С:Библиотека технологии сервиса:
WSПрокси = ИнформационныйЦентрСервер.ПолучитьПроксиСлужбыПоддержки();
Фабрика = WSПрокси.ФабрикаXDTO;
ТипСписокВзаимодействий = Фабрика.Тип("http://www.1c.ru/1cFresh/InformationCenter/SupportServiceData/1.0.0.1", "ListInteraction");
СписокВзаимодействийXDTO = Фабрика.Создать(ТипСписокВзаимодействий);
МассивСтрок = Элементы.СписокВзаимодействий.ВыделенныеСтроки;
Для Каждого ЭлементМассива Из МассивСтрок Цикл
...
ВзаимодействиеXDTO = СформироватьВзаимодействиеXDTO(НайденнаяСтрока, Фабрика);
СписокВзаимодействийXDTO.Interactions.Добавить(ВзаимодействиеXDTO);
КонецЦикла;
WSПрокси.setInteractionsViewed(Строка(ИдентификаторПользователя), СписокВзаимодействийXDTO);
Операция addComments
Операция предназначена для добавления комментария пользователя.
Возвращаемое значение: boolean
| Параметр | Тип | Описание |
|---|---|---|
| UserID | string | Идентификатор пользователя |
| IncidentID | string | Идентификатор обращения |
| Name | string | Тема комментария |
| HTMLText | string | Текст комментария |
| CreateIncident | boolean | Признак, что нужно создать новое обращение |
| Files | ListFile | Список присоединенных файлов |
| ApplicationCode | int | Номер области |
| UserEmail | string | Адрес электронной почты для переписки |
Пример вызова операции на языке 1С:Предприятие при использовании библиотеки 1С:Библиотека технологии сервиса:
WSПрокси = ИнформационныйЦентрСервер.ПолучитьПроксиСлужбыПоддержки(); СписокФайловXDTO = СформироватьСписокФайловXDTO(WSПрокси.ФабрикаXDTO); WSПрокси.addComments(Строка(ИдПользователя), Строка(ИдОбращения), ТемаСообщения, ТекстHTML, СоздаватьОбращение, СписокФайловXDTO, ОбластьДанных, АдресДляОтвета);
Свойства операций
Класс Filter
Определяет отбор обращений
Значения перечисления:
- All – Все (без отбора)
- Closed – Закрытые
- InProgress – В работе
- NeedAnswer – Требующие ответа
- New – Новые
Класс Sort
Определяет порядок сортировки обращений
Значения перечисления:
- CreateDate – По дате создания
- LastInteractionDate – По дате последнего взаимодействия
Класс TypeInteracion
Определяет типы взаимодействий с пользователем
Значения перечисления:
- Email – Электронное письмо
- Comment – Комментарий пользователя
- PhoneCall – Телефонный звонок
Класс ListInteraction
Содержит список взаимодействий
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| Interactions | Interaction | Да | Взаимодействия |
Класс ListFile
Содержит список файлов
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| Files | File | Да | Файлы |
Объекты интеграции
Обращения
Класс Incident
Описывает обращение в службу поддержки.
Работу с классом можно посмотреть в обработке ИнформационныйЦентр в форме ОбращенияВСлужбуПоддержки.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| Date | dateTime | Да | Дата создания | |
| Id | string (36) | Идентификатор | ||
| LastInteractionDate | dateTime | Дата последнего взаимодействия | ||
| Name | string (500) | Тема | ||
| Number | string (15) | Номер | ||
| Status | UserIncidenStatus | Состояние | ||
| UnreviewedInteractions | Interaction | Да | Не просмотренные взаимодействия |
Класс IncidentListPresentation
Описывает представление страницы со списком обращений
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| incidents | Incident | Да | Обращения | |
| IsStill | boolean | Да | Признак, что текущая страница является последней в пагинаторе |
Свойства класса
Класс UserIncidenStatus
Определяет состояния обащений
Значения перечисления:
- Closed – Закрыто
- InProgress – В работе
- NeedAnswer – Требует ответа
- New – Новое
Взаимодействия
Класс Interaction
Описывает объекты взаимодействий с пользователем сервиса в службе поддержки.
Пример работы с классом можно посмотреть в обработке ИнформационныйЦентр в форме ВзаимодействиеПоОбращению.
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| Date | dateTime | Дата | |
| Description | string (0,2000) | Текстовое описание взаимодействия | |
| Files | File | Да | Присоединенные файлы |
| HTMLFiles | File | Да | Картинки для HTML-описания |
| HTMLText | string | HTML-описание взаимодействия | |
| Id | string (36) | Идентификатор взаимодействия | |
| Incoming | boolean | Признак, что взаимодействие предназначено для пользователя | |
| IsFiles | boolean | Признак наличия присоединенных файлов | |
| Name | string (500) | Тема | |
| Type | TypeInteracion | Тип взаимодействия | |
| Viewed | boolean | Признак просмотренности взаимодействия пользователем |
Класс InteractionListPresintation
Описывает представление страницы со списком взаимодействий
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| Interactions | любой тип | Да | Список взаимодействий | |
| IsStill | boolean | Да | Признак, что текущая страница является последней в пагинаторе |
Файлы
Класс File
Описывает присоединенные файлы к обращению службы поддержки.
Пример работы с классом можно посмотреть в обработке ИнформационныйЦентр в форме ВзаимодействиеПоОбращению.
| Свойство | Тип | Описание |
|---|---|---|
| Data | base64Binary | Двоичные данные файла в формате base64 |
| Extension | string (10) | Расширение |
| Id | string (36) | Идентификатор файла |
| Name | string | Имя файла без расширения |
| Size | int | Размер в байтах |