Sign in

v6

latestSwagger 2.02026-07-1371219.3 KB
Rooms

Retrieves an existing room by id.

get/rooms/{roomId}

Path parameters

roomIdstring required

The id of the room requested.

Query parameters

api-versionstring required

Version of API to invoke.

Response

Request successful. The action returns a room.

idstring required

Unique identifier of a room. This id is server generated.

createdAtstring date-time required

The timestamp when the room was created at the server. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

validFromstring date-time required

The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

validUntilstring date-time required

The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

pstnDialOutEnabledboolean required

Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false.

Example response

{
  "id": "99199690362660524",
  "createdAt": "2021-09-06T05:55:41Z",
  "validFrom": "2021-09-07T07:55:41Z",
  "validUntil": "2021-09-08T15:55:41Z",
  "pstnDialOutEnabled": true
}