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.

Obtiene tus API Tokens directamente desde nuestra terminal de desarrollador:


List rooms

get

Retrieve a paginated list of rooms for the authenticated account

Autorizaciones
AuthorizationstringRequerido

Bearer token authentication using API token

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
get
/vpaas/rooms

Create a new room

post

Create a new video room with optional configuration

Autorizaciones
AuthorizationstringRequerido

Bearer token authentication using API token

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
post
/vpaas/rooms

Get room by ID

get

Retrieve a specific room by its ID or externalId

Autorizaciones
AuthorizationstringRequerido

Bearer token authentication using API token

Parámetros de ruta
roomIdstringRequerido

Room ID (ObjectId) or external ID

Example: 64f1a2b3c4d5e6f7a8b9c0d1
Respuestas
get
/vpaas/rooms/{roomId}

Delete room (Not allowed)

delete

Room deletion is not permitted through the API

Autorizaciones
AuthorizationstringRequerido

Bearer token authentication using API token

Parámetros de ruta
roomIdstringRequerido
Respuestas
delete
/vpaas/rooms/{roomId}
403

Forbidden - Room deletion not allowed

Update room

patch

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

Autorizaciones
AuthorizationstringRequerido

Bearer token authentication using API token

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
patch
/vpaas/rooms/{roomId}

Join a room

post

Generate access token to join an existing room

Autorizaciones
AuthorizationstringRequerido

Bearer token authentication using API token

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
post
/vpaas/rooms/{roomId}/join

Última actualización

¿Te fue útil?