Wersja API: 4.x najnowsza 3.x

Przeglądasz dokumentację API dla BigBlueButton 3.x. Aktualna wersja to BigBlueButton 4.x. Planujesz aktualizację? Przewodnik migracji zawiera wszystkie zmiany wymagane w wywołaniach API.

Rozdział 6 GET

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). Formatowanie Markdown jest renderowane; znaczniki HTML są zamieniane na sekwencje ucieczki i wyświetlane jako zwykły tekst.

Parametry opcjonalne

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

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 Parametr meetingID jest pusty.
meetingNotFound Spotkanie nie istnieje lub już się zakończyło albo nie podano parametru meetingID.
nullError Nie podano parametru message.
sizeError Długość parametru wykracza poza dozwolony zakres: message 1–500 znaków, meetingID 2–256 znaków, userName maksymalnie 255 znaków.
validationError meetingID zawiera niedozwolone znaki (np. przecinek).

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.
  • Znaczniki HTML są zamieniane na sekwencje ucieczki i wyświetlane jako tekst; formatowanie Markdown (np. pogrubienie lub linki) jest renderowane.
  • Wiadomości są ograniczone do 500 znaków.
  • Spotkanie musi być uruchomione. Nie można wysyłać wiadomości do zakończonych spotkań.
  • Wiadomość jest publikowana tylko na spotkaniu wskazanym w meetingID; nie jest przekazywana do pokojów podgrup tego spotkania.
  • Jeśli disabledFeatures zawiera chat, wiadomość jest odrzucana, mimo że wywołanie zwraca SUCCESS.

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ź sizeError. Wiadomość nie zostaje wysłana. Przed ponowną próbą należy skrócić tekst do maksymalnie 500 znaków.

Markdown tak, HTML nie. Wiadomość jest konwertowana z Markdown do oczyszczonego HTML: formatowanie, takie jak pogrubienie lub linki, jest renderowane, natomiast znaczniki HTML są zamieniane na sekwencje ucieczki i wyświetlane dosłownie. Oficjalna dokumentacja twierdzi inaczej, ale kod źródłowy renderuje Markdown.

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

Nie za pośrednictwem spotkania nadrzędnego. Pokoje podgrup są oddzielnymi spotkaniami, a sendChatMessage publikuje wiadomości wyłącznie na czacie publicznym spotkania, którego meetingID przekażesz. Wiadomość wysłana do spotkania nadrzędnego nie jest przekazywana do jego pokojów podgrup.