Розділ 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.

Поради

Якщо під час create ви встановите параметр meta_endCallbackUrl, BigBlueButton надішле зворотний виклик на вказану вами URL-адресу, коли зустріч завершиться. Використовуйте це, щоб автоматично запускати післязустрічні робочі процеси.

  • Якщо запис було ввімкнено, обробка запису починається автоматично після завершення зустрічі.
  • Зустріч, яку було завершено, не можна відновити — потрібно створити нову зустріч.
  • Починаючи з BigBlueButton 3.0, параметр password більше не потрібен. checksum забезпечує достатню автентифікацію.

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

Усіх учасників негайно видаляють із конференції. Вони побачать сповіщення про те, що зустріч була завершена модератором або адміністратором.

Ні. Після завершення зустрічі її не можна відновити. Ви повинні створити нову зустріч за допомогою виклику API create. За бажанням можна повторно використати той самий meetingID.

Ні. Починаючи з BigBlueButton 3.0, параметр password є застарілим і більше не потрібен. checksum достатньо для автентифікації. У старіших версіях пароль модератора все ще може бути потрібним.

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

Якщо для зустрічі було ввімкнено запис, конвеєр обробки запису запускається автоматично після завершення зустрічі. Запис стане доступним після завершення обробки, що може тривати кілька хвилин залежно від тривалості зустрічі.
Посібник з API BigBlueButton