Перейти к основному содержимому

СистемаВзаимодействия

Стд::СистемаВзаимодействия::СистемаВзаимодействия Тип-одиночка Доступность: КлиентИСервер

Минимальная поддерживаемая версия API сервера системы взаимодействия: версия 8. Версия API соответствует минимальной версии сервера системы взаимодействия "8.0.15". Версия API может быть указана в адресе сервера системы взаимодействия.

Предоставляет возможность работы с сервером системы взаимодействия.

Сравнение ссылочное

Иерархия типа​

Базовые типы: Объект, Одиночка

Методы​

ЗагрузитьВложение​

Доступность: Сервер

ЗагрузитьВложение(
Файл: Файл|Строка,
ТипСодержимого: Строка? = Неопределено,
Таймаут: Длительность = 15с,
Прокси: ИнтернетПрокси? = Неопределено
): ВложениеВзаимодействия
Перегрузка:
ЗагрузитьВложение(Содержимое: Байты|ПотокЧтения, Имя: Строка, ТипСодержимого: Строка?, Таймаут: Длительность = 15с, Прокси: ИнтернетПрокси? = Неопределено): ВложениеВзаимодействия

Загрузить вложение на сервер взаимодействия.

  • Файл - файл вложения.
  • ТипСодержимого - MIME тип содержимого. На основе расширения файла идет автоматическое вычисление типа. Если тип не указан или не удалось вычислить, то будет использовано значение application/octet-stream. Максимальная длина значения - 512 символов.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
  • Прокси - прокси для подключения к хранилищу сервера взаимодействия.

Исключения​

ИсключениеСистемыВзаимодействия - если на сервере взаимодействия не настроено внешнее файловое хранилище или возникла проблема при загрузке. ИсключениеОграниченияСистемыВзаимодействия - если на сервере взаимодействия превышен лимит на загрузку файлов.

ЗагрузитьВложение​

Доступность: Сервер

ЗагрузитьВложение(
Содержимое: Байты|ПотокЧтения,
Имя: Строка,
ТипСодержимого: Строка?,
Таймаут: Длительность = 15с,
Прокси: ИнтернетПрокси? = Неопределено
): ВложениеВзаимодействия
Перегрузка:
ЗагрузитьВложение(Файл: Файл|Строка, ТипСодержимого: Строка? = Неопределено, Таймаут: Длительность = 15с, Прокси: ИнтернетПрокси? = Неопределено): ВложениеВзаимодействия

Загрузить вложение на сервер взаимодействия.

  • Содержимое - содержимое вложения.
  • Имя - имя вложения с учетом расширения. Например, "Картинка.png". Максимальная длина имени - 1024 символа.
  • ТипСодержимого - MIME тип содержимого. Если тип не указан, то будет использовано значение application/octet-stream. Максимальная длина значения - 512 символов.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.
  • Прокси - прокси для подключения к хранилищу сервера взаимодействия.

Исключения​

ИсключениеСистемыВзаимодействия - если на сервере взаимодействия не настроено внешнее файловое хранилище или возникла проблема при загрузке. ИсключениеОграниченияСистемыВзаимодействия - если на сервере взаимодействия превышен лимит на загрузку файлов.

ЗарегистрироватьПриложение​

Доступность: Сервер

ЗарегистрироватьПриложение(
ПочтаАбонента: Строка,
ИмяПриложения: Строка,
Сервер: Строка,
КодАктивации: Строка = "",
Таймаут: Длительность = 15с)

Зарегистрировать приложение в системе взаимодействия. При активации приложения будет автоматически создан пользователь в системе взаимодействия с привилегированными правами. Данные регистрации будут записаны в базу данных приложения, по аналогии с работой метода УстановитьДанныеРегистрацииПриложения.

  • ПочтаАбонента - Почта абонента в системе взаимодействия, в рамках одного абонента может быть несколько приложений в системе взаимодействия.
  • ИмяПриложения - Имя текущего приложения в системе взаимодействия, используется для представления приложения.
  • Сервер - Адрес сервера системы взаимодействия, по умолчанию - адрес 1С: Диалог.
  • КодАктивации - Код активации для регистрации приложения в системе взаимодействия.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Метод доступен только пользователям с правами администратора.

Особенности:

Если используется сервер 1С: Диалог, то нужно обязательно передать код активации. Для его получения нужно вызвать метод ЗапроситьКодАктивации и получить на почту код активации.

