Bölüm 13 GET POST

deleteRecordings – Kayıtları Sil

deleteRecordings uç noktası, BigBlueButton sunucunuzdan bir veya daha fazla kaydı kalıcı olarak siler. Tek bir kayıt kimliği veya birden fazla kaydı tek istekte kaldırmak için virgülle ayrılmış bir liste iletebilirsiniz.

Bu API çağrısı herhangi bir onay istemi olmadan hemen etkili olur. İsteği göndermeden önce doğru kayıt kimliklerine sahip olduğunuzdan emin olun. Silinen kayıtlar API üzerinden geri yüklenemez.

Uç Nokta

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

Parametreler

Parametre Tür Gerekli Varsayılan Açıklama
recordID String Evet — Silinecek tek bir kayıt kimliği veya virgülle ayrılmış kayıt kimlikleri listesi.

Örnek İstek

Tek bir kaydı silin: 

https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?recordID=replace-with-recording-id&checksum=replace-with-checksum

Bir çağrıda birden fazla kaydı silin: 

https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?recordID=replace-with-recording-id-1,replace-with-recording-id-2&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>
  <deleted>true</deleted>
</response>

Hata Yanıtları

messageKey Açıklama
checksumError checksum geçersiz.
missingParamRecordID recordID parametresi sağlanmadı.
notFound Sunucuda belirtilen kimliğe sahip bir kayıt bulunamadı.

Kayıtlar fiziksel olarak diskte hemen kaldırılmaz. Sunucu dosyaları deleted/ dizinine taşır. Bir sunucu yöneticisi, kalıcı olarak temizlenmeden önce silinen kayıtları bu dizinden potansiyel olarak kurtarabilir.

Silme Sonrası Davranış

  • Kayıt durumu deleted olarak değişir.
  • Silinen kayıtlar artık standart getRecordings yanıtlarında görünmez.
  • API üzerinden silinen kayıtları almak için, bir state=deleted çağrısında state=any parametresi olarak state veya getRecordings gönderin.
bbbserver.de üzerinde, bu uç noktayı sunucu yönetim panosunda bulunan API kimlik bilgilerinizle çağırabilirsiniz. Kayıt kimliklerinin sunucu örneğinize ait kayıtlarla eşleştiğinden emin olun.

En İyi Uygulamalar

Yanlış kayıtları silmekten kaçınmak için silmeden önce kayıt kimliklerini her zaman bir getRecordings çağrısıyla doğrulayın.

Bu uç noktayı çağırmadan önce uygulamanızda bir onay adımı uygulayın, çünkü API'nin kendisi onay gerektirmez.

Hangi kayıtların ne zaman kaldırıldığını izleyebilmeniz için, kayıt kimlikleri ve zaman damgaları dahil olmak üzere her silme isteğini günlüğe kaydedin.

Birden fazla kaydı silerken, her kayıt için ayrı API çağrıları yapmak yerine bunları tek bir virgülle ayrılmış istekte gruplayın.

Sıkça Sorulan Sorular

Hemen değil. Sunucu kayıt dosyalarını özel bir deleted dizinine taşır. Bir sunucu yöneticisi, dosyalar bir temizleme işlemiyle kalıcı olarak kaldırılana kadar bunları oradan geri alabilir. Ancak silinmiş kayıtları geri yüklemek için bir API uç noktası yoktur.

Evet. recordID parametresinde virgülle ayrılmış bir kayıt kimliği listesi iletin. Belirtilen tüm kayıtlar tek bir çağrıda silinir.

Belirtilen kayıt kimliklerinden hiçbiri eşleştirilemezse API bir notFound hatası döndürebilir. Geçerli ve geçersiz kimlikler karıştırıldığında davranış BigBlueButton sürümüne göre değişebilir. İsteği göndermeden önce tüm kimliklerin doğrulanması önerilir.

Evet, ancak yalnızca state çağrınızda deleted parametresini açıkça any veya getRecordings olarak ayarlarsanız. Varsayılan olarak silinmiş kayıtlar sonuçlarda gizlenir.

Hayır. BigBlueButton API'si silinmiş kayıtları geri yüklemek için bir uç nokta sağlamaz. Kurtarma yalnızca bir sistem yöneticisi tarafından sunucu dosya sistemi düzeyinde mümkündür.