Rooms API

Detalles de como crear salas a través de nuestra VPaaS API.

Autorización

Todos los endpoints descritos a continuación utilizan la cabecera Authorization con esquema Bearer.

Un API token lo puedes obtener desde nuestro dashboard. Este deberá ser de tipo api-token el cual es el único permitido para VPaaS.

Si estás en ambiente de desarrollo, te recomendamos crear un token sin lista blanca de IPs; esto evitará problemas de bloqueos por IP dinámica.

Obtén el tuyo aquí, inciar sesión.

List rooms

get

Retrieve a paginated list of rooms for the authenticated account

Autorizaciones

Parámetros de consulta

$limitinteger · mín: 1 · máx: 100Opcional

Maximum number of results to return

Default: 10Example: 10

$skipintegerOpcional

Number of results to skip

Default: 0Example: 0

$sortobjectOpcional

Sort order (field:1 for asc, field:-1 for desc)

Example: {"createdAt":-1}

endedbooleanOpcional

Filter by ended status

Example: false

externalIdstringOpcional

Filter by external ID

Example: standup-2024-08-14

Respuestas

200

Successful response

application/json

401

Unauthorized - Invalid or missing API token

application/json

403

Forbidden - Insufficient permissions

application/json

500

Internal server error

application/json

get

/vpaas/rooms

GET /vpaas/rooms HTTP/1.1
Host: api.videsk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 25,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "id": "64f1a2b3c4d5e6f7a8b9c0d1",
      "name": "Team standup meeting",
      "externalId": "standup-2024-08-14",
      "exp": "2024-08-14T18:00:00.000Z",
      "nbf": "2024-08-14T15:00:00.000Z",
      "authorizations": [
        {
          "ip": "192.168.1.1",
          "jti": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "createdAt": "2024-08-14T15:00:00.000Z"
        }
      ]
    }
  ]
}

Create a new room

post

Create a new video room with optional configuration

Autorizaciones

Parámetros de encabezado

Content-Typestring · enumRequerido

Content type must be application/json

Example: application/jsonValores posibles:

Cuerpo

externalIdstring · máx: 100Opcional

External identifier (auto-generated if not provided)

Example: standup-2024-08-14

namestring · máx: 500Opcional

Internal room name (auto-generated if not provided)

Example: Team standup meeting

expstring · date-timeOpcional

Expiration date (defaults to +3 hours if not provided)

Example: 2024-08-14T18:00:00.000Z

nbfstring · date-timeOpcional

Not before date (defaults to now if not provided)

Example: 2024-08-14T15:00:00.000Z

settingsobjectOpcional

Room configuration settings

Example: {"maxParticipants":10,"recordingEnabled":true}

Respuestas

201

Room created successfully

application/json

Respuestaall of

400

Bad request - Invalid input data

application/json

401

Unauthorized

application/json

409

Conflict - externalId already exists

application/json

500

Internal server error

application/json

post

/vpaas/rooms

POST /vpaas/rooms HTTP/1.1
Host: api.videsk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "name": "Team standup meeting",
  "externalId": "standup-2024-08-14"
}

{
  "id": "64f1a2b3c4d5e6f7a8b9c0d1",
  "name": "Team standup meeting",
  "externalId": "standup-2024-08-14",
  "exp": "2024-08-14T18:00:00.000Z",
  "nbf": "2024-08-14T15:00:00.000Z",
  "authorizations": [
    {
      "ip": "192.168.1.1",
      "jti": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "createdAt": "2024-08-14T15:00:00.000Z"
    }
  ],
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Get room by ID

get

Retrieve a specific room by its ID or externalId

Autorizaciones

Parámetros de ruta

roomIdstringRequerido

Room ID (ObjectId) or external ID

Example: 64f1a2b3c4d5e6f7a8b9c0d1

Respuestas

200

Room found

application/json

401

Unauthorized

application/json

404

Room not found

application/json

500

Internal server error

application/json

get

/vpaas/rooms/{roomId}

GET /vpaas/rooms/{roomId} HTTP/1.1
Host: api.videsk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "64f1a2b3c4d5e6f7a8b9c0d1",
  "name": "Team standup meeting",
  "externalId": "standup-2024-08-14",
  "exp": "2024-08-14T18:00:00.000Z",
  "nbf": "2024-08-14T15:00:00.000Z",
  "authorizations": [
    {
      "ip": "192.168.1.1",
      "jti": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "createdAt": "2024-08-14T15:00:00.000Z"
    }
  ]
}

Delete room (Not allowed)

delete

Room deletion is not permitted through the API

Autorizaciones

Parámetros de ruta

roomIdstringRequerido

Respuestas

403

Forbidden - Room deletion not allowed

application/json

delete

/vpaas/rooms/{roomId}

DELETE /vpaas/rooms/{roomId} HTTP/1.1
Host: api.videsk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Room deletion not allowed

{
  "name": "Forbidden",
  "message": "Not allowed",
  "code": 403,
  "className": "forbidden"
}

Update room

patch

Update room properties like expiration, name, or end status. Can optionally generate new access token.

Autorizaciones

Parámetros de ruta

roomIdstringRequerido

Room ID (ObjectId) or external ID

Example: 64f1a2b3c4d5e6f7a8b9c0d1

Parámetros de encabezado

Content-Typestring · enumRequerido

Content type must be application/json

Example: application/jsonValores posibles:

Cuerpo

generateTokenbooleanOpcional

Whether to generate a new access token

Default: falseExample: false

expstring · date-timeOpcional

New expiration date

Example: 2024-08-14T18:00:00.000Z

nbfstring · date-timeOpcional

New not before date

Example: 2024-08-14T15:00:00.000Z

endedbooleanOpcional

Mark room as ended

Example: false

namestring · máx: 500Opcional

New room name

Example: Updated meeting name

Respuestas

200

Room updated successfully

application/json

Respuestaall of

400

Bad request

application/json

401

Unauthorized

application/json

404

Room not found or already ended

application/json

500

Internal server error

application/json

patch

/vpaas/rooms/{roomId}

PATCH /vpaas/rooms/{roomId} HTTP/1.1
Host: api.videsk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "exp": "2024-08-14T20:00:00.000Z",
  "generateToken": true
}

{
  "id": "64f1a2b3c4d5e6f7a8b9c0d1",
  "name": "Team standup meeting",
  "externalId": "standup-2024-08-14",
  "exp": "2024-08-14T18:00:00.000Z",
  "nbf": "2024-08-14T15:00:00.000Z",
  "authorizations": [
    {
      "ip": "192.168.1.1",
      "jti": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "createdAt": "2024-08-14T15:00:00.000Z"
    }
  ],
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Join a room

post

Generate access token to join an existing room

Autorizaciones

Parámetros de ruta

roomIdstringRequerido

Room ID (ObjectId) or external ID to join

Example: standup-2024-08-14

Parámetros de encabezado

Content-Typestring · enumRequerido

Content type must be application/json

Example: application/jsonValores posibles:

Cuerpo

objectOpcional

Optional request body (currently no additional parameters required)

Respuestas

200

Successfully joined room

application/json

400

Bad request - Missing room ID or invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden - Insufficient permissions

application/json

500

Internal server error

application/json

post

/vpaas/rooms/{roomId}/join

POST /vpaas/rooms/{roomId}/join HTTP/1.1
Host: api.videsk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

AnteriorIntroducción SiguienteBrowser SDK

Última actualización hace 15 horas

¿Te fue útil?