Розділ 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 ви можете викликати цю кінцеву точку, використовуючи свої облікові дані API, які можна знайти в панелі керування сервером. Переконайтеся, що ідентифікатори записів відповідають записам, які належать вашому екземпляру сервера.

Рекомендовані практики

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

Реалізуйте крок підтвердження у вашому застосунку перед викликом цієї кінцевої точки, оскільки сам API не вимагає підтвердження.

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

Під час видалення кількох записів об’єднуйте їх в один запит, розділений комами, замість виконання окремих API-викликів для кожного запису.

Поширені запитання

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

Так. Передайте список ID записів, розділений комами, у параметрі recordID. Усі вказані записи буде видалено за один виклик.

API може повернути помилку notFound, якщо не вдасться зіставити жоден із указаних ID записів. Якщо змішано дійсні та недійсні ID, поведінка може відрізнятися залежно від версії BigBlueButton. Рекомендується перевірити всі ID перед надсиланням запиту.

Так, але лише якщо ви явно запитаєте їх, встановивши параметр state у значення deleted або any у вашому виклику getRecordings. За замовчуванням видалені записи приховані в результатах.

Ні. API BigBlueButton не надає ендпойнта для відновлення видалених записів. Відновлення можливе лише на рівні файлової системи сервера системним адміністратором.
Посібник з API BigBlueButton