Sign in

v6

latestSwagger 2.02026-07-1371219.3 KB
Rooms

Creates a new room.

post/rooms

Query parameters

api-versionstring required

Version of API to invoke.

Headers

Repeatability-Request-IDstring uuid

If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.

Repeatability-First-Sentstring date-time-rfc1123

If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date.

Request body

validFromstring date-time

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

validUntilstring date-time

The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ. The default value is the current date time plus 180 days.

pstnDialOutEnabledboolean

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.

participantsobject

(Optional) Participants to be invited to the room.

Example request

{
  "validFrom": "2021-09-07T07:55:41Z",
  "validUntil": "2021-09-08T15:55:41Z",
  "pstnDialOutEnabled": true,
  "participants": {
    "rawId1": {
      "role": "Presenter"
    },
    "rawId2": {
      "role": "Attendee"
    },
    "rawId3": {
      "role": "Collaborator"
    },
    "rawId4": null
  }
}

Response

Request successful. The action returns a new 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
}