СистемаВзаимодействия
Стд::СистемаВзаимодействия::СистемаВзаимодействия Тип-одиночка
Минимальная поддерживаемая версия API сервера системы взаимодействия: версия 24. Версия API соответствует минимальной версии сервера системы взаимодействия "8.3.10". Версия API может быть указана в адресе сервера системы взаимодействия.
Предоставляет возможность работы с сервером системы взаимодействия.
Сравнение ссылочное
Иерархия типа
Базовые типы: Объект, Одиночка
Методы
Войти
Войти(
КлючиПриложения: КлючиПриложенияВзаимодействия,
ИдПользователяПриложения: Ууид,
ИмяПользователяПриложения: Строка,
ПолноеИмяПользователяПриложения: Строка,
ПараметрыПриложения: ПараметрыПриложенияВзаимодействия,
ПривилегированныйРежим: Булево = Ложь,
Таймаут: Длительность = 15с
): УуидВозвращает идентификатор пользователя на сервере системы взаимодействия.
КлючиПриложения- Ключи шифрования приложения.ИдПользователяПриложения- Идентификатор пользователя приложения.ИмяПользователяПриложения- Краткое имя пользователя приложения.ПолноеИмяПользователяПриложения- Полное имя пользователя приложения.ПараметрыПриложения- Специальный объект, в котором содержатся параметры приложения системы взаимодействия.ПривилегированныйРежим- Признак того, что вход должен быть выполнен в привилегированном (Истина) или обычном (Ложь) режиме.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ЗагрузитьВложение
ЗагрузитьВложение(
Файл: Файл|Строка,
ТипСодержимого: Строка? = Неопределено,
Таймаут: Длительность = 15с,
Прокси: ИнтернетПрокси? = Неопределено
): ВложениеВзаимодействияЗагрузитьВложение(Содержимое: Байты|ПотокЧтения, Имя: Строка, ТипСодержимого: Строка?, Таймаут: Длительность = 15с, Прокси: ИнтернетПрокси? = Неопределено): ВложениеВзаимодействия
Загрузить вложение на сервер взаимодействия.
Файл- файл вложения.ТипСодержимого- MIME тип содержимого. На основе расширения файла идет автоматическое вычисление типа. Если тип не указан или не удалось вычислить, то будет использовано значениеapplication/octet-stream. Максимальная длина значения - 512 символов.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.Прокси- прокси для подключения к хранилищу сервера взаимодействия.
Исключения
ИсключениеСистемыВзаимодействия - если на сервере взаимодействия не настроено внешнее файловое хранилище или возникла проблема при загрузке. ИсключениеОграниченияСистемыВзаимодействия - если на сервере взаимодействи я превышен лимит на загрузку файлов.
ЗагрузитьВложение
ЗагрузитьВложение(
Содержимое: Байты|ПотокЧтения,
Имя: Строка,
ТипСодержимого: Строка?,
Таймаут: Длительность = 15с,
Прокси: ИнтернетПрокси? = Неопределено
): ВложениеВзаимодействияЗагрузитьВложение(Файл: Файл|Строка, ТипСодержимого: Строка? = Неопределено, Таймаут: Длительность = 15с, Прокси: ИнтернетПрокси? = Неопределено): ВложениеВзаимодействия
Загрузить вложение на сервер взаимодействия.
Содержимое- содержимое вложения.Имя- имя вложения с учетом расширения. Например, "Картинка.png". Максимальная длина имени - 1024 символа.ТипСодержимого- MIME тип содержимого. Если тип не указан, то будет использовано значениеapplication/octet-stream. Максимальная длина значения - 512 символов.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.Прокси- прокси для подключения к хранилищу сервера взаимодействия.
Исключения
ИсключениеСистемыВзаимодействия - если на сервере взаимодействия не настроено внешнее файловое хранилище или возникла проблема при загрузке. ИсключениеОграниченияСистемыВзаимодействия - если на сервере взаимодействия превышен лимит на загрузку файлов.
НайтиИнтеграцию
НайтиИнтеграцию(
ИдИнтеграции: Строка|Ууид,
Таймаут: Длительность = 15с
): ИнтеграцияВзаимодействия?Неопределено.
ИдИнтеграции- Идентификатор интеграции, которую нужно получить.Длительность- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
НайтиОбсуждение
НайтиОбсуждение(
ИдОбсуждения: Строка|Ууид,
Таймаут: Длительность = 15с
): ОбсуждениеВзаимодействия?ИдОбсуждения.
ИдОбсуждения- Идентификатор обсуждения или его ключ.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
НайтиОбсуждения
@ИменованныеПараметры
НайтиОбсуждения(
Вид: ВидОбсужденияВзаимодействия? = Неопределено,
Ключ: Строка? = Неопределено,
Видимость: Булево? = Неопределено,
ДатаОбновления: Момент? = Неопределено,
ТекущийПользовательУчастник: Булево? = Неопределено,
Участники: ЧитаемыйМассив<Ууид>? = Неопределено,
ИдИнтегарции: Ууид? = Неопределено,
ИдВнешнегоОбсуждения: Строка? = Неопределено,
ЛимитОбсуждений: Число = 100,
Таймаут: Длительность = 15с
): ЧитаемыйМассив<ОбсуждениеВзаимодействия>Вызов возможен только с именованными параметрами
Возвращает список обсуждений, которые соответствуют установленным отборам.
Вид- Отбор по виду обсуждений.Ключ- Отбор по ключу обсуждений.Видимость- Отбор по видимости обсуждений.ДатаОбновления- Отбор по дате обновления обсуждений. Будут возвращены обсуждения, у которых последнее сообщение было написано позже или в указанный момент времени.ТекущийПользовательУчастник- Отобрать обсуждения, в которых участвует текущий пользователь взаимодействия.Участники- Фильтр, позволяет отобрать обсуждения, в которых участвуют указанные участники. Если указан параметрТекущийПользовательУчастник, тогда обсуждения будут фильтроваться сначала по этом полю и дополнительно по полюУчастникиИдИнтеграции- Фильтр позволяет отобрать обсуждения, относящиеся к определенной интеграции.ИдВнешнегоОбсуждения- Фильтр в комбинации с параметром ИдИнтеграции, позволяет отобрать внешнее обсуждение, например обсуждение с указанным абонентом WhatsApp.ЛимитОбсуждений- Ограничение количества обсуждений.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Особенности:
Только в привилегированном режиме доступны все обсуждения, не только те, в которых участвует текущий пользователь взаимодействия.
НайтиПользователейВзаимодействия
@ИменованныеПараметры
НайтиПользователейВзаимодействия(
Имя: Строка? = Неопределено,
ПолноеИмя: Строка? = Неопределено,
ЭлектроннаяПочта: Строка? = Неопределено,
Телефон: Строка? = Неопределено,
КлючСопоставления: Строка? = Неопределено,
Заблокирован: Булево? = Неопределено,
ЛимитПользователей: Число = 100,
НачальныйПользователь: ПользовательВзаимодействия|Ууид|? = Неопределено,
Таймаут: Длительность = 15с
): ЧитаемыйМассив<ПользовательВзаимодействия>Вызов возможен только с именованными параметрами
Возвращает список пользователей, соответствующий указанному отбору. Если значение параметра равно Неопределено, то отбор при поиске не будет использоваться.
Имя- Отбор по имени пользователя.ПолноеИмя- Отбор по полному имени пользователя.ЭлектроннаяПочта- Отбор по электронной почте пользователя.Телефон- Отбор по номеру телефона пользователя.КлючСопоставления- Отбор по ключу сопоставления пользователя.Заблокирован- Отбор по признаку заблокирован у пользователя.ЛимитПользователей- Ограничение на количество записей.НачальныйПользователь- Начальный пользователь взаимодействия или его идентификатор в системе взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Метод доступен только в привилегированном режиме.
НайтиСообщение
НайтиСообщение(
ИдСообщения: Ууид,
Таймаут: Длительность = 15с
): СообщениеВзаимодействия?Неопределено.
ИдСообщения- Идентификатор сообщения, которое нужно получить.Длительность- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
НайтиШаблонСообщения
НайтиШаблонСообщения(
ИдШаблона: Ууид,
Таймаут: Длительность = 15с
): ШаблонСообщенияВзаимодействия?ИдШаблона- Идентификатор шаблона сообщения Системы Взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ОбъединитьПриложения
ОбъединитьПриложения(
ОбъединениеПриложений: ОбъединениеПриложенийВзаимодействия,
Таймаут: Длительность = 15с)ОбъединениеПриложений- Объединение приложений взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Метод доступен только с правами администратора и под пользователем, который является владельцем абонента.
Исключения
ИсключениеОбъединенияПриложенийСистемыВзаимодействия - если одно из приложений взаимодействия не существует.
ОжидатьНовыеСообщения
ОжидатьНовыеСообщения(Таймаут: Длительность = 5м): ЧитаемыйМассив<СообщениеВзаимодействия>Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Отключиться
Отключиться()ОтменитьОбъединениеПриложений
ОтменитьОбъединениеПриложений(
ИдПриложения: Ууид,
ИдПарногоП риложения: Ууид,
Таймаут: Длительность = 15с)ИдПриложения- Идентификатор приложения взаимодействия.ИдПарногоПриложения- Идентификатор парного приложения взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Идентификаторы объединенных приложений взаимодействия можно получить с помощью метода ПолучитьОбъединенияПриложений.
Метод доступен только с правами администратора и под пользователем, который является владельцем абонента.
Исключения
ИсключениеОбъединенияПриложенийСистемыВзаимодействия - если одно из приложений взаимодействия не существует.
ОтписатьсяОтОбсуждения
ОтписатьсяОтОбсуждения(
ИдОбсуждения: Ууид,
Таймаут: Длительность = 15с)ИдОбсуждения.
Если пользователь не подписан на обсуждение, то исключение не будет выброшено.
Исключения
ИсключениеЗапретаДоступаСистемыВзаимодействия - если к обсуждению нет доступа. ИсключениеНеНайденОбъектСистемыВзаимодействия - если обсуждения не существует.
ПоддерживаютсяВложения
ПоддерживаютсяВложения(Таймаут: Длительность = 15с): БулевоТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Подключиться
Подключиться(
Сервер: Строка,
ПараметрыСоединения: ПараметрыЗащищенногоСоединения,
Таймаут: Длительность = 15с)Подключиться(Сервер: Строка, ФайлХранилища: Строка = "", ПарольХранилища: Секрет|Строка = "", ПарольКлюча: Секрет|Строка = "", Таймаут: Длительность = 15с)
Подключает к серверу системы взаимодействия.
Сервер- Строка с адресом сервера взаимодействия, к которому выполняется подключение. По умолчанию используется адрес сервера1С: Диалог.ПараметрыСоединения- Параметры защищенного соединения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Подключиться
Перегрузка:
Подключиться(Сервер: Строка, ПараметрыСоединения: ПараметрыЗащищенногоСоединения, Таймаут: Длительность = 15с)
Подключает к серверу системы взаимодействия.
Сервер- Строка с адресом сервера взаимодействия, к которому выполняется подключение. По умолчанию используется адрес сервера1С: Диалог.ФайлХранилища- Путь к файлу, содержащему сертификат сервера системы взаимодействия.ПарольХранилища- Пароль для доступа к файлу-хранилищу.ПарольКлюча- Пароль для доступа к сертификату системы взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПодключитьсяБезПроверкиСертификата
ПодключитьсяБезПроверкиСертификата(
Сервер: Строка,
Таймаут: Длительность = 15с)Сервер- Строка с адресом сервера взаимодействия, к которому выполняется подключение. По умолчанию используется адрес сервера1С: Диалог.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПодписатьсяНаОбсуждение
ПодписатьсяНаОбсуждение(
ИдОбсуждения: Ууид,
Таймаут: Длительность = 15с)ИдОбсуждения.
В групповых обсуждениях это делается автоматически, при включении пользователя в участники.
В контекстных обсуждениях это происходит только, когда пользователь написал сообщение в обсуждении или его упомянули в обсуждении.
Исключения
ИсключениеЗапретаДоступаСистемыВзаимодействия - если к обсуждению нет доступа. ИсключениеНеНайденОбъектСистемыВзаимодействия - если обсуждения не существует.
Примеры
метод ПодписатьсяНаКонтекстноеОбсуждение(ИдОбсуждения: Ууид)
попытка
СистемаВзаимодействия.ПодписатьсяНаОбсуждение(ИдОбсуждения)
поймать Исключение: ИсключениеЗапретаДоступаСистемыВзаимодействия|ИсключениеНеНайденОбъектСистемыВзаимодействия
// игнорируем
;
;
ПолучитьВерсиюApi
ПолучитьВерсиюApi(Таймаут: Длительность = 15с): ЧислоТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьВерсиюСервераВзаимодействия
ПолучитьВерсиюСервераВзаимодействия(Таймаут: Длительность = 15с): СтрокаТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьВидыВнешнихСистем
ПолучитьВидыВнешнихСистем(Таймаут: Длительность = 15с): ЧитаемыйМассив<Строка>Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьВремяОкончанияДоступностиОтвета
ПолучитьВремяОкончанияДоступностиОтвета(
ИдОбсуждения: Ууид,
Таймаут: Длительность = 15с
): Момент?ИдОбсуждения- Идентификатор обсуждения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьИдПользователяВзаимодействия
ПолучитьИдПользователяВзаимодействия(
ИдПользователяПриложения: Ууид,
Таймаут: Дли тельность = 15с
): Ууид?ИдПользователяПриложения- Идентификатор пользователя приложения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Примеры
// ранее известный идентификатор пользователя
знч ИдПользователяПриложения = Ууид{6c79fc60-2373-11ed-861d-0242ac120002}
знч ИдПользователяВСистемеВзаимодействия = СистемаВзаимодействия.ПолучитьИдПользователяВзаимодействия(ИдПользователяПриложения)
знч Пользовате льВзаимодействия = СистемаВзаимодействия.ПолучитьПользователяВзаимодействия(ИдПользователяВСистемеВзаимодействия)
ПолучитьИдТекущегоПользователяВзаимодействия
ПолучитьИдТекущегоПользователяВзаимодействия(Таймаут: Длительность = 15с): УуидТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьИнтеграции
ПолучитьИнтеграции(
ЛимитИнтеграций: Число = 100,
Таймаут: Длительность = 15с
): ЧитаемыйМассив<ИнтеграцияВзаимодействия>Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Исключения
ИсключениеСистемыВзаимодействия - если метод вызван не с правами администратора
ПолучитьНепрочитанныеОбсуждения
ПолучитьНепрочитанныеОбсуждения(
Видимые: Булево? = Неопределено,
ЛимитОбсуждений: Число = 100,
Таймаут: Длительность = 15с
): Массив<Ууид>Видимые- Признак для фильтрации по свойству обсужденияВидимость.ЛимитОбсуждений- Ограничение количества обсуждений, которое может вернуть метод (максимальное значение равно 100).Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьНепрочитанныеСообщения
ПолучитьНепрочитанныеСообщения(
ИдОбсуждения: Ууид,
ЛимитСообщений: Число = 100,
Таймаут: Длительность = 15с
): Массив<СообщениеВзаимодействия>ИдОбсуждения- Идентификатор обсуждения.ЛимитСообщений- Ограничение количества сообщений, которое может вернуть метод (максимальное значение равно 100).Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьОбсуждения
ПолучитьОбсуждения(
ИдОбсуждений: ЧитаемыйМассив<Ууид>,
Таймаут: Длительность = 15с
): Массив<ОбсуждениеВзаимодействия>ИдОбсуждений.
ИдОбсуждений- Список идентификаторов обсуждений.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьОбъединенияПриложений
ПолучитьОбъединенияПриложений(Таймаут: Длительность = 15с): ЧитаемыйМассив<ОбъединениеПриложенийВзаимодействия>Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Метод доступен только с правами администратора и под пользователем, который является владельцем абонента.
ПолучитьОписаниеВнешнейСистемы
ПолучитьОписаниеВнешнейСистемы(
ВидВнешнейСистемы: Строка,
Таймаут: Длительность = 15с
): ОписаниеВнешнейСистемыВзаимодействия?ВидВнешнейСистемы- Вид внешней системы взаимодействия: "Telegram", "WhatsApp", "WebChat" и т.д.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьПользователяВзаимодействия
ПолучитьПользователяВзаимодействия(
Ид: Ууид,
Таймаут: Длительность = 15с
): ПользовательВзаимодействия?Ид- Идентификатор пользователя в системе взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьПочтуАбонента
ПолучитьПочтуАбонента(Таймаут: Длительность = 15с): СтрокаТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Исключения
ИсключениеЗапретаДоступаСистемыВзаимодействия - если пользователь не является администратором абонента в системе взаимодействия.
ПолучитьПриложениеАбонента
ПолучитьПриложениеАбонента(
ИдПриложения: Ууид,
Таймаут: Длительность = 15с
): ПриложениеВзаимодействия?ИдПриложения- идентификатор приложения взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьПриложенияАбонента
ПолучитьПриложенияАбонента(Таймаут: Длительность = 15с): ЧитаемыйМассив<ПриложениеВзаимодействия>Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьСообщения
ПолучитьСообщения(
ИдОбсуждения: Ууид,
ЛимитСообщений: Число = 100,
НачальноеСообщение: Ууид? = Неопределено,
Таймаут: Длительность = 15с
): Массив<СообщениеВзаимодействия>ИдОбсуждения- Идентификатор обсуждения.ЛимитСообщений- Ограничение количества сообщений, которое может вернуть метод (максимальное значение равно 100).НачальноеСообщение- Сообщение, после которого будут получены сообщения обсуждения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьТекущегоПользователяВзаимодействия
ПолучитьТекущегоПользова теляВзаимодействия(Таймаут: Длительность = 15с): ПользовательВзаимодействияТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьТекущееПриложение
ПолучитьТекущееПриложение(Таймаут: Длительность = 15с): ПриложениеВзаимодействияТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
ПолучитьШаблоныСообщения
ПолучитьШаблоныСообщения(
ИдИнтеграции: Ууид,
Таймаут: Длительность = 15с
): ЧитаемыйМассив<ШаблонСообщенияВзаимодействия>ИдИнтеграции- Идентификатор интеграции, для которой возвращается список шаблонов сообщений.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
РедактироватьИнтеграцию
@ИменованныеПараметры
РедактироватьИнтеграцию(
ИдИнтеграции: Ууид,
Имя: Строка? = Неопределено,
ПараметрыВнешнейСистемы: ЧитаемоеСоответствие<Строка, Строка>? = Неопределено,
Ключ: Строка? = Неопределено,
Участники: ЧитаемыйМассив<Ууид>? = Неопределено,
Активно: Булево? = Неопределено,
Таймаут: Длительность = 15с)Вызов возможен только с именованными параметрами
Изменяет существующую интеграцию взаимодействия.
Имя- Название интеграции для представления ее в пользовательском интерфейсе.ВидВнешнейСистемы- Вид внешней системы взаимодействия: "Telegram", "WhatsApp", "WebChat" и т.д.ПараметрыВнешнейСистемы- Предопределенные параметры подключения внешней системы (соответствие ключа и значения), уникальные для каждого типа внешней системы.Ключ- Ключ интеграции системы взаимодействия. Если не пустая строка, то должен быть уникальным.Участники- Список Ид участников по умолчанию для обсуждения, созданного интеграцией с внешней системой. По умолчанию использу ется пустой массив.Активно- Определяет включение/отключение интеграцииТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
РедактироватьОбсуждение
РедактироватьОбсуждение(
ИдОбсуждения: Ууид,
Участники: ЧитаемыйМассив<Ууид>,
Название: Строка,
Таймаут: Длительность = 15с)ИдОбсуждения- Идентификатор обсуждения.Участники- Идентификаторы участников обсуждения.Название- Название обсуждения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
РедактироватьПользователяВзаимодействия
@ИменованныеПараметры
РедактироватьПользователяВзаимодействия(
Ид: Ууид,
Имя: Строка? = Неопределено,
ПолноеИмя: Строка? = Неопределено,
ЭлектроннаяПочта: Строка? = Неопределено,
Телефон: Строка? = Неопределено,
КлючСопоставления: Строка? = Неопределено,
Изображение: Байты? = Неопределено,
Заблокирован: Булево? = Неопределено,
Таймаут: Длительность = 15с
): ПользовательВзаимодействияВызов возможен только с именованными параметрами
Редактирует данные пользователя взаимодействия по его идентификатору пользователя.
Если значение параметра равно Неопределено, то свойство пользователя взаимодействия не будет изменено при редактировании.
Ид- Идентификатор пользователя в системе взаимодействия.Имя- Имя пользователя.ПолноИмя- Полное имя пользователя.ЭлектроннаяПочта- Электронная почта пользователя. Максимальная длина 255 символов.Телефон- Номер телефона пользователя. Максимальная длина 32 символа.КлючСопоставления- Ключ сопоставления пользователя.Изображение- Аватар пользователя.Заблокирован- Признак, что пользователь заблокирован в системе взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Доступно только в привилегированном режиме.
Исключения
ИсключениеНеНайденОбъектСистемыВзаимодействия - если пользователь не суще ствует в системе взаимодействия.
РедактироватьСообщение
РедактироватьСообщение(
ИдСообщения: Ууид,
Получатели: Ууид|ЧитаемыйМассив<Ууид>|? = Неопределено,
ТекстСообщения: Строка? = Неопределено,
Данные: Строка? = Неопределено,
Вложения: ЧитаемыйМассив<ВложениеВзаимодействия>? = Неопределено,
Таймаут: Длительность = 15с
): СообщениеВзаимодействияИдСообщения- Идентификатор сообщения, которое нужно отредактировать.Получатели- Получатели сообщения.ТекстСообщения- Текст сообщения.Данные- Данные сообщения.Вложения- Вложения сообщения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Особенности:
- Если какой-то из параметров
Получатели,ТекстСообщения,ДанныеилиВложенияравноНеопределено, то это значение в сообщении не будет изменено.
Исключения
ИсключениеНеНайденОбъектСистемыВзаимодействия - если сообщение не существует. ИсключениеЗапретаДоступаСистемыВзаимодействия - если нет доступа к сообщению.
СоздатьИнтеграцию
СоздатьИнтеграцию(
Имя: Строка,
ВидВнешнейСистемы: Строка,
ПараметрыВнешнейСистемы: ЧитаемоеСоответствие<Строка, Строка>,
Участники: ЧитаемыйМассив<Ууид>,
Ключ: Строка? = Неопределено,
Активно: Булево = Истина,
Таймаут: Длительность = 15с
): УуидИмя- Название интеграции для представления ее в пользовательском интерфейсе.ВидВнешнейСистемы- Вид внешней системы системы взаимодействия: "Telegram", "WhatsApp", "WebChat" и т.д.ПараметрыВнешнейСистемы- Предопределенные параметры подключения внешней системы (соответствие ключа и значения), уникальные для каждого типа внешней системы.Ключ- Ключ интеграции системы взаимодействия. Если не пустая строка, то должен быть уникальным.Участники- Список Ид участников по умолчанию для обсуждения, созданного интеграцией с внешней системой. По умолчанию используется пустой массив.Активно- Определяет включение/отключение интеграцииТаймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Метод доступен только пользователям с правами администратора.
СоздатьЛичноеОбсуждение
СоздатьЛичноеОбсуждение(
Участник: Ууид,
ВторойУчастник: Ууид? = Неопределено,
Таймаут: Длительность = 15с
): УуидУчастник- Идентификатор участника.ВторойУчастник- Идентификатор второго участника. Если не указано, то будет использован идентификатор текущего пользователя.Таймау т- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
СоздатьОбсуждение
СоздатьОбсуждение(
Участники: ЧитаемыйМассив<Ууид>,
Заголовок: Строка,
Ключ: Строка = "",
Видимость: Булево = Истина,
Таймаут: Длительность = 15с
): УуидУчастники- Идентификаторы участников обсуждения.Название- Название обсуждения.Ключ- Ключ обсуждения.Видимость- Признак видимости обсуждения для интерактивной работы.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
СоздатьОбсуждениеСВнешнимПользователем
СоздатьОбсуждениеСВнешнимПользователем(
ИдИнтеграции: Ууид,
ИдВнешнегоОбсуждения: Строка,
Участники: ЧитаемыйМассив<Ууид>,
Ключ: Строка = "",
Видимость: Булево = Истина,
Таймаут: Длительность = 15с
): УуидИдИнтеграции- Идентификатор интеграции, для которой создается обсуждение.ИдВнешнегоОбсуждения- Идентификатор обсуждения во внешней системе. Для WhatsApp это номер телефона.Участники- Идентификаторы участников обсуждения.Название- Название обсуждения.Ключ- Ключ обсуждения системы взаимодействия. Если не пустая строка, то должен быть уникальным.Видимость- Признак видимости обсуждения для интерактивной работы.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
СоздатьПользователяВзаимодействия
@ИменованныеПараметры
СоздатьПользователяВзаимодействия(
ИдПользователяПриложения: Ууид,
Имя: Строка,
ПолноеИмя: Строка,
ЭлектроннаяПочта: Строка = "",
Телефон: Строка = "",
КлючСопоставления: Строка = "",
Изображение: Байты,
Таймаут: Длительность = 15с
): УуидВызов возможен только с именованными параметрами
Создает нового пользователя в системе взаимодействия.
ИдПользователяПриложения- идентификатор пользователя приложения.Имя- имя пользователя.ПолноИмя- полное имя пользователя.ЭлектроннаяПочта- электронная почта пользователя. Максимальная длина 255 символов.Телефон- номер телефона пользователя. Максимальная длина 32 символа.КлючСопоставления- ключ сопоставления пользователя.Изображение- аватар пользователя. Размер ограничен в 32КБ. Поддерживаются форматы, перечисленные в ФорматИзображения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Доступно только в привилегированном режиме.
Исключения
ИсключениеОбъектСуществуетВСистемеВзаим одействия - если пользователь по ИдПользователяПриложения уже существует в системе взаимодействия.
СоздатьСообщение
СоздатьСообщение(
ИдОбсуждения: Ууид,
Получатели: Ууид|ЧитаемыйМассив<Ууид>|? = Неопределено,
ТекстСообщения: Строка = "",
Данные: Строка = "",
Вложения: ЧитаемыйМассив<ВложениеВзаимодействия>,
Таймаут: Длительность = 15с
): УуидИдОбсуждения- Идентификатор обсуждения.Получатели- Идентификаторы получателей сообщения в системе взаимодействия.ТекстСообщения- Текст сообщения.Данные- Сериализованные в строку данные, которые дополнительно передаются в сообщении с типом данных "application/vnd.1c.json-internal".Вложения- Вложения сообщения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Примеры
Отправить сообщение с прайс-листом во вложениях:
// загрузим вложение на сервер взаимодействия
знч Файл = новый Файл("C:/test/price.xlsx")
знч Вложение = СистемаВзаимодействия.ЗагрузитьВложение(
Содержимое = Файл.ОткрытьПотокЧтения(),
Имя = "price.xlsx",
ТипСодержимого = "application/octet-stream"
)
знч ИдОбсуждения = Ууид{5c31ada8-4565-11ed-b878-0242ac120002} // ранее созданное обсуждение
// создадим сообщение с вложением
знч ИдСообщения = СистемаВзаимодействия.СоздатьСообщение(
ИдОбсуждения = ИдОбсуждения,
Вложения = [Вложение])
// получим сообщение и его вложение
знч Сообщение = СистемаВзаимодействия.НайтиСообщение(ИдСообщения)
знч ВходящееВложение = Сообщение.Вложения[0]
знч ИдВложения = ВходящееВложение.Ид // 1aee7439-6268-4f01-a4e3-432ac0dd79f4
знч ИмяФайла = ВходящееВложение.Имя // price.xlsx
знч РазмерФайла = ВходящееВложение.Размер // 1024(в байтах)
знч Содержимое: Байты = ВходящееВложение.ПолучитьБайты()
// сохраним вложение на компьютер
пер НовыйФайл = новый Файл("C:/test/price_new.xlsx")
исп ПотокЗаписи = НовыйФайл.ОткрытьПотокЗаписи()
ПотокЗаписи.Записать(Содержимое)
СоздатьСообщениеПоШаблону
СоздатьСообщениеПоШаблону(
ИдОбсуждения: Ууид,
ИдШаблона: Ууид,
ЗначенияПараметровШаблона: ЧитаемыйМассив<Строка>? = Неопределено,
Получатели: Ууид|ЧитаемыйМассив<Ууид>|? = Неопределено,
Таймаут: Длительность = 15с
): УуидИдОбсуждения- Идентификатор обсуждения.ИдШаблона- Идентификатор шаблона сообщения Системы Взаимодействия.ЗначенияПараметровШаблона- Содержит значения параметров шаблонного сообщения. По умолчанию - Неопределено.Получатели- Идентификаторы получателей сообщения в системе взаимодействия.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Примеры
Отправить шаблонное сообщение с указанием значения параметра:
знч ИдОбсуждения = Ууид{5c31ada8-4565-11ed-b878-0242ac120002} // ранее созданное обсуждение
знч КлючИнтеграцииWA = "ИнтеграцияWhatsApp" // ранее созданная интеграция
пер Интеграция = СистемаВзаимодействия.НайтиИнтеграцию(КлючИнтеграцииWA)
пер ШаблоныСообщения = СистемаВзаимодействия.ПолучитьШаблоныСообщения(Интеграция.Ид)
пер ШаблонПриветствия: ШаблонСообщенияВзаимодействия = ШаблоныСообщения[3]
пер ИдСообщения = СистемаВзаимодействия.СоздатьСообщениеПоШаблону(
ИдОбсуждения = ИдОбсуждения,
ИдШаблона = ШаблонПриветствия.Ид,
["Василий"])
УдалитьСообщение
УдалитьСообщение(
ИдСообщения: Ууид,
Таймаут: Длительность = 15с)ИдСообщения- Идентификатор сообщения, которое нужно удалить.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
Исключения
ИсключениеНеНайденОбъектСистемыВзаимодействия - если сообщение не существует. ИсключениеЗапретаДоступаСистемыВзаимодействия - если нет доступа к сообщению.
УстановитьПоследнееПрочитанноеСообщение
УстановитьПоследнееПрочитанноеСообщение(
ИдОбсуждения: Ууид,
ИдСообщения: Ууид,
Таймаут: Длительность = 15с)ИдОбсуждения- Идентификатор обсуждения.ИдСообщения- Идентификатор сообщения.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
УстановитьПредставлениеШаблонаСообщения
УстановитьПредставлениеШаблонаСообщения(
ИдШаблона: Ууид,
ПредставлениеШаблона: Строка,
ПредставленияПараметровШаблона: ЧитаемыйМассив<Строка>? = Неопределено,
Таймаут: Длительность = 15с)ИдШаблона- Идентификатор шаблона сообщения Системы Взаимодействия.ПредставлениеШаблона- Представление шаблона сообщения Системы Взаимодействия.ПредставленияПараметровШаблона- Представления параметров в тексте шаблона сообщения. По умолчанию Неопределено.Таймаут- Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.