Versione API: 4.x più recente 3.x

Stai visualizzando la documentazione API per BigBlueButton 3.x. La versione attuale è BigBlueButton 4.x. Stai pianificando un aggiornamento? La guida alla migrazione elenca tutte le modifiche necessarie alle tue chiamate API.

Capitolo 6 GET

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). La formattazione Markdown viene resa graficamente; i tag HTML vengono sottoposti a escape e mostrati come testo semplice.

Parametri opzionali

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

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 è vuoto.
meetingNotFound La riunione non esiste o non è più in corso, oppure il parametro meetingID non è stato fornito.
nullError Il parametro message non è stato fornito.
sizeError Un parametro non rispetta i limiti di lunghezza consentiti: message da 1 a 500 caratteri, meetingID da 2 a 256 caratteri, userName massimo 255 caratteri.
validationError Il valore di meetingID contiene caratteri non validi (ad esempio una virgola).

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.
  • I tag HTML vengono sottoposti a escape e mostrati come testo; la formattazione Markdown (ad esempio testo in grassetto o link) viene resa graficamente.
  • I messaggi sono limitati a 500 caratteri.
  • La riunione deve essere in corso. Non è possibile inviare messaggi a riunioni terminate.
  • Il messaggio viene pubblicato solo nella riunione indicata in meetingID; non viene inoltrato alle stanze per gruppi di quella riunione.
  • Se disabledFeatures contiene chat, il messaggio viene scartato anche se la chiamata restituisce SUCCESS.

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 sizeError. Il messaggio non viene inviato. Devi ridurre il testo a un massimo di 500 caratteri prima di riprovare.

Markdown sì, HTML no. Il messaggio viene convertito da Markdown a HTML sanitizzato: la formattazione, come il testo in grassetto o i link, viene resa graficamente, mentre i tag HTML vengono sottoposti a escape e visualizzati letteralmente. La documentazione ufficiale afferma il contrario, ma il codice sorgente rende graficamente Markdown.

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

Non tramite la riunione principale. Le stanze per gruppi sono riunioni separate e sendChatMessage pubblica solo nella chat pubblica della riunione di cui passi il valore meetingID. Un messaggio inviato alla riunione principale non viene inoltrato alle sue stanze per gruppi.