Rozdział 6 GET POST

sendChatMessage – Wyślij wiadomość na czacie

Punkt końcowy sendChatMessage umożliwia wysłanie wiadomości czatu do publicznego czatu trwającego spotkania przez API. Wiadomość pojawia się jako komunikat systemowy lub komunikat z własną nazwą nadawcy, widoczny dla wszystkich uczestników. Ten punkt końcowy został wprowadzony w BigBlueButton 3.0.

Ten punkt końcowy jest dostępny tylko w BigBlueButton 3.0 i nowszych. Jest minimalnie udokumentowany w oficjalnej dokumentacji API. Szczegóły dotyczące kodów błędów, ograniczania szybkości i kodowania znaków nie są oficjalnie określone. undocumented

Punkt końcowy

GET https://api-guide.bbbserver.com/bigbluebutton/api/sendChatMessage?<parameters>&checksum=replace-with-checksum

Wymagane parametry

Parametr Typ Wymagane Domyślnie Opis
meetingID String Tak — Identyfikator spotkania docelowego.
message String Tak — Treść wiadomości (od 1 do 500 znaków). Znaki specjalne są automatycznie escapowane. HTML i Markdown nie są obsługiwane.

Parametry opcjonalne

Parametr Typ Wymagane Domyślnie Opis
userName String Nie System Wyświetlana nazwa nadawcy (maksymalnie 255 znaków). undocumented

Przykładowe żądanie

https://api-guide.bbbserver.com/bigbluebutton/api/sendChatMessage?meetingID=replace-with-meeting-id&message=Welcome+to+the+conference!&userName=System+Admin&checksum=replace-with-checksum

Przykładowa odpowiedź

Pomyślne wywołanie zwraca następujący XML: 

<response>
  <returncode>SUCCESS</returncode>
  <messageKey></messageKey>
  <message></message>
</response>

Odpowiedzi błędów

messageKey Opis
checksumError checksum jest nieprawidłowy.
missingParamMeetingID Nie podano parametru meetingID.
meetingNotFound Spotkanie nie istnieje lub nie jest już uruchomione.
validationError Brakuje message, jest puste lub przekracza 500 znaków; albo userName przekracza 255 znaków.
W bbbserver.de ten punkt końcowy jest dostępny we wszystkich planach działających na BigBlueButton 3.0 lub nowszym. Możesz go wywołać, używając swoich danych API znalezionych w panelu zarządzania serwerem.

Zastosowania

  • Wysyłaj automatyczne wiadomości powitalne po rozpoczęciu spotkania.
  • Dostarczaj powiadomienia systemowe z aplikacji zewnętrznych (np. „Nagrywanie rozpocznie się za 5 minut”).
  • Twórz integracje botów, które reagują na zdarzenia i publikują wiadomości.
  • Twórz narzędzia moderacyjne, które wysyłają ogłoszenia do wszystkich uczestników.

Ograniczenia

Podczas korzystania z tego punktu końcowego pamiętaj o następujących ograniczeniach:

  • Obsługiwane są tylko wiadomości na czacie publicznym. Wysyłanie prywatnych wiadomości do poszczególnych użytkowników nie jest możliwe.
  • Bez formatowania Markdown ani HTML. Tekst jest renderowany wyłącznie jako zwykły tekst.
  • Wiadomości są ograniczone do 500 znaków.
  • Spotkanie musi być uruchomione. Nie można wysyłać wiadomości do zakończonych spotkań.
  • Wysyłanie wiadomości do pokoi grupowych nie jest obsługiwane.

Jeśli chcesz wysyłać dłuższe wiadomości, rozważ podzielenie treści na wiele wywołań API. Pamiętaj, że szybkie, następujące po sobie wywołania mogą podlegać ograniczaniu szybkości, chociaż dokładne limity nie są oficjalnie udokumentowane.

Najczęściej zadawane pytania

Ten punkt końcowy został wprowadzony w BigBlueButton 3.0. Nie jest dostępny we wcześniejszych wersjach, takich jak 2.6 lub 2.7.

Nie. Punkt końcowy sendChatMessage obsługuje tylko czat publiczny. Obecnie nie ma punktu końcowego API do wysyłania prywatnych wiadomości do poszczególnych uczestników.

API zwraca odpowiedź validationError. Wiadomość nie zostaje wysłana. Przed ponowną próbą musisz skrócić tekst do 500 znaków lub mniej.

Nie. Treść wiadomości jest traktowana jako zwykły tekst. Wszelkie tagi HTML lub składnia Markdown będą wyświetlane dosłownie zamiast renderowane.

Jeśli nie podasz userName, wiadomość pojawi się z nazwą nadawcy „System”. Jest to odpowiednie dla automatycznych powiadomień i alertów systemowych.

Nie. Punkt końcowy sendChatMessage kieruje wiadomości tylko do głównego pokoju spotkania. Wysyłanie wiadomości do pokoi podgrup nie jest obsługiwane przez API.