Как подключить гостя к конференции напрямую
Иногда возникают ситуации, когда необходимо провести конференцию прямо на сайте. Например, в телемедицине пациент может связаться с врачом через сайт больницы без установки сторонних программ.
Задача – создать конференцию для общения со специалистом телемедицины, чтобы пользователь мог подключиться к ней прямо на сайте.
Найти готовый пример реализации данного функционала вы можете на нашем Github.
В этой статье вы узнаете, как с помощью TrueConf Server API v3 реализовать видеосвязь прямо в браузере для телемедицины без авторизации на TrueConf Server. Это упрощает взаимодействие пользователя с врачом.
В сфере телемедицины возможны следующие варианты реализации:
- автоматическое соединение пациента со свободным специалистом;
- создание запланированной конференции на сайте и созданием события в календаре;
- чат с врачом из которого можно сразу подключится в конференцию.
Ниже мы покажем вариант реализации прямого подключения гостей к конференции. Гости – это участники, у которых нет учётной записи на вашем сервере ВКС. Важно учесть, что в этом сценарии учётные записи на сервере не требуются ни врачам, ни пациентам.
В нашем примере будет использоваться подключение гостя через браузер по WebRTC, так как этот вариант легко встраивается в любой сайт. При необходимости также можно использовать подключение через клиентское приложение.
Предварительная настройка TrueConf Server
- Убедитесь в наличии необходимого количества гостевых подключений в вашей лицензии в разделе Информация о сервере → Информация панели управления TrueConf Server. В базовой поставке TrueConf Server Free есть возможность создавать публичные конференции, но одновременно поддерживается 1 гостевое подключение. В этом случае вы можете подключать пациента, как гостя, а врача как пользователя зарегистрированного на сервере. Если требуется увеличить их число – обратитесь в отдел продаж для их покупки или активации на пробный период длительностью до 3 недель.
- Настройте HTTPS-соединение для обеспечения работы API.
Для дальнейших шагов используются различные методы API сервера, работающие по протоколу OAuth 2.0. Что это такое и как настроить взаимодействие с TrueConf Server по этому протоколу, читайте в нашей статье “Как начать работу с TrueConf API”.
Шаг 1. Создание публичной конференции
С помощью метода Create Conference создайте новую видеоконференцию, указав следующие обязательные параметры:
“id”: “Conference_ID”– задаём ID конференции, чтобы было удобнее к ней обращаться;“topic”— название конференции;“type”: 0— режим конфереции, в нашем случае “Все на экране”;"owner": "user1@server.name"— владелец (если подключаете врача как авторизованного пользователя — укажите TrueConf ID (логин) врача);"max_participants": 2— количество участников – 2;{"type": -1}– расписание конференции – на усмотрение пользователя, в нашем случае мы будем использовать виртуальную комнату, чтобы конференция создавалась “на лету”;"allow_guests": true– разрешить гостям подключаться к конференции;"allow_only_planned_participants": false– тип конференции – публичная;“recording”: 1– запись включена, т.к. по закону все видеоконсультации в сфере медицины должны записываться. Чтобы это было возможно, в соответствующем разделе панели управления сервером должна быть включена запись конференций по запросу."state": "running"– состояние конференции во время создания, в нашем случае создаём конференцию сразу запущенной.
В итоге объект Conference, который мы будем передавать в теле запроса выглядит так:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
"id": "Conference_ID", "type": 0, "topic": "Название конференции", "owner": "user1@server.name", "max_podiums": 2, "max_participants": 2, "schedule": {"type": -1}, "allow_guests": true, "rights": { chat_send: true, chat_rcv: true, slide_show_send: true, slide_show_rcv: true, white_board_send: true, white_board_rcv: true, file_transfer_send: true, file_transfer_rcv: true, desktop_sharing: true, recording: true, audio_send: true, audio_rcv: true, video_send: true, video_rcv: true }, "state": "running", "recording": 1, } |
В ответ вы получите JSON созданного объекта конференции. При этом ID конференции будет создан автоматически, если пользователь не указал конкретный, например, 0987654321.
Учтите, что если врач подключается как гость, необходимо использовать отдельную учётную запись TrueConf ID с правами владельца конференции.
При необходимости создания запланированной конференции, используйте объект Schedule. В нём должны быть указаны:
- тип запуска 1 (одноразовый запуск);
- время начала в формате Unix Timestamp;
- длительность консультации в секундах
Например, при планировании консультации на 01.01.2027 в 12:00 МСК (GMT+3) длительностью 30 минут, получим такой объект Shedule для передачи в теле запроса:
|
1 2 3 4 5 |
"schedule":{ "type":1, "start_time":1798794000, "duration":1800 } |
Шаг 2. Формирование ссылок для автоматического подключения гостей
Теперь вы можете создать и предоставить пациенту ссылку для автоматического подключения к видеоконсультации. При этом имя может браться, например, из данных его профиля на сайте медуслуг.
Получите авторизационные данные с помощью GET-метода Software Clients – Get Client List. При этом укажите такие параметры:
call_id: 0987654321– ID созданной конференции;case: join_conference_button– генерация прямых ссылок для подключения с помощью клиентских приложений;user: 2$Иван Иванов*Ivanov Ivan– отображаемое в конференции имя гостя. Символ $ обязателен. Есть два способа указать гостя при подключении через TrueConf API:- 2$Иван Иванов*Ivan Ivanov – параметр 2$ позволяет вручную задать TrueConf ID гостя. Это удобно, так как после подключения не нужно дополнительно получать ID с сервера. Однако, если пользователей с именем Иван Иванов несколько, вам нужно самостоятельно обеспечить уникальность ID, например с помощью суффиксов или хешей.
- $Иванов Иван – параметр, при котором уникальный ID создаётся автоматически и возвращается в ответе на запрос.
- Чтобы встроить окно конференции на сайт, найдите в JSON-ответе приложение с
"name": "TrueConf Web"и скопируйте из негоiframe. Перед вставкой замените//на/в URL фрейма. Ниже показан пример ответа с выделенным фрагментомiframe:
|
1 2 3 4 5 6 7 8 9 10 |
{ "name": "TrueConf Web", "type": "web", "platform": "webrtc", "download_url": "", "download_urls": null, "market_url": "", "web_url": "https://video.company.com/webrtc/0987654321#login=*guest*%D0%98%D0%B2%D0%B0%D0%BD%20%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2&token=$29cc834f607b1bffd0d5e68e47b4ead16*1619898725*641aad7d9e1e1a674416e16813939633&lang=auto", "iframe": "<iframe src=\"https://video.company.com/webrtc/0987654321#login=*guest*%D0%98%D0%B2%D0%B0%D0%BD%20%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2&token=$29cc834f607b1bffd0d5e68e47b4ead16*1619898725*641aad7d9e1e1a674416e16813939633&lang=auto\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>" } |
Альтернативные возможности подключения:
- Значение параметра
web_url– это ссылка для автоматического подключения через браузер участника к онлайн-консультации. - Также в JSON присутствует объект «deeplinks» со ссылками для подключения с помощью клиентских приложений TrueConf. При этом ссылка «default» используется для TrueConf для десктопов (Windows, Linux, macOS) и TrueConf для iOS/iPadOS, а ссылка «android» – для TrueConf для Android/Android TV:
|
1 2 3 4 |
"deeplinks": { "default": "trueconf:\\c\\5016799639@video.company.com%23vcs&h=172.18.246.126,172.17.0.1&force=1&templogin=1&login=*guest*%D0%98%D0%B2%D0%B0%D0%BD%20%D0%A1%D1%82%D0%B5%D0%BF%D0%B0%D0%BD&password=$291bcfe8bfc567822b4ff133c1b668fb7*1671525797*377ee8856b0404911fdeed524854d198&encrypt=0&autoclose=1", "android": "intent:\\c\\5016799639%40video.company.com%23vcs%26h%3d172.18.246.126,172.17.0.1%26force%3d1%26templogin%3d1%26login%3d*guest*%D0%98%D0%B2%D0%B0%D0%BD%20%D0%A1%D1%82%D0%B5%D0%BF%D0%B0%D0%BD%26password%3d$291bcfe8bfc567822b4ff133c1b668fb7*1671525797*377ee8856b0404911fdeed524854d198%26encrypt%3d0%26autoclose%3d1#Intent;scheme=trueconf;package=com.trueconf.videochat;end" } |
Требуется заменить двойные слэши на одинарные, то есть получим ссылки вида:
|
1 |
trueconf:\c\[ConferenceID]@[server_address]%23vcs&h=[server_address]&force=1&templogin=1&login=*guest*[guest_login]&password=$[password]&encrypt=0&autoclose=1 |
Тогда при наличии в системе приложения Труконф по нажатию на такую ссылку произойдёт его открытие и подключение к мероприятию.
Обратите внимание, что все полученные с помощью данного запроса ссылки – временные, и в целях безопасности срок их действия ограничен 1 минутой. Потому подключиться надо сразу после их генерации, например, создавать их непосредственно при нажатии на кнопку присоединения, которую вы добавите на сайте.
Шаг 3. Подключение в конференцию
После получения элемента iframe, остаётся запустить конференцию и подключиться к ней. Для запуска используйте API-запрос Run Conference, указав в запросе ID конференции:
https://server.name/api/v3.11/{conference_id}/run
После запуска конференции пользователь сможет подключиться как через полученный iframe, так и по прямой ссылке.
Возможности работы с запланированной конференцией
Если в вашем решении используются запланированные конференции, вы можете добавить их в личные календари пациента и врача, чтобы участники не пропустили видеоконсультацию. Для этого предоставьте обоим участникам ссылки для интеграции, получив их с помощью GET-запроса Get Conference Calendars. В ответ вы получите JSON, который содержит ссылки для добавления мероприятия в календари Google, Outlook, и файл ics для других сервисов.
Когда наступит время видеоконсультации, конференция автоматически начнётся и врач получит в неё вызов. Пациенту же надо будет перейти по ссылке, которую он добавил в свой календарь, и он сразу подключится к мероприятию под своим именем.
Для проверки вы можете перейти по данной ссылке в браузере. Если ранее в нём не были даны разрешения на доступ к оборудованию, то появится окно настройки микрофона и камеры перед подключением.
Обратите внимание!
Корректно данный метод работает только при переходе гостем в запланированную конференцию после времени её начала, т.к. подключиться заранее к ней может только её владелец.
Димитрий Зуйков
Дата публикации: 20.12.2022
