BEbetagouv
Rooms

Create a room

Changed on

Creates a new room with secure defaults for external API usage.

Defaults:

  • Delegated user is set as owner
  • Room slug auto-generated for uniqueness
  • Telephony PIN auto-generated when enabled
  • Creation tracked with application client_id for auditing
post/rooms/

Request

  • Base URL
    https://visio-sandbox.beta.numerique.gouv.fr/external-api/v1.0
  • Auth
    HTTP bearer

Request body

access_level'public' | 'trusted' | 'restricted'

Controls who can join the room without going through the lobby.

  • public: Anyone with the room link can join directly, no authentication required.
  • trusted: Authenticated users join directly. Unauthenticated users wait in the lobby for approval.
  • restricted: Only participants explicitly trusted by the owner bypass the lobby. Everyone else waits for approval regardless of authentication.

public is rejected with a 400 unless the deployment explicitly enables it for this API. This applies both when creating a room and when updating one.

Example request

{
  "access_level": "trusted",
  "configuration": {
    "can_publish_sources": [
      "camera",
      "microphone"
    ],
    "everyone_can_mute": true
  }
}

Response

Room created successfully

idstring uuid

Unique room identifier

slugstring

URL-friendly room identifier (auto-generated)

access_level'public' | 'trusted' | 'restricted'

Controls who can join the room without going through the lobby.

  • public: Anyone with the room link can join directly, no authentication required.
  • trusted: Authenticated users join directly. Unauthenticated users wait in the lobby for approval.
  • restricted: Only participants explicitly trusted by the owner bypass the lobby. Everyone else waits for approval regardless of authentication.

public is rejected with a 400 unless the deployment explicitly enables it for this API. This applies both when creating a room and when updating one.

urlstring uri

Full URL to access the room

Example response

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "slug": "aze-eere-zer",
  "access_level": "trusted",
  "url": "https://visio-sandbox.beta.numerique.gouv.fr/aze-eere-zer",
  "telephony": {
    "enabled": true,
    "pin_code": "123456",
    "phone_number": "+1-555-0100",
    "default_country": "US"
  },
  "configuration": {
    "can_publish_sources": [
      "camera",
      "microphone"
    ],
    "everyone_can_mute": true
  }
}

Changes

  • 617971cb202fRevision changes
    • warning

      added the new public enum value to the response property for the response status

    • warning

      added the new restricted enum value to the response property for the response status

    • warning

      added the new trusted enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      the response optional property became not read-only for the status

  • a85a00b46a4eRevision changes
    • breaking

      api removed without deprecation

    • info

      endpoint added