Meta Parametreler ve Geri Çağrılar
Meta parametreler, bir toplantı oluştururken ilettiğiniz serbestçe tanımlanabilen anahtar-değer çiftleridir. Özel meta veriler eklemenize, belirli olaylarda otomatik geri çağrıları tetiklemenize, kayıt anonimleştirmesini kontrol etmenize ve LMS entegrasyonları için bir toplantının kaynağını belgelemenize olanak tanırlar.
Meta Parametreleri Nasıl Çalışır
Meta parametreleri, create API çağrısında meta_ adlandırma kuralı kullanılarak iletilir. Tek bir toplantıya istediğiniz sayıda meta parametresi ekleyebilirsiniz.
create?meetingID=replace-with-meeting-id&meta_coursename=Computer+Science+101&meta_instructor=Prof.+Mueller&checksum=replace-with-checksum- Meta parametreleri
getMeetingInfovegetRecordingsyanıtlarında döndürülür. - Kayıtlar,
getRecordings?meta_kullanılarak meta değerlerine göre filtrelenebilir.= - Kayıt meta verileri sonradan
updateRecordingsaracılığıyla güncellenebilir.
Callback Meta Parametreleri
Belirli meta parametreler özel bir anlama sahiptir ve belirli olaylar gerçekleştiğinde HTTP geri çağrılarını tetikler. Bunlar, uygulamanızın toplantı yaşam döngüsü olaylarına otomatik olarak tepki vermesini sağlar.
meta_endCallbackUrl
Toplantı sona erdiğinde belirtilen URL'ye bir HTTP GET isteği tetikler.
meta_endCallbackUrl=https://api-guide.bbbserver.com/callbacks/meeting-ended| Özellik | Değer |
|---|---|
| HTTP Yöntemi | GET |
| Tetikleyici | Toplantı sona erdiğinde |
| Callback Parametreleri | meetingID — toplantı tanımlayıcısırecordingmarks — true kayıt işaretler içeriyorsa, aksi takdirde false |
Örnek geri çağırma isteği:
GET https://api-guide.bbbserver.com/callbacks/meeting-ended?meetingID=replace-with-meeting-id&recordingmarks=truemeta_bbb-recording-ready-url
Kayıt tamamen işlenip yayımlandığında bir HTTP POST isteği tetikler.
meta_bbb-recording-ready-url=https://api-guide.bbbserver.com/callbacks/recording-ready| Özellik | Değer |
|---|---|
| HTTP Yöntemi | POST |
| Tetikleyici | Kayıt tamamen işlendiğinde ve yayımlandığında |
| Güvenlik | Parametreler JWT ile imzalanır (JSON Web Token) |
| POST Gövdesi | Kayıt bilgilerini içeren imzalı verileri barındırır |
Bu geri çağrıyı endCallbackUrl ile karıştırmayın. Kayıt işleme, toplantı sona erdikten sonra kayda değer miktarda zaman alabilir. recording-ready geri çağrısı yalnızca işleme tamamlandığında tetiklenir.
meta_analytics-callback-url
Toplantı sona erdikten sonra toplu analiz verileriyle bir HTTP POST isteği tetikler.
meta_analytics-callback-url=https://api-guide.bbbserver.com/callbacks/analytics| Özellik | Değer |
|---|---|
| HTTP Yöntemi | POST |
| Tetikleyici | Toplantı sona erdikten sonra (post-events hook) |
| Kimlik Doğrulama | JWT üstbilgisi olarak gönderilen Authorization: Bearer belirteci (HS512, BBB paylaşılan gizli anahtarı ile imzalanmış, 24 saat geçerli) |
| Gövde Biçimi | Şunları içeren JSON nesnesi version, meeting_id, internal_meeting_id, data |
| Veri İçeriği | Katılım süresi, etkinlik istatistikleri, sohbet kullanımı ve diğer toplu toplantı olayları |
Analiz geri çağrı URL'si BigBlueButton kod tabanından alınır ve resmi API belgelerinde tam olarak belgelenmemiştir. Analiz veri nesnesinin kesin şeması standartlaştırılmamıştır ve sürümler arasında değişebilir. undocumented
JWT teslimatındaki farka dikkat edin: analytics-callback-url, JWT'yi bir HTTP Authorization üstbilgisi olarak gönderirken bbb-recording-ready-url, JWT'yi doğrudan POST gövdesine dahil eder.
Kayıt Anonimleştirme Parametreleri
Bu meta parametreler, işlenmiş kayıtlarda sohbet gönderen adlarının anonimleştirilip anonimleştirilmeyeceğini kontrol eder. Gizlilik uyumluluğu ve veri koruma gereksinimleri için kullanışlıdır.
| Parametre | Tür | Varsayılan | Açıklama |
|---|---|---|---|
meta_bbb-anonymize-chat | Boolean | false | İşlenmiş kayıtlarda sohbet mesajı gönderenlerini anonimleştirir. Yalnızca izleyici (moderatör olmayan) mesajlarını etkiler. Moderatör adları görünür kalır. |
meta_bbb-anonymize-chat-moderators | Boolean | false | Ek olarak kayıtlardaki moderatör sohbet mesajı gönderenlerini de anonimleştirir. Genellikle meta_bbb-anonymize-chat=true değerinin de ayarlanmış olmasını gerektirir. |
create?meetingID=replace-with-meeting-id&meta_bbb-anonymize-chat=true&meta_bbb-anonymize-chat-moderators=true&checksum=replace-with-checksumAnonimleştirme parametreleri resmi API belgelerinde yalnızca kısaca anılmaktadır. Davranışları BigBlueButton kaynak kodundan türetilmiştir. undocumented
LMS Entegrasyon Parametreleri
Birçok LMS eklentisi, bir toplantının kaynağını belgelemek için meta parametreleri otomatik olarak ayarlar. Bunlar bilgilendiricidir ve toplantı davranışını etkilemez, ancak denetim ve raporlama için faydalıdır.
| Parametre | Örnek | Açıklama |
|---|---|---|
meta_bbb-origin | greenlight, moodle | Toplantıyı oluşturan kaynak uygulama. |
meta_bbb-origin-version | v3.1.0 | Kaynak uygulamanın sürümü. |
meta_bbb-origin-server-name | api-guide.bbbserver.com | Kaynak uygulamanın ana makine adı. |
meta_bbb-context | Course: Computer Science | Ders adı gibi bağlam bilgileri. |
meta_bbb-context-id | course-42 | Programatik kullanım için bağlam tanımlayıcısı. |
Özel Meta Parametreler için En İyi Uygulamalar
- Değerin amacını açıkça belirten açıklayıcı anahtar adları kullanın (ör.
meta_department,meta_project). - Özel karakterler, boşluklar veya ASCII dışı karakterler içeren değerleri URL-encode edin.
- CRMs, öğrenme platformları veya analiz panoları gibi harici sistemlerle entegrasyon için meta parametreleri kullanın.
- Meta verileri eklemek veya düzeltmek için, sonradan
updateRecordingsuç noktasını kullanarak kayıt meta verilerini güncelleyin.
Kayıtlarınız için güçlü arama ve kategorilendirme iş akışları oluşturmak amacıyla meta parametreleri getRecordings filtreleme ile birleştirin. Örneğin, yalnızca mühendislik toplantılarındaki kayıtları almak için meta_department=engineering ile filtreleyin.