create – Toplantı Oluştur

create uç noktası, BigBlueButton sunucusunda yeni bir toplantı sağlar. Aynı meetingID değerine sahip bir toplantı zaten varsa, sunucu yinelenen bir toplantı oluşturmak yerine mevcut toplantı verilerini döndürür (idempotent davranış).

Uç Nokta

POST GET

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

Gerekli Parametreler

İsteğe Bağlı Parametreler

Genel

Düzen ve Görünüm

İzinler ve Kilit Ayarları

Web kamerası

Özellikleri Devre Dışı Bırakma

disabledFeatures için kullanılabilir değerler:

Toplantı Yaşam Döngüsü

Sunum

Kayıt

Beyaz tahta

Eklentiler

Ayrı Odalar

Bu parametreler, bir toplantı breakout odası olarak oluşturulurken önemlidir:

groups için biçim:

[
  {"id": "1", "name": "Group A", "roster": ["userId1", "userId2"]},
  {"id": "2", "name": "Group B", "roster": ["userId3"]},
  {"id": "3", "roster": []}
]

İstemci Ayarları Geçersiz Kılma

XML gövdesinde POST olarak örnek:

<modules>
  <module name="clientSettingsOverride">
    <![CDATA[
    {
      "public": {
        "app": {
          "appName": "My Conference",
                    "helpLink": "https://api-guide.bbbserver.com/help"
        }
      }
    }
    ]]>
  </module>
</modules>

Köprüler

Meta Parametreleri

meta_<key>=<value> olarak keyfi meta veriler iletilebilir. Bazı meta parametrelerinin özel anlamları vardır:

Örnek İstek

GET https://api-guide.bbbserver.com/bigbluebutton/api/create?name=Demo&meetingID=replace-with-meeting-id&attendeePW=replace-with-password&moderatorPW=replace-with-password&checksum=replace-with-checksum

Örnek Yanıt

<response>
  <returncode>SUCCESS</returncode>
        <meetingID>replace-with-meeting-id</meetingID>
    <internalMeetingID>replace-with-internal-meeting-id</internalMeetingID>
  <parentMeetingID>bbb-none</parentMeetingID>
        <attendeePW>replace-with-password</attendeePW>
        <moderatorPW>replace-with-password</moderatorPW>
  <createTime>1715261728123</createTime>
  <voiceBridge>70066</voiceBridge>
  <dialNumber>613-555-1234</dialNumber>
  <createDate>Thu May 09 13:35:28 UTC 2024</createDate>
  <hasUserJoined>false</hasUserJoined>
  <duration>0</duration>
  <hasBeenForciblyEnded>false</hasBeenForciblyEnded>
</response>

Aynı kimliğe sahip bir toplantı zaten varsa, yanıt bir duplicate uyarısı içerir:

<response>
  <returncode>SUCCESS</returncode>
    <meetingID>replace-with-meeting-id</meetingID>
  <!-- ... same fields ... -->
  <messageKey>duplicateWarning</messageKey>
  <message>This conference was already in existence...</message>
</response>

POST Gövdesi ile Sunum Yükleme

Sunumlar, XML isteğiyle birlikte bir POST gövdesi olarak gönderilebilir:

<modules>
  <module name="presentation">
        <document url="https://api-guide.bbbserver.com/files/slides.pdf" filename="slides.pdf"
              downloadable="true" removable="false" current="true"/>
        <document url="https://api-guide.bbbserver.com/files/extras.pdf" filename="extras.pdf"/>
    <document name="inline.pdf">
      JVBERi0xLjQK... (Base64-encoded content)
    </document>
  </module>
</modules>

Her <document> öğesi için öznitelikler:

bbbserver.de Notlar

Ek Parametre

Kapasite Rezervasyonu

Bir toplantı oluştururken bbbserver.de donanım kapasitesi rezerve eder:

• Belirtilen katılımcı sayısı garanti edilir ve belirtilen süre boyunca bir sunucuda rezerve edilir.
• Rezerve edilen kapasite, eşzamanlı bağlantılar için satın alınmış kotanızdan düşülür.
• Belirtilmezse varsayılanlar uygulanır: 5 katılımcı ve 60 dakika (yönetici panelinde "Customer Settings → IntegrationAPI" altında yapılandırılabilir).
• Süre dolduktan sonra toplantı çalışmaya devam eder, ancak kapasite artık rezerve edilmez. Yeni bir toplantı kapasite gerektirirse bbbserver.de toplantıyı otomatik olarak sonlandırabilir.
• duration parametresi toplantıları sonlandırmaz. Standart BBB'ten farklı olarak, belirli bir süreden sonra toplantıyı sonlandırmak için bir end API çağrısı göndermeniz gerekir.