BigBlueButton 3.x için API dokümantasyonunu görüntülüyorsunuz. Güncel sürüm: BigBlueButton 4.x. Yükseltme mi planlıyorsunuz? Geçiş kılavuzu, API çağrılarınızda yapmanız gereken tüm değişiklikleri listeler.
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). Markdown biçimlendirmesi uygulanır; HTML etiketleri kaçış karakterleriyle dönüştürülerek düz metin olarak gösterilir. |
İ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). |
Ö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 boş. |
meetingNotFound | Toplantı mevcut değil veya artık devam etmiyor ya da meetingID parametresi sağlanmadı. |
nullError | message parametresi sağlanmadı. |
sizeError | Bir parametre izin verilen uzunluk sınırlarının dışında: message 1–500 karakter, meetingID 2–256 karakter, userName en fazla 255 karakter. |
validationError | meetingID geçersiz karakterler içeriyor (örneğin virgül). |
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.
- HTML etiketleri kaçış karakterleriyle dönüştürülerek metin olarak gösterilir; Markdown biçimlendirmesi (örneğin kalın metin veya bağlantılar) uygulanır.
- Mesajlar 500 karakterle sınırlıdır.
- Toplantının çalışıyor olması gerekir. Sona ermiş toplantılara mesaj gönderilemez.
- Mesaj yalnızca
meetingIDile belirtilen toplantıya gönderilir; bu toplantının grup odalarına iletilmez. disabledFeatures,chatiçeriyorsa çağrıSUCCESSdöndürse bile mesaj atılır.
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
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.sizeError yanıtı döndürür. Mesaj gönderilmez. Yeniden denemeden önce metni 500 karakter veya daha kısa olacak şekilde kısaltmalısınız.userName belirtmezseniz, mesaj gönderen adı olarak "System" ile görünür. Bu, otomatik bildirimler ve sistem uyarıları için uygundur.sendChatMessage yalnızca meetingID değerini ilettiğiniz toplantının genel sohbetine mesaj gönderir. Ana toplantıya gönderilen bir mesaj, o toplantının grup odalarına iletilmez.