Протокол «trueconf:» для взаимодействия с клиентскими приложениями TrueConf
Димитрий Зуйков
31 января 2023Клиентские приложения TrueConf поддерживают специальный протокол trueconf:, который действует на уровне операционной системы и позволяет управлять вызовами и другими функциями через короткие команды, которые можно поместить в ссылку или кнопку в браузере, запустить в консоли или вставить в скрипт.
Протокол trueconf: поддерживается для всех клиентских приложений TrueConf (Windows, Linux, macOS, Android/Android TV, iOS/iPadOS) и программного терминала TrueConf Room.
В этой статье мы опишем основные возможности протокола и покажем примеры его использования в виде ссылки в браузере.
Формат обращения к протоколу trueconf:
Все возможные вызовы протокола trueconf: можно описать в общем виде как:
|
1 |
trueconf:[target][@server]&[param_1]=[value_1]&[...]&[param_n]=[value_n] |
Здесь:
- [target] – логин пользователя (TrueConf ID), ID конференции или любая другая строка вызова;
- [server] – IP-адрес или FQDN сервера для направления вызова или авторизации;
- [param_n] – название дополнительного параметра;
- [value_n] – название дополнительного параметра;
- […] – другие дополнительные параметры, которые задаются аналогично первому и последнему.
Какие действия поддерживает протокол?
| Функция | Формат и примеры вызова |
|---|---|
| Запуск и авторизация | |
| Запуск приложения | trueconf: |
| Авторизация | trueconf:login=[login]&password=[password]&encrypt=1&force=1
trueconf:login=user&password=pswd&encrypt=1&force=1 Параметр encrypt=1 активирует шифрование пароля перед его передачей на сервер и является обязательным. Параметр force=1 обеспечивает принудительную авторизацию и необходим если пользователь уже залогинен в приложении. |
| Авторизация на другом сервере | trueconf:h=[TrueConfServer]&login=[login]&password=[password]&encrypt=1&force=1
trueconf:h=192.168.12.123&login=user&password=pswd&encrypt=1&force=1 |
| Вызов пользователя | |
| Звонок в рамках сервера | trueconf:[user]
trueconf:ivan |
| Вместо имени пользователя сервера вы можете использовать любую строку вызова. Например: | |
| Звонок на другой сервер | trueconf:[user]@[TrueConfServer]
trueconf:ivan@conf.company.com |
| Подключение к RTSP-трансляции | trueconf:#[rtsp_address] обязательно замените все слэши / на %2ftrueconf:#rtsp:%2f%2fdomainn.company.com:554 |
| Присоединение к конференции | |
| Присоединение к конференции по ID [CID] | trueconf:\c\[CID]
trueconf:\c\4154248070 |
| Присоединение к конференции по ID [CID] на другом сервере | trueconf:\c\[CID]@[server]%23vcs
trueconf:\c\4154248070@video.example.com%23vcs |
| Звонок в конференцию, где [user] – ведущий | trueconf:[user]&conftype=hotquery
trueconf:ivan&conftype=hotquery |
| Другие функции | |
| Закрыть приложение после завершения звонка/конференции (работает только если оно не было предварительно запущено) | Добавить &autoclose=1 в конец любой команды
trueconf:ivan&autoclose=1 |
Можно объединить в одной ссылке несколько команд. Например, авторизацию пользователя на сервере truevideo.example.com и звонок в конференцию на сервере video.example.com:
|
1 |
trueconf:\c\737734033583@video.example.com%23vcs&h=truevideo.example.com&login=user&password=pswd&encrypt=1&force=1 |
