Как использовать TrueConf API для видеозвонков с сайта

Елизавета Несова
06.05.2019
Елизавета Несова
Категории: База знаний

С помощью TrueConf Server API вы можете создать виджет для мгновенных видеозвонков через ваш веб-сайт. Такой виджет позволит гостю сайта в любой момент совершить звонок его менеджеру для личной видеоконсультации. Ему достаточно будет указать имя, не заполняя при этом никаких контактных форм.

Добавить виджет на ваш сайт очень просто. Чтобы начать, установите TrueConf Server

Скачать TrueConf Server →

Настройка сервера займет не более 15 минут вашего времени.

Как взаимодействовать с API

Доступ к API сервера осуществляется по протоколу OAuth 2.0. Более подробно вы можете прочитать об этом в документации TrueConf Server.

Обращение к TrueConf Server API заключается в отправке HTTP-запросов на сервер. Ответы на запросы сервер возвращает в формате объектов JSON.

Список функций TrueConf Server, доступных через API, можно узнать тут:

Документация API v3

План установки виджета

Общий план действий будет таким:

Этап 1 — через API-запросы организуйте видеозвонок на TrueConf Server. Для этого нужно будет создать конференцию на двух участников, один из которых будет менеджером вашего веб-сайта.

Этап 2 в панели управления TrueConf Server получите html-код виджета видеозвонка.

Этап 3 разместите виджет на странице своего сайта.

Использование API

Подготовка TrueConf Server

  1. Настройте на сервере поддержку HTTPS cоединения
  2. Добавьте в пользователи cервера менеджера вашего веб-сайта, который будет принимать видеозвонки от гостей.
  3. Получите секретный ключ доступа к API в разделе панели управления сервером Веб → Безопасность.

А теперь приступим!

Использование TrueConf API

1. Создайте конференцию с помощью метода Conferences, задав такие параметры:

  • "schedule":{"type":"-1"}без расписания;
  • "max_participants": 2 на двух участников;
  • "auto_invite": 1автоматическое приглашение участника при запуске.

Владельцем конференции назначьте менеджера вашего сайта, указав его имя пользователя на TrueConf Server. Например, "owner":"george".

Приведенный ниже пример TrueConf Server API запроса, как и следующие за ним, оформлены для использования с cURL

Если конференция будет успешно создана, от сервера придёт ответ с данными о конференции.

Запомните значения параметров id и url страницы конференции.

2. Добавьте менеджера вашего веб-сайта в участники созданной конференции (выше он был назначен ее владельцем), используя метод Conferences_Invitations. В качестве параметра $conference_id метода укажите id из предыдущего пункта.

В ответ на такой запрос придёт объект с данными о добавленном участнике.

Готово!

Добавление виджета на сайт

Используйте шаблон html-кода виджета из панели управления TrueConf Server, как это показано в нашей статье. В параметр src вставьте url, полученный из объекта с данными о конференции в ответе API.

После того, как гость сайта присоединится к конференции через виджет видеозвонка, TrueConf Server автоматически отправит приглашение менеджеру сайта (параметр auto_invite).

Приятных конференций!

Подписка на новости