Capitolo 6 GET POST

sendChatMessage – Invia messaggio in chat

L'endpoint sendChatMessage ti consente di inviare un messaggio alla chat pubblica di una riunione in corso tramite API. Il messaggio appare come messaggio di sistema o con un nome personalizzato visibile a tutti i partecipanti. Questo endpoint è stato introdotto in BigBlueButton 3.0.

Questo endpoint è disponibile solo in BigBlueButton 3.0 e versioni successive. È documentato in modo minimo nella documentazione API ufficiale. I dettagli su codici di errore, limitazione del traffico e codifica dei caratteri non sono specificati ufficialmente. undocumented

Endpoint

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

Parametri obbligatori

Parametro Tipo Obbligatorio Predefinito Descrizione
meetingID String Sì — L'identificatore della riunione di destinazione.
message String Sì — Il contenuto del messaggio (da 1 a 500 caratteri). I caratteri speciali vengono sottoposti automaticamente a escape. HTML e Markdown non sono supportati.

Parametri opzionali

Parametro Tipo Obbligatorio Predefinito Descrizione
userName String No System Il nome visualizzato del mittente (massimo 255 caratteri). undocumented

Esempio di richiesta

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

Risposta di esempio

Una chiamata riuscita restituisce il seguente XML: 

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

Risposte di errore

messageKey Descrizione
checksumError Il checksum non è valido.
missingParamMeetingID Il parametro meetingID non è stato fornito.
meetingNotFound La riunione non esiste o non è più in corso.
validationError message è mancante, vuoto o supera i 500 caratteri; oppure userName supera i 255 caratteri.
Su bbbserver.de, questo endpoint è disponibile su tutti i piani che eseguono BigBlueButton 3.0 o versioni successive. Puoi chiamarlo usando le tue credenziali API presenti nella dashboard di gestione del server.

Casi d’uso

  • Invia messaggi di benvenuto automatici quando una riunione inizia.
  • Invia notifiche di sistema da applicazioni esterne (ad es. "La registrazione inizierà tra 5 minuti").
  • Crea integrazioni con bot che reagiscono agli eventi e pubblicano messaggi.
  • Crea strumenti di moderazione che inviano annunci a tutti i partecipanti.

Limitazioni

Tieni presenti le seguenti limitazioni quando usi questo endpoint:

  • Sono supportati solo i messaggi della chat pubblica. Non è possibile inviare messaggi privati a singoli utenti.
  • Nessuna formattazione Markdown o HTML. Il testo viene reso solo come testo semplice.
  • I messaggi sono limitati a 500 caratteri.
  • La riunione deve essere in corso. Non è possibile inviare messaggi a riunioni terminate.
  • L'invio di messaggi alle stanze di sottogruppo non è supportato.

Se devi inviare messaggi più lunghi, considera di suddividere il contenuto in più chiamate API. Tieni presente che chiamate rapide e successive possono essere soggette a limitazione della frequenza, anche se i limiti esatti non sono ufficialmente documentati.

Domande frequenti

Questo endpoint è stato introdotto in BigBlueButton 3.0. Non è disponibile nelle versioni precedenti come 2.6 o 2.7.

No. L'endpoint sendChatMessage supporta solo la chat pubblica. Attualmente non esiste alcun endpoint API per inviare messaggi privati ai singoli partecipanti.

L'API restituisce una risposta validationError. Il messaggio non viene inviato. Devi accorciare il testo a 500 caratteri o meno prima di riprovare.

No. Il contenuto del messaggio viene trattato come testo semplice. Eventuali tag HTML o sintassi Markdown verranno mostrati letteralmente invece di essere resi.

Se non specifichi un userName, il messaggio appare con il nome mittente "System". Questo è adatto per notifiche automatiche e avvisi di sistema.

No. L'endpoint sendChatMessage si rivolge solo alla stanza principale della riunione. L'invio di messaggi alle stanze per sottogruppi non è supportato dall'API.