Глава 13 GET POST

deleteRecordings – Удалить записи

Эндпоинт deleteRecordings безвозвратно удаляет одну или несколько записей с вашего сервера BigBlueButton. Вы можете передать один ID записи или список, разделённый запятыми, чтобы удалить несколько записей одним запросом.

Этот вызов API вступает в силу немедленно, без какого-либо запроса на подтверждение. Убедитесь, что у вас правильные ID записей, прежде чем отправлять запрос. Удалённые записи нельзя восстановить через API.

Конечная точка

GET https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?<parameters>&checksum=replace-with-checksum

Параметры

Параметр Тип Обязательно По умолчанию Описание
recordID String Да — Один идентификатор записи или список идентификаторов записей, разделённых запятыми, для удаления.

Пример запроса

Удалить одну запись: 

https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?recordID=replace-with-recording-id&checksum=replace-with-checksum

Удалить несколько записей за один вызов: 

https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?recordID=replace-with-recording-id-1,replace-with-recording-id-2&checksum=replace-with-checksum

Пример ответа

Успешный вызов возвращает следующий XML: 

<response>
  <returncode>SUCCESS</returncode>
  <deleted>true</deleted>
</response>

Ответы с ошибками

messageKey Описание
checksumError checksum недействителен.
missingParamRecordID Параметр recordID не был передан.
notFound На сервере не найдена запись с указанным идентификатором.

Записи не удаляются с диска физически сразу. Сервер перемещает файлы в каталог deleted/. Администратор сервера потенциально может восстановить удалённые записи из этого каталога до их окончательной очистки.

Поведение после удаления

  • Статус записи изменяется на deleted.
  • Удалённые записи больше не отображаются в стандартных ответах getRecordings.
  • Чтобы получить удалённые записи через API, передайте state=deleted или state=any в качестве параметра state в вызове getRecordings.
На bbbserver.de вы можете вызвать этот endpoint, используя свои учетные данные API, найденные в панели управления сервером. Убедитесь, что идентификаторы записей соответствуют записям, принадлежащим вашему экземпляру сервера.

Рекомендации

Всегда проверяйте идентификаторы записей с помощью вызова getRecordings перед удалением, чтобы избежать удаления неправильных записей.

Реализуйте в вашем приложении шаг подтверждения перед вызовом этого endpoint, поскольку сам API не требует подтверждения.

Журналируйте каждый запрос на удаление, включая идентификаторы записей и временные метки, чтобы можно было отследить, какие записи были удалены и когда.

При удалении нескольких записей объединяйте их в один запрос со списком, разделённым запятыми, вместо выполнения отдельных вызовов API для каждой записи.

Часто задаваемые вопросы

Не сразу. Сервер перемещает файлы записи в специальный каталог deleted. Администратор сервера может восстановить их оттуда, пока файлы не будут окончательно удалены процессом очистки. Однако API-эндпоинта для восстановления удалённых записей не существует.

Да. Передайте список ID записей, разделённый запятыми, в параметре recordID. Все указанные записи будут удалены одним вызовом.

API может вернуть ошибку notFound, если ни один из указанных ID записей не может быть сопоставлен. При смешивании корректных и некорректных ID поведение может различаться в зависимости от версии BigBlueButton. Рекомендуется проверять все ID перед отправкой запроса.

Да, но только если вы явно запросите их, установив параметр state в значение deleted или any в вашем вызове getRecordings. По умолчанию удалённые записи скрыты из результатов.

Нет. API BigBlueButton не предоставляет эндпоинт для восстановления удалённых записей. Восстановление возможно только на уровне файловой системы сервера системным администратором.
Руководство по API BigBlueButton