Kapitel 6 GET POST

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 — Beskedindholdet (1 til 500 tegn). Specialtegn escapes automatisk. HTML og Markdown understøttes ikke.

Valgfrie parametre

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

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 blev ikke angivet.
meetingNotFound Mødet findes ikke eller kører ikke længere.
validationError message mangler, er tom eller overstiger 500 tegn; eller userName overstiger 255 tegn.
På bbbserver.de er dette endepunkt tilgængeligt på alle abonnementer, der kører BigBlueButton 3.0 eller senere. Du kan kalde det med dine API-legitimationsoplysninger, som findes i serveradministrationsdashboardet.

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.
  • Ingen Markdown- eller HTML-formatering. Teksten gengives kun som ren tekst.
  • Beskeder er begrænset til 500 tegn.
  • Mødet skal være i gang. Beskeder kan ikke sendes til afsluttede møder.
  • Afsendelse af beskeder til breakout-rum understøttes ikke.

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 validationError-svar. Beskeden sendes ikke. Du skal forkorte teksten til 500 tegn eller færre, før du prøver igen.

Nej. Beskedindholdet behandles som ren tekst. Eventuelle HTML-tags eller Markdown-syntaks vises bogstaveligt i stedet for at blive gengivet.

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

Nej. Endepunktet sendChatMessage retter sig kun mod hovedmøderummet. Det understøttes ikke af API'et at sende beskeder til grupperum.