create – Crear reunión

El endpoint create aprovisiona una nueva reunión en el servidor BigBlueButton. Si ya existe una reunión con el mismo meetingID, el servidor devuelve los datos de la reunión existente en lugar de crear un duplicado (comportamiento idempotente).

Endpoint

POST GET

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

Parámetros obligatorios

Parámetros opcionales

General

Diseño y apariencia

Permisos y configuración de bloqueo

Cámara web

Desactivación de funciones

Valores disponibles para disabledFeatures:

Ciclo de vida de la reunión

Presentación

Grabación

Pizarra

Complementos

Salas de grupos

Estos parámetros son relevantes al crear una reunión como sala de grupos:

Formato para groups:

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

Anulación de la configuración del cliente

Ejemplo como XML en el cuerpo POST:

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

Puentes

Metaparámetros

Se pueden pasar metadatos arbitrarios como meta_<key>=<value>. Algunos metaparámetros tienen significados especiales:

Ejemplo de solicitud

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

Respuesta de ejemplo

<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>

Si ya existe una reunión con el mismo ID, la respuesta incluye una advertencia de duplicado:

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

Carga de presentaciones mediante cuerpo POST

Las presentaciones pueden enviarse como un cuerpo XML con la solicitud POST:

<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>

Atributos por elemento <document>:

bbbserver.de Notas

Parámetro adicional

Reserva de capacidad

Al crear una reunión, bbbserver.de reserva capacidad de hardware:

• El número especificado de participantes está garantizado y reservado en un servidor durante la duración especificada.
• La capacidad reservada se deduce de tu cuota contratada de conexiones simultáneas.
• Si no se especifica, se aplican los valores predeterminados: 5 participantes y 60 minutos (configurable en el panel de administración en "Customer Settings → IntegrationAPI").
• Después de que expire la duración, la reunión sigue en ejecución, pero la capacidad ya no está reservada. bbbserver.de puede finalizar la reunión automáticamente si una nueva reunión requiere esa capacidad.
• El parámetro duration no finaliza reuniones. A diferencia de BBB estándar, debes enviar una llamada de API end para finalizar una reunión después de cierto tiempo.