API-version: 4.x seneste 3.x

Du ser API-dokumentationen til BigBlueButton 3.x. Den aktuelle version er BigBlueButton 4.x. Planlægger du en opgradering? Migreringsvejledningen viser alle de ændringer, dine API-kald kræver.

Kapitel 6 GET

sendChatMessage – Send chatbesked

Endepunktet sendChatMessage giver dig mulighed for at sende en chatbesked til den offentlige chat i et kørende møde via API'et. Beskeden vises som en systembesked eller en besked med brugerdefineret navn, der er synlig for alle deltagere. Dette endepunkt blev introduceret i BigBlueButton 3.0.

Dette endepunkt er kun tilgængeligt i BigBlueButton 3.0 og senere. Det er kun minimalt dokumenteret i den officielle API-dokumentation. Detaljer om fejlkoder, hastighedsbegrænsning og tegnkodning er ikke officielt specificeret. undocumented

Endepunkt

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

Obligatoriske parametre

Parameter Type Påkrævet Standard Beskrivelse
meetingID String Ja — Mødeidentifikatoren for mål-mødet.
message String Ja — Beskedens indhold (1 til 500 tegn). Markdown-formatering gengives; HTML-tags escapes og vises som almindelig tekst.

Valgfrie parametre

Parameter Type Påkrævet Standard Beskrivelse
userName String Nej System Afsenderens visningsnavn (maksimalt 255 tegn).

Eksempel på anmodning

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

Eksempelsvar

Et vellykket kald returnerer følgende XML:

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

Fejlsvar

messageKey Beskrivelse
checksumError checksum er ugyldig.
missingParamMeetingID Parameteren meetingID er tom.
meetingNotFound Mødet findes ikke eller er ikke længere i gang, eller parameteren meetingID blev ikke angivet.
nullError Parameteren message blev ikke angivet.
sizeError En parameter ligger uden for den tilladte længde: message 1–500 tegn, meetingID 2–256 tegn, userName højst 255 tegn.
validationError meetingID indeholder ugyldige tegn (f.eks. et komma).

Anvendelsesområder

  • Send automatiske velkomstbeskeder, når et møde starter.
  • Lever systemnotifikationer fra eksterne applikationer (f.eks. "Optagelsen begynder om 5 minutter").
  • Byg bot-integrationer, der reagerer på hændelser og sender beskeder.
  • Opret moderationsværktøjer, der sender meddelelser til alle deltagere.

Begrænsninger

Vær opmærksom på følgende begrænsninger, når du bruger dette endpoint:

  • Kun offentlige chatbeskeder understøttes. Det er ikke muligt at sende private beskeder til individuelle brugere.
  • HTML-tags escapes og vises som tekst; Markdown-formatering (f.eks. fed tekst eller links) gengives.
  • Beskeder er begrænset til 500 tegn.
  • Mødet skal være i gang. Beskeder kan ikke sendes til afsluttede møder.
  • Beskeden sendes kun til det møde, der er angivet i meetingID; den videresendes ikke til mødets grupperum.
  • Hvis disabledFeatures indeholder chat, kasseres beskeden, selvom kaldet returnerer SUCCESS.

Hvis du har brug for at sende længere beskeder, bør du overveje at opdele indholdet i flere API-kald. Vær opmærksom på, at hurtige opkald lige efter hinanden kan være underlagt rate limiting, selv om de præcise grænser ikke er officielt dokumenteret.

Ofte stillede spørgsmål

Dette endepunkt blev introduceret i BigBlueButton 3.0. Det er ikke tilgængeligt i tidligere versioner såsom 2.6 eller 2.7.

Nej. Endepunktet sendChatMessage understøtter kun den offentlige chat. Der findes i øjeblikket ikke noget API-endepunkt til at sende private beskeder til individuelle deltagere.

API'et returnerer et sizeError-svar. Beskeden sendes ikke. Du skal forkorte teksten til højst 500 tegn, før du prøver igen.

Markdown ja, HTML nej. Beskeden konverteres fra Markdown til sikkerhedsrenset HTML: formatering såsom fed tekst eller links gengives, mens HTML-tags escapes og vises bogstaveligt. Den officielle dokumentation angiver noget andet, men kildekoden gengiver Markdown.

Hvis du ikke angiver et userName, vises beskeden med afsendernavnet "System". Dette egner sig til automatiske notifikationer og systemadvarsler.

Ikke via hovedmødet. Grupperum er separate møder, og sendChatMessage sender kun beskeder til den offentlige chat i det møde, hvis meetingID du angiver. En besked sendt til hovedmødet videresendes ikke til dets grupperum.