Bölüm 6 GET POST

sendChatMessage – Sohbet Mesajı Gönder

sendChatMessage uç noktası, API aracılığıyla çalışan bir toplantının herkese açık sohbetine bir sohbet mesajı göndermenizi sağlar. Mesaj, tüm katılımcılar tarafından görülebilen bir sistem mesajı veya özel adlı mesaj olarak görünür. Bu uç nokta BigBlueButton 3.0 sürümünde tanıtılmıştır.

Bu uç nokta yalnızca BigBlueButton 3.0 ve sonrasında kullanılabilir. Resmî API belgelerinde çok sınırlı şekilde belgelenmiştir. Hata kodları, hız sınırlaması ve karakter kodlamasıyla ilgili ayrıntılar resmî olarak belirtilmemiştir. undocumented

Uç Nokta

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

Gerekli Parametreler

Parametre Tür Gerekli Varsayılan Açıklama
meetingID String Evet — Hedef toplantının toplantı tanımlayıcısı.
message String Evet — Mesaj içeriği (1 ila 500 karakter). Özel karakterler otomatik olarak escape edilir. HTML ve Markdown desteklenmez.

İsteğe Bağlı Parametreler

Parametre Tür Gerekli Varsayılan Açıklama
userName String Hayır System Gönderenin görünen adı (en fazla 255 karakter). undocumented

Örnek İstek

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

Örnek Yanıt

Başarılı bir çağrı aşağıdaki XML değerini döndürür: 

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

Hata Yanıtları

messageKey Açıklama
checksumError checksum geçersiz.
missingParamMeetingID meetingID parametresi sağlanmadı.
meetingNotFound Toplantı mevcut değil veya artık çalışmıyor.
validationError message eksik, boş veya 500 karakteri aşıyor; ya da userName 255 karakteri aşıyor.
bbbserver.de üzerinde bu uç nokta, BigBlueButton 3.0 veya daha yeni sürümü çalıştıran tüm planlarda kullanılabilir. Sunucu yönetim panosunda bulunan API kimlik bilgilerinizle bunu çağırabilirsiniz.

Kullanım Senaryoları

  • Bir toplantı başladığında otomatik karşılama mesajları gönderin.
  • Harici uygulamalardan sistem bildirimleri iletin (ör. "Kayıt 5 dakika içinde başlayacak").
  • Olaylara tepki veren ve mesaj yayınlayan bot entegrasyonları oluşturun.
  • Tüm katılımcılara duyuru gönderen moderasyon araçları oluşturun.

Sınırlamalar

Bu uç noktayı kullanırken aşağıdaki kısıtlamaların farkında olun:

  • Yalnızca genel sohbet mesajları desteklenir. Bireysel kullanıcılara özel mesaj göndermek mümkün değildir.
  • Markdown veya HTML biçimlendirmesi yoktur. Metin yalnızca düz metin olarak işlenir.
  • Mesajlar 500 karakterle sınırlıdır.
  • Toplantının çalışıyor olması gerekir. Sona ermiş toplantılara mesaj gönderilemez.
  • Breakout room'lara mesaj gönderme desteklenmez.

Daha uzun mesajlar göndermeniz gerekiyorsa, içeriği birden fazla API çağrısına bölmeyi düşünün. Hızlı art arda yapılan çağrıların oran sınırlamasına tabi olabileceğini unutmayın, ancak kesin sınırlar resmi olarak belgelenmemiştir.

Sıkça Sorulan Sorular

Bu uç nokta BigBlueButton 3.0 sürümünde tanıtılmıştır. 2.6 veya 2.7 gibi daha eski sürümlerde mevcut değildir.

Hayır. sendChatMessage uç noktası yalnızca genel sohbeti destekler. Şu anda tek tek katılımcılara özel mesaj göndermek için bir API uç noktası yoktur.

API bir validationError yanıtı döndürür. Mesaj gönderilmez. Yeniden denemeden önce metni 500 karaktere veya daha aza kısaltmanız gerekir.

Hayır. Mesaj içeriği düz metin olarak işlenir. Herhangi bir HTML etiketi veya Markdown sözdizimi işlenmek yerine olduğu gibi görüntülenir.

Bir userName belirtmezseniz, mesaj gönderen adı olarak "System" ile görünür. Bu, otomatik bildirimler ve sistem uyarıları için uygundur.

Hayır. sendChatMessage uç noktası yalnızca ana toplantı odasını hedefler. Grup odalarına mesaj göndermek API tarafından desteklenmez.