Как включить запись для уже запущенной конференции

Автор28.04.2021Дата написанияОколо 5 минВремя чтенияПроведение конференцийКатегорияAPI / SDKТеги

Первым и самым удобным методом включения записи конференции на сервере будет использование данной функции в Расширенном управлении конференцией прямо в приложении Труконф (начиная с версии 5.2.9.11282 и далее):

  • В уже начатой конференции открыть Расширенное управление конференцией.

  • В правом верхнем углу появившегося окна нажать /blog/baza-znaniy/media/how-to-enable-recording-of-ongoing-conferences/2-1/ru.png.

  • В меню выбрать Запись конференции.

  • Нажать появившуюся кнопку /blog/baza-znaniy/media/how-to-enable-recording-of-ongoing-conferences/1-1/ru.png, после чего начнется отсчет времени записываемой конференции.

  • Для завершения записи снова нажмите на кнопку /blog/baza-znaniy/media/how-to-enable-recording-of-ongoing-conferences/1-1/ru.png.

Подробнее узнать о том, как правильно настроить запись, читайте в нашей документации.

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

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

Подготовка к работе

О том, как использовать TrueConf Server API и что для этого требуется, подробно рассказано в статье “Как начать работу с TrueConf API”. Также вам понадобится создать конференцию любым удобным способом: в клиентском приложении, в панели управления сервером или же с помощью API.

Шаг 1. Запуск конференции

Записывать можно только активное мероприятие, поэтому запустите созданную конференцию с помощью POST-запроса Run Conference. Проверьте, что она успешно началась, выполнив GET-запрос Get Conference:

https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}?access_token={{$access_token}}

где:

  • {{$server_name}} – IP-адрес или внешний адрес из раздела Веб → Настройки установленного TrueConf Server, например server.company.name;

  • {{$access_token}} – токен доступа, сформированный как показано в статье о начале работы с API, например dvN1tpoy7BmVhN8nUMzXcqJ8vsDYt4IN;

  • {{$conference_id}} – ID вашей конференции, например, 0007.

В рассматриваемом примере:

https://server.company.name/api/v3.3/conferences/0007?access_token=dvN1tpoy7BmVhN8nUMzXcqJ8vsDYt4IN

В полученном в ответе JSON-объекте конференции обратите внимание на параметр "state" – он принимает одно из значений:

  • "running" – конференция запущена;

  • "stopped" – конференция остановлена.

Таким образом, вы должны получить значение "state": "running".

Шаг 2. Запуск процесса записи

Чтобы запустить или продолжить после паузы запись конференции, используйте POST-запрос Conference Record Start:

https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}

Например, для конференции с ID 0007:

https://server.company.name/api/v3.3/conferences/0007/start-record?access_token=dvN1tpoy7BmVhN8nUMzXcqJ8vsDYt4IN

Шаг 3. Проверка хода записи

Для проверки состояния процесса записи требуется снова получить объект Conference по ID с помощью GET-запроса Get Conference.

В ответном JSON-объекте конференции обратите внимание на параметр "stream_recording_state" – он принимает одно из значений:

  • 0 – запись не производится;

  • 1 – идёт запись;

  • 2 – процесс записи поставлен на паузу.

Таким образом, вы получите значение "stream_recording_state": 1.

Шаг 4. Постановка записи на паузу

Для временной приостановки процесса записи используйте POST-запрос Conference Record Pause:

https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}

Например:

https://server.company.name/api/v3.3/conferences/0007/pause-record?access_token=dvN1tpoy7BmVhN8nUMzXcqJ8vsDYt4IN

Вы можете ставить на паузу и возобновлять запись с помощью шагов 2 и 4 нужное число раз. При этом после продолжения записи не создаётся новый видеофайл, а дописывается уже имеющийся.

Шаг 5. Прекращение записи конференции

Остановите запись с помощью POST-запроса Conference Record Stop:

https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}

В нашем случае:

https://video.trueconf.com/api/v3.3/conferences/0007/stop-record?access_token=dvN1tpoy7BmVhN8nUMzXcqJ8vsDYt4IN

Также запись остановится автоматически при завершении конференции.

Аналогичным образом вы можете управлять записью на сервере даже созданной на лету в клиентском приложении групповой конференцией, используя её ID. Посмотреть его можно в приложении на вкладке Управление конференцией → Инструменты, или же в панели управления сервером в разделе Отчёты → История звонков.