Важно: если передать уже использованный код активации приложения и выполнить операцию под владельцем абонента, может быть обновлено уже существующее приложение у абонента. Если используется свой сервер взаимодействия, рекомендуется в код активации передавать случайную уникальную строку, например, текущий момент времени или уникальный идентификатор.

Исключения​

ИсключениеСистемыВзаимодействия - если регистрация приложения не выполнена.

ИспользованиеДоступно​

Доступность: КлиентИСервер

ИспользованиеДоступно(Таймаут: Длительность = 15с): Булево

Возвращает признак того, что приложение взаимодействия зарегистрировано и текущий пользователь аутентифицирован в системе взаимодействия.

НайтиИнтеграцию​

Доступность: Сервер

НайтиИнтеграцию(
ИдИнтеграции: Строка|Ууид,
Таймаут: Длительность = 15с
): ИнтеграцияВзаимодействия?

Возвращает интеграцию системы взаимодействия по ее идентификатору. Если интеграция не найдена, будет возвращено Неопределено.

  • ИдИнтеграции - Идентификатор интеграции, которую нужно получить.
  • Длительность - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

НайтиОбсуждение​

Доступность: Сервер

НайтиОбсуждение(
ИдОбсуждения: Строка|Ууид,
Таймаут: Длительность = 15с
): ОбсуждениеВзаимодействия?

Возвращает обсуждение взаимодействия по его идентификатору или ключу в параметре ИдОбсуждения.

  • ИдОбсуждения - Идентификатор обсуждения или его ключ.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

НайтиОбсуждения​

Доступность: Сервер

@ИменованныеПараметры
НайтиОбсуждения(
Вид: ВидОбсужденияВзаимодействия? = Неопределено,
Ключ: Строка? = Неопределено,
Видимость: Булево? = Неопределено,
ДатаОбновления: Момент? = Неопределено,
СКонтекстнымиОбсуждениями: Булево? = Неопределено,
Контекст: КонтекстОбсужденияВзаимодействия? = Неопределено,
ТекущийПользовательУчастник: Булево? = Неопределено,
Участники: ЧитаемыйМассив<Ууид>? = Неопределено,
ИдИнтеграции: Ууид? = Неопределено,
ЛимитОбсуждений: Число = 100,
Таймаут: Длительность = 15с
): ЧитаемыйМассив<ОбсуждениеВзаимодействия>

Вызов возможен только с именованными параметрами

Возвращает список обсуждений, которые соответствуют установленным фильтрам.

  • Вид - Фильтр по виду обсуждений.
  • Ключ- Фильтр по ключу обсуждений.
  • Видимость - Фильтр по видимости обсуждений.
  • ДатаОбновления - Фильтр по дате обновления обсуждений. Будут возвращены обсуждения, у которых последнее сообщение было написано позже или в указанный момент времени.
  • СКонтекстнымиОбсуждениями - Фильтр для включения контектстных обсуждений в результат поиска.
  • Контекст - Фильтр по контексту обсуждения.
  • ТекущийПользовательУчастник - Отобрать обсуждения, в которых участвует текущий пользователь взаимодействия.
  • Участники - Фильтр, позволяет отобрать обсуждения, в которых участвуют указанные участники. Если указан параметр ТекущийПользовательУчастник, тогда обсуждения будут фильтроваться сначала по этом полю и дополнительно по полю Участники
  • ИдИнтеграции - Фильтр позволяет отобрать обсуждения, относящиеся к определенной интеграции.
  • ЛимитОбсуждений - Ограничение количества обсуждений.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Особенности:

  • Только в привилегированном режиме доступны все обсуждения, не только те, в которых участвует текущий пользователь взаимодействия.
  • Контекстные обсуждения доступны, если у текущего пользователя взаимодействия есть права на чтение сущностей, которые указаны в контекстах обсуждений.

НайтиПользователейВзаимодействия​

Доступность: Сервер

@ИменованныеПараметры
НайтиПользователейВзаимодействия(
Имя: Строка? = Неопределено,
ПолноеИмя: Строка? = Неопределено,
ЭлектроннаяПочта: Строка? = Неопределено,
Телефон: Строка? = Неопределено,
КлючСопоставления: Строка? = Неопределено,
Заблокирован: Булево? = Неопределено,
ЛимитПользователей: Число = 100,
НачальныйПользователь: ПользовательВзаимодействия|Ууид|? = Неопределено,
Таймаут: Длительность = 15с
): ЧитаемыйМассив<ПользовательВзаимодействия>

