Автоматическая очистка конференций через TrueConf API

В TrueConf Server и его бесплатной версии Free начиная с версии 5.3.0 присутствует возможность автоматически удалять завершившиеся конференции. Как работать с данным способом удаления мероприятий мы рассказали в документации для администраторов TrueConf Server. В этой статье мы обсудим как сделать это с помощью периодически запускаемой программы, использующей TrueConf Server API.

О том, что представляет собой API сервера и как с ним работать, подробно рассказано в статье “Как начать работу с TrueConf API”.

Постановка задачи

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

Следует принять во внимание, что нельзя просто удалить все мероприятия со статусом “остановлено”, потому что его имеют все неактивные конференции, независимо от того, запускались ли они хоть раз до этого. Более того, надо не учитывать те из них, у которых настроен периодический запуск, например, раз в неделю, ведь они ещё могут быть необходимы в дальнейшем.

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

Ознакомиться с примером кода с поддержкой описанного алгоритма можно на нашем GitHub.

Шаг 1. Вычисление даты и времени для удаления

Вычислите дату, старше которой требуется удалить конференции. Для этого отнимите необходимое количество дней от текущей даты. Полученный результат требуется перевести в формат Unix Timestamp. Например, если надо удалить конференции, завершившиеся до 1.06.2021 00:00 МСК, то получим число 1622494800.

Шаг 2. Получение списка конференций

Получите список конференций с помощью GET-метода Get Conference List, указав дополнительный параметр state=stopped (статус – остановлена).

В ответ вы получите JSON со списком объектов Conference.

Работа с параметром tags

Если вы создаёте конференции с помощью API-запроса Create Conference и желаете удалить не все завершившиеся конференции, вы можете уменьшить размер списка, который мы получили выше. Для этого создавайте мероприятия, требующие удаления, с определённым тегом. Например, задавая параметр "tags":["delete"]. Тогда вы сможете использовать параметр tag=delete для уточнения списка завершившихся конференций в вашем GET-запросе:

Шаг 3. Поиск конференций для удаления

У каждой конференции из полученного списка:

1. Проверьте тип запуска в объекте Schedule (должен быть "type":1 – одноразовый запуск).
2. Если время окончания конференции (время старта start_time плюс продолжительность duration) меньше полученного на шаге 1 значения, то запомните её ID и переходите к следующему шагу.

Шаг 4. Удаление конференции

Удалите конференцию с помощью DELETE-запроса Delete Conference, указав её ID.

Для того чтобы показанный алгоритм был применим к виртуальным комнатам вам необходимо пометить конференцию при создании или редактировании каким-либо тегом (см. выше описание параметра tags) и удалять все мероприятия из полученного списка с этим тегом.