Глава 5 GET POST

end – Завершить встречу

Эндпоинт end немедленно завершает выполняющуюся встречу BigBlueButton. Все участники удаляются из конференции, а если запись была включена, автоматически запускается конвейер обработки записи.

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

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

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

Обязательные параметры

Параметр Тип Описание
meetingID String Обязательно. ID встречи, которую нужно завершить. Должен совпадать с ID, использованным при создании встречи.

Необязательные параметры

Параметр Тип Описание
password String Deprecated Пароль модератора. Этот параметр больше не требуется начиная с BigBlueButton 3.0 — одного checksum достаточно для аутентификации.

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

Запрос POST с cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/end" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "meetingID=replace-with-meeting-id&checksum=replace-with-checksum"

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

Успех

<response>
  <returncode>SUCCESS</returncode>
  <messageKey>sentEndMeetingRequest</messageKey>
  <message>A request to end the meeting was sent. Please wait a few seconds,
    and then use the getMeetingInfo or isMeetingRunning API calls to verify
    that it was ended.</message>
</response>

Ошибка — встреча не найдена

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

Примечания по bbbserver.de

bbbserver.de: Параметр duration в вызове create не завершает встречи автоматически на bbbserver.de. Если вам нужно завершить встречу через определённое время, вы должны вручную отправить вызов API end в нужный момент (например, через таймер или cron job в вашем приложении).

Важное поведение

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

Отправьте API-вызов end на сервер.

Подождите несколько секунд, пока встреча завершится.

Убедитесь, что встреча завершена, вызвав getMeetingInfo или isMeetingRunning.

Советы

Если вы зададите параметр meta_endCallbackUrl во время create, BigBlueButton отправит callback на указанный вами URL при завершении встречи. Используйте это для автоматического запуска постобработки после встречи.

  • Если запись была включена, обработка записи начнётся автоматически после завершения встречи.
  • Встречу, которая была завершена, нельзя возобновить — необходимо создать новую встречу.
  • Начиная с BigBlueButton 3.0, параметр password больше не требуется. checksum обеспечивает достаточную аутентификацию.

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

Все участники немедленно удаляются из конференции. Они увидят уведомление о том, что встреча была завершена модератором или администратором.

Нет. После завершения встречу нельзя возобновить. Вы должны создать новую встречу с помощью вызова API create. При желании можно повторно использовать тот же meetingID.

Нет. Начиная с BigBlueButton 3.0, параметр password устарел и больше не требуется. Для аутентификации достаточно checksum. В старых версиях пароль модератора всё ещё может требоваться.

Вызов end является асинхронным. Хотя ответ обычно возвращается в течение миллисекунд, фактический процесс завершения может занять несколько секунд. Точное время официально не указано. Для проверки используйте getMeetingInfo или isMeetingRunning.

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