Вызов возможен только с именованными параметрами

Возвращает список пользователей, соответствующий указанному фильтру. Если значение параметра равно Неопределено, то фильтр при поиске не будет использоваться.

  • Имя - Фильтр по имени пользователя.
  • ПолноеИмя - Фильтр по полному имени пользователя.
  • ЭлектроннаяПочта - Фильтр по электронной почте пользователя.
  • Телефон - Фильтр по номеру телефона пользователя.
  • КлючСопоставления - Фильтр по ключу сопоставления пользователя.
  • Заблокирован - Фильтр по признаку заблокирован у пользователя.
  • ЛимитПользователей - Ограничение на количество записей.
  • НачальныйПользователь - Начальный пользователь взаимодействия или его идентификатор в системе взаимодействия.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Метод доступен только в привилегированном режиме.

НайтиСообщение​

Доступность: Сервер

НайтиСообщение(
ИдСообщения: Ууид,
Таймаут: Длительность = 15с
): СообщениеВзаимодействия?

Возвращает сообщение системы взаимодействия по его идентификатору. Если сообщение не найдено, будет возвращено Неопределено.

  • ИдСообщения - Идентификатор сообщения, которое нужно получить.
  • Длительность - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ОбъединитьПриложения​

Доступность: Сервер

ОбъединитьПриложения(
ОбъединениеПриложений: ОбъединениеПриложенийВзаимодействия,
Таймаут: Длительность = 15с)

Объединяет приложения взаимодействия в единое пространство. Работает только в рамках одного абонента.

  • ОбъединениеПриложений - Объединение приложений взаимодействия.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

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

Исключения​

ИсключениеОбъединенияПриложенийСистемыВзаимодействия - если одно из приложений взаимодействия не существует.

ОжидатьНовыеСообщения​

Доступность: Сервер

ОжидатьНовыеСообщения(Таймаут: Длительность = 5м): ЧитаемыйМассив<СообщениеВзаимодействия>

Ожидать получение новых сообщений взаимодействия.

  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ОтменитьОбъединениеПриложений​

Доступность: Сервер

ОтменитьОбъединениеПриложений(
ИдПриложения: Ууид,
ИдПарногоПриложения: Ууид,
Таймаут: Длительность = 15с)

Отменяет объединение приложений взаимодействия.

  • ИдПриложения - Идентификатор приложения взаимодействия.
  • ИдПарногоПриложения - Идентификатор парного приложения взаимодействия.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Идентификаторы объединенных приложений взаимодействия можно получить с помощью метода ПолучитьОбъединенияПриложений.

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

Исключения​

ИсключениеОбъединенияПриложенийСистемыВзаимодействия - если одно из приложений взаимодействия не существует.

ОтменитьРегистрациюПриложения​

Доступность: Сервер

ОтменитьРегистрациюПриложения()

Отменить регистрацию приложения взаимодействия. Буду очищены данные регистрации приложения взаимодействия в текущем приложении.

Метод доступен только пользователям с правами администратора.

ПоддерживаютсяВложения​

Доступность: Сервер

ПоддерживаютсяВложения(Таймаут: Длительность = 15с): Булево

Возвращает признак, подключено ли внешнее хранилище файлов к серверу взаимодействия.

  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПодключитьОбработчикНовыхСообщений​

Доступность: Клиент

ПодключитьОбработчикНовыхСообщений(
ИдОбсуждения: Ууид,
Обработчик: (Строка)->ничто,
Таймаут: Длительность = 15с)

Подключает обработчик ожидания новых сообщений в обсуждении.

  • ИдОбсуждения - Идентификатор обсуждения, по которому будет подключено ожидание новых сообщений.
  • Обработчик - Обработчик новых сообщений. На вход передается текст сообщения.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Рекомендуется вызывать метод через ПодключитьОбработчикТаймера, чтобы не блокировать интерфейс в ожидании аутентификации в системе взаимодействия.

ПолучитьВерсиюApi​

Доступность: Сервер

ПолучитьВерсиюApi(Таймаут: Длительность = 15с): Число

Возвращает текущую версию протокола взаимодействия с сервером взаимодействия.

  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьВерсиюСервераВзаимодействия​

Доступность: Сервер

ПолучитьВерсиюСервераВзаимодействия(Таймаут: Длительность = 15с): Строка

Возвращает версию сервера взаимодействия, к которому подключено текущее приложение.

  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьВидыВнешнихСистем​

Доступность: Сервер

ПолучитьВидыВнешнихСистем(Таймаут: Длительность = 15с): ЧитаемыйМассив<Строка>

Возвращает поддерживаемые сервером взаимодействия типы внешних систем.

  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьДанныеРегистрацииПриложения​

Доступность: Сервер

ПолучитьДанныеРегистрацииПриложения(): ДанныеРегистрацииПриложенияВзаимодействия?

Возвращает данные регистрации приложения взаимодействия, зарегистрированные в приложении. Если данные регистрации не установлены, то будет возвращено Неопределено.

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

Метод доступен только пользователям с правами администратора.

ПолучитьИдПользователяВзаимодействия​

Доступность: Сервер

ПолучитьИдПользователяВзаимодействия(
Пользователь: Пользователи.Ссылка,
Таймаут: Длительность = 15с
): Ууид?

Возвращает идентификатор того пользователя системы взаимодействия, который соответствует ссылке на пользователя приложения.

  • Пользователь - Ссылка на пользователя приложения.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

ПолучитьИдТекущегоПользователяВзаимодействия​

Доступность: КлиентИСервер

ПолучитьИдТекущегоПользователяВзаимодействия(Таймаут: Длительность = 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с
): СообщениеВзаимодействия

Отредактировать существующее сообщение.

  • ИдСообщения - Идентификатор сообщения, которое нужно отредактировать.
  • Получатели - Получатели сообщения.
  • ТекстСообщения - Текст сообщения.
  • Данные - Данные сообщения.
  • Вложения - Вложения сообщения.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Особенности:

  • Если какой-то из параметров Получатели, ТекстСообщения, Данные или Вложения равно Неопределено, то это значение в сообщении не будет изменено.

Исключения​

ИсключениеНеНайденОбъектСистемыВзаимодействия - если сообщение не существует. ИсключениеЗапретаДоступаСистемыВзаимодействия - если нет доступа к сообщению.

СоздатьИнтеграцию​

Доступность: Сервер

СоздатьИнтеграцию(
Имя: Строка,
ВидВнешнейСистемы: Строка,
ПараметрыВнешнейСистемы: ЧитаемоеСоответствие<Строка, Строка>,
Участники: ЧитаемыйМассив<Ууид>,
Ключ: Строка? = Неопределено,
Активно: Булево = Истина,
Таймаут: Длительность = 30с
): Ууид

Создает и возвращает идентификатор интеграции с внешней системой в системе взаимодействия.

  • Имя - Название интеграции для представления ее в пользовательском интерфейсе.
  • ВидВнешнейСистемы - Вид внешней системы системы взаимодействия: "Telegram", "WhatsApp", "WebChat" и т.д.
  • ПараметрыВнешнейСистемы - Предопределенные параметры подключения внешней системы (соответствие ключа и значения), уникальные для каждого типа внешней системы.
  • Ключ - Ключ интеграции системы взаимодействия. Если не пустая строка, то должен быть уникальным.
  • Участники - Список Ид участников по умолчанию для обсуждения, созданного интеграцией с внешней системой. По умолчанию используется пустой массив.
  • Активно - Определяет включение/отключение интеграции
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Метод доступен только пользователям с правами администратора.

СоздатьКонтекстноеОбсуждение​

Доступность: Сервер

СоздатьКонтекстноеОбсуждение(
Контекст: КонтекстОбсужденияВзаимодействия,
Видимость: Булево = Истина,
Таймаут: Длительность = 15с
): Ууид

Создает и возвращает идентификатор контекстного обсуждения взаимодействия.

  • Контекст - Контекст обсуждения.
  • Видимость - Признак видимости обсуждения для интерактивной работы.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

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

СоздатьЛичноеОбсуждение​

Доступность: Сервер

СоздатьЛичноеОбсуждение(
Участник: Ууид,
ВторойУчастник: Ууид? = Неопределено,
Таймаут: Длительность = 15с
): Ууид

Создает и возвращает идентификатор обсуждения в системе взаимодействия между двумя участниками. Обсуждение этого типа может быть только одно на приложение.

  • Участник - Идентификатор участника.
  • ВторойУчастник - Идентификатор второго участника. Если не указано, то будет использован идентификатор текущего пользователя.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

СоздатьОбсуждение​

Доступность: Сервер

СоздатьОбсуждение(
Участники: ЧитаемыйМассив<Ууид>,
Название: Строка,
Ключ: Строка = "",
Видимость: Булево = Истина,
Таймаут: Длительность = 15с
): Ууид

Создает и возвращает идентификатор группового обсуждения в системе взаимодействия.

  • Участники - Идентификаторы участников обсуждения.
  • Название - Название обсуждения.
  • Ключ - Ключ обсуждения.
  • Видимость - Признак видимости обсуждения для интерактивной работы.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

СоздатьПользователяВзаимодействия​

Доступность: Сервер

@ИменованныеПараметры
СоздатьПользователяВзаимодействия(
Пользователь: Пользователи.Ссылка,
ЭлектроннаяПочта: Строка = "",
Телефон: Строка = "",
КлючСопоставления: Строка = "",
Изображение: Байты,
Таймаут: Длительность = 15с
): Ууид

Вызов возможен только с именованными параметрами

Создает нового пользователя в системе взаимодействия и возвращает его идентификатор.

  • Пользователь - Ссылка на пользователя приложения.
  • ЭлектроннаяПочта - Электронная почта пользователя. Максимальная длина 255 символов.
  • Телефон - Номер телефона пользователя. Максимальная длина 32 символа.
  • КлючСопоставления - Ключ сопоставления пользователя.
  • Изображение- Аватар пользователя. Размер ограничен в 32КБ. Поддерживаются форматы, перечисленные в ФорматИзображения.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Исключения​

ИсключениеОбъектСуществуетВСистемеВзаимодействия - если пользователь уже существует в системе взаимодействия.

СоздатьСообщение​

Доступность: Сервер

СоздатьСообщение(
ИдОбсуждения: Ууид,
Получатели: Ууид|ЧитаемыйМассив<Ууид>|? = Неопределено,
ТекстСообщения: Строка = "",
Данные: Строка = "",
Вложения: ЧитаемыйМассив<ВложениеВзаимодействия>,
Таймаут: Длительность = 15с
): Ууид

Создает и возвращает идентификатор сообщения в системе взаимодействия.

  • ИдОбсуждения - Идентификатор обсуждения.
  • Получатели - Идентификаторы получателей сообщения в системе взаимодействия.
  • ТекстСообщения - Текст сообщения.
  • Данные - Сериализованные в строку данные, которые дополнительно передаются в сообщении с типом данных "application/vnd.1c.json-internal".
  • Вложения - Вложения сообщения.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

УдалитьСообщение​

Доступность: Сервер

УдалитьСообщение(
ИдСообщения: Ууид,
Таймаут: Длительность = 15с)

Удаляет сообщение системы взаимодействия по его идентификатору.

  • ИдСообщения - Идентификатор сообщения, которое нужно удалить.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

Исключения​

ИсключениеНеНайденОбъектСистемыВзаимодействия - если сообщение не существует. ИсключениеЗапретаДоступаСистемыВзаимодействия - если нет доступа к сообщению.

УстановитьДанныеРегистрацииПриложения​

Доступность: Сервер

УстановитьДанныеРегистрацииПриложения(ДанныеРегистрации: ДанныеРегистрацииПриложенияВзаимодействия)

Установить данные регистрации приложения взаимодействия.

  • ДанныеРегистрации - Данные регистрации приложения взаимодействия.

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

Метод доступен только пользователям с правами администратора.

УстановитьПоследнееПрочитанноеСообщение​

Доступность: Сервер

УстановитьПоследнееПрочитанноеСообщение(
ИдОбсуждения: Ууид,
ИдСообщения: Ууид,
Таймаут: Длительность = 15с)

Устанавливает последнее прочитанное сообщение в обсуждении.

  • ИдОбсуждения - Идентификатор обсуждения.
  • ИдСообщения - Идентификатор сообщения.
  • Таймаут - Таймаут, который определяет предельное время выполнения запроса к системе взаимодействия.

УстановитьТекущегоПользователяВзаимодействия​

Доступность: Сервер

УстановитьТекущегоПользователяВзаимодействия(Пользователь: Пользователи.Ссылка): КонтекстПользователяВзаимодействия

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

  • Пользователь - Пользователь, под которым будет выполнены действия в системе взаимодействия.

Метод доступен только с правами администратора.

Список унаследованных методов​

Объект​

ВСтроку, ПолучитьТип, Представление

Последнее обновление