Глава 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, чтобы получать записи по этим полям.

  • Вы можете обновить несколько записей сразу, передав в параметр recordID список ID, разделённых запятыми.
  • Существующие записи метаданных, которые не упомянуты в вызове, остаются без изменений — вам не нужно каждый раз повторно отправлять все метаданные.
  • Чтобы удалить конкретную запись метаданных, передайте ключ с пустым значением. Это единственный способ удалить отдельные поля метаданных.
  • Формат ключа метаданных идентичен используемому в вызове create: meta_yourKeyName=yourValue.

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

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

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

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

Нет. Сервер ищет записи только в состояниях published и unpublished. Удалённые записи нельзя найти или обновить. Если запись была удалена, вы получите ошибку notFound.

Нет. Эндпоинт updateRecordings не реализован на bbbserver.de. На этой платформе метаданные должны задаваться во время первоначального вызова create и не могут быть изменены позже.
Руководство по API BigBlueButton