Розділ 14 GET POST

updateRecordings – Оновити метадані

Кінцева точка updateRecordings дозволяє додавати, змінювати або видаляти метадані для одного чи кількох наявних записів. Це корисно для позначення записів після завершення зустрічі — наприклад, для додавання імені доповідача, категорії або ідентифікатора курсу — без повторної обробки самого запису.

Ендпоінт

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings?<parameter>&checksum=replace-with-checksum

Підтримуються методи GET і POST. При використанні POST надсилайте параметри як application/x-www-form-urlencoded у тілі запиту.

Обов’язкові параметри

Параметр Тип Опис
recordID String Обов’язково. Список ID записів, розділених комами, для яких слід оновити метадані. Ви можете оновити кілька записів одним викликом, розділивши ID комами.

Необов’язкові параметри

Параметр Тип Опис
meta_<key> String Одна або кілька пар ключ-значення метаданих. Непорожнє значення встановлює або оновлює запис метаданих. Порожнє значення повністю видаляє запис метаданих. Назва ключа має той самий формат, що й у виклику create.

Як працює оновлення метаданих

Передайте один або кілька параметрів meta_<key> із непорожнім значенням, щоб встановити або оновити відповідний запис метаданих.

Передайте параметр meta_<key> із порожнім значенням, щоб видалити цей запис метаданих.

Усі наявні записи метаданих, які не включені у виклик, залишаються без змін.

Приклад запиту

Встановлення метаданих

GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
    ?recordID=replace-with-recording-id
  &meta_Presenter=Max+Mustermann
  &meta_category=FINANCE
    &checksum=replace-with-checksum

Видалення метаданих

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

Запит POST за допомогою cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "recordID=replace-with-recording-id&meta_Presenter=Max+Mustermann&meta_category=FINANCE&checksum=replace-with-checksum"

Приклад відповіді

Успіх

<response>
  <returncode>SUCCESS</returncode>
  <updated>true</updated>
</response>

Помилка — відсутній recordID

<response>
  <returncode>FAILED</returncode>
  <messageKey>missingParamRecordID</messageKey>
  <message>You must specify a recordID.</message>
</response>

Помилка — запис не знайдено

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find a recording with that recordID.</message>
</response>

Відповіді з помилками

Ключ повідомлення Опис
checksumError checksum недійсний або не збігається з очікуваним значенням.
missingParamRecordID Обов’язковий параметр recordID не було надано.
notFound Запис із вказаним ID не знайдено. Сервер шукає лише серед записів зі станами published і unpublished — видалені записи не можна оновити.

bbbserver.de Примітки

bbbserver.de: Кінцева точка updateRecordings недоступна на bbbserver.de. Метадані потрібно задавати під час виклику create за допомогою параметрів meta_, і після створення зустрічі їх неможливо змінити.

Поради

Поєднуйте updateRecordings з ендпоінтом getRecordings, щоб створити архів записів із можливістю пошуку. Додавайте метадані, як-от ім’я доповідача, відділ або семестр, а потім використовуйте фільтр meta_ у getRecordings, щоб отримувати записи за цими полями.

  • Ви можете оновити кілька записів одночасно, передавши список ID, розділених комами, у параметрі recordID.
  • Наявні записи метаданих, які не згадані у виклику, залишаються без змін — вам не потрібно щоразу повторно надсилати всі метадані.
  • Щоб видалити певний запис метаданих, передайте ключ із порожнім значенням. Це єдиний спосіб видалити окремі поля метаданих.
  • Формат ключа метаданих ідентичний тому, що використовується у виклику create: meta_yourKeyName=yourValue.

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

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

Вони залишаються без змін. Кінцева точка updateRecordings змінює лише ті записи метаданих, які ви явно включили в запит. Усі інші наявні метадані зберігаються.

Передайте ключ метаданих із порожнім значенням. Наприклад, meta_category= (без значення після знака рівності) видалить запис метаданих category із запису.

Ні. Сервер шукає записи лише у станах published і unpublished. Видалені записи не можна знайти чи оновити. Якщо запис було видалено, ви отримаєте помилку notFound.

Ні. Кінцева точка updateRecordings не реалізована на bbbserver.de. На цій платформі метадані потрібно задавати під час початкового виклику create, і згодом їх не можна змінювати.
Посібник з API BigBlueButton