Conference rooms

PreviousDestroy NextDestroy

Was this helpful?

List conference rooms

Retrieve a collection of conference rooms

get

/conference_rooms

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/conference_rooms' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "extension_number": "text",
      "height": 720,
      "width": 1280,
      "bitrate": 1024,
      "framerate": 15,
      "subject": "text",
      "language": "en-US",
      "capacity": 9,
      "admin_pin": "text",
      "room_pin": "text",
      "enable_recording": false,
      "enable_prompt": true,
      "timezone": "text",
      "numbers": "text",
      "external_invitees": "text",
      "custom_options": "text",
      "mode": "AUDIO",
      "control": "FREE",
      "layout": "LAYOUT0",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "created_at": "2017-07-21T17:32:28Z",
      "scheduled_start_at": "2017-07-21T17:32:28Z",
      "scheduled_end_at": "2017-07-21T17:32:28Z",
      "internal_invitees": [
        "NzAwNTUxOTA5NzczMTQ4MTYw"
      ]
    }
  ]
}

Create a conference room

post

/conference_rooms

Authorizations

Body

extension_numberstring · min: 3 · max: 64required

The extension number.

Pattern: [0-9]{3,64}

heightinteger · int32 · min: 144 · max: 1920 · default: 720

The height for video conference room.
Only valid in VIDEO mode.

widthinteger · int32 · min: 144 · max: 1920 · default: 1280

The width for video conference room.
Only valid in VIDEO mode.

bitrateinteger · int32 · min: 128 · max: 10240 · default: 1024

The transmission rate for video conference room.
Only valid in VIDEO mode.

framerateinteger · min: 5 · max: 30 · default: 15

The framerate for video conference room.
Only valid in VIDEO mode.

subjectstring · min: 1 · max: 64required

The subject of conference room.

languagestring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: en-US

capacityinteger · int32 · min: 1 · max: 200 · default: 9required

The maximum number of participants allowed in the room.

admin_pinstring · min: 3 · max: 6

The PIN for admin of the conference room. Only numeric sequences are allowed.

room_pinstring · min: 3 · max: 6

The PIN for the conference room. Only numeric sequences are allowed.

enable_recordingboolean · default: false

Whether to enable recording when created.

enable_promptboolean · default: true

Whether to enable voice menu.

timezonestring

The IANA Time Zone names, such as "Asia/Shanghai".

numbersstring · max: 128

Dial from landline/mobile phone to this number.

external_inviteesstring

The invitees to send invitation emails to.

custom_optionsstring

Some custom configuration options serialized as json string

modestring · enumrequired

The conference room mode.
Can be either:

AUDIO: audio conference room.
VIDEO: video conference room.

Options: AUDIO, VIDEO

controlstring · enum · default: FREE

The conference control type.
Can be either:

FREE: the free mode.
MASTER: the master mode.

Options: FREE, MASTER

layoutstring · enum · default: LAYOUT0

The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:

LAYOUT0:
LAYOUT1:
LAYOUT2:
LAYOUT3:
LAYOUT4:
LAYOUT6:
LAYOUT9:

Options: LAYOUT0, LAYOUT1, LAYOUT2, LAYOUT3, LAYOUT4, LAYOUT6, LAYOUT9

scheduled_start_atall of

The scheduled start time of meeting.

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

scheduled_end_atall of

The scheduled end time of meeting.

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

internal_inviteesall of[]

A collection of extension's ID for sending invitation emails.

outbound_caller_idsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/conference_rooms' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "extension_number": "text",
    "height": 720,
    "width": 1280,
    "bitrate": 1024,
    "framerate": 15,
    "subject": "text",
    "language": "en-US",
    "capacity": 9,
    "admin_pin": "text",
    "room_pin": "text",
    "enable_recording": false,
    "enable_prompt": true,
    "timezone": "text",
    "numbers": "text",
    "external_invitees": "text",
    "custom_options": "text",
    "mode": "AUDIO",
    "control": "FREE",
    "layout": "LAYOUT0",
    "scheduled_start_at": "2017-07-21T17:32:28Z",
    "scheduled_end_at": "2017-07-21T17:32:28Z",
    "internal_invitees": [
      "NzAwNTUxOTA5NzczMTQ4MTYw"
    ],
    "outbound_caller_ids": [
      {
        "description": "text",
        "caller_id": "text",
        "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
      }
    ]
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve a conference room

Retrieve a conference room.

get

/conference_rooms/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of conference room.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/conference_rooms/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "extension_number": "text",
  "height": 720,
  "width": 1280,
  "bitrate": 1024,
  "framerate": 15,
  "subject": "text",
  "language": "en-US",
  "capacity": 9,
  "admin_pin": "text",
  "room_pin": "text",
  "enable_recording": false,
  "enable_prompt": true,
  "timezone": "text",
  "numbers": "text",
  "external_invitees": "text",
  "domain": "text",
  "sbc_host": "text",
  "token": "4DFCF1D4C30B4D798ECE3AE43769F008.",
  "custom_options": "text",
  "mode": "AUDIO",
  "control": "FREE",
  "layout": "LAYOUT0",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "created_at": "2017-07-21T17:32:28Z",
  "scheduled_start_at": "2017-07-21T17:32:28Z",
  "scheduled_end_at": "2017-07-21T17:32:28Z",
  "sbc_port": 8883,
  "internal_invitees": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ],
  "outbound_caller_ids": [
    {
      "description": "text",
      "caller_id": "text",
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Update a conference room

post

/conference_rooms/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of conference room.

The unique ID of the resource.

Body

heightinteger · int32 · min: 144 · max: 1920 · default: 720

The height for video conference room.
Only valid in VIDEO mode.

widthinteger · int32 · min: 144 · max: 1920 · default: 1280

The width for video conference room.
Only valid in VIDEO mode.

bitrateinteger · int32 · min: 128 · max: 10240 · default: 1024

The transmission rate for video conference room.
Only valid in VIDEO mode.

framerateinteger · min: 5 · max: 30 · default: 15

The framerate for video conference room.
Only valid in VIDEO mode.

subjectstring · min: 1 · max: 64

The subject of conference room.

languagestring

Example: en-US

capacityinteger · int32 · min: 1 · max: 200 · default: 9

The maximum number of participants allowed in the room.

admin_pinstring · min: 3 · max: 6

The PIN for admin of the conference room. Only numeric sequences are allowed.

room_pinstring · min: 3 · max: 6

The PIN for the conference room. Only numeric sequences are allowed.

enable_promptboolean · default: true

Whether to enable voice menu.

timezonestring

The IANA Time Zone names, such as "Asia/Shanghai".

numbersstring · max: 128

Dial from landline/mobile phone to this number.

external_inviteesstring

The invitees to send invitation emails to.

custom_optionsstring

Some custom configuration options serialized as json string

controlstring · enum · default: FREE

The conference control type.
Can be either:

FREE: the free mode.
MASTER: the master mode.

Options: FREE, MASTER

layoutstring · enum · default: LAYOUT0

The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:

LAYOUT0:
LAYOUT1:
LAYOUT2:
LAYOUT3:
LAYOUT4:
LAYOUT6:
LAYOUT9:

Options: LAYOUT0, LAYOUT1, LAYOUT2, LAYOUT3, LAYOUT4, LAYOUT6, LAYOUT9

scheduled_start_atall of

The scheduled start time of meeting.

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

scheduled_end_atall of

The scheduled end time of meeting.

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

internal_inviteesall of[]

A collection of extension's ID for sending invitation emails.

outbound_caller_idsobject[]

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/conference_rooms/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "height": 720,
    "width": 1280,
    "bitrate": 1024,
    "framerate": 15,
    "subject": "text",
    "language": "en-US",
    "capacity": 9,
    "admin_pin": "text",
    "room_pin": "text",
    "enable_prompt": true,
    "timezone": "text",
    "numbers": "text",
    "external_invitees": "text",
    "custom_options": "text",
    "control": "FREE",
    "layout": "LAYOUT0",
    "scheduled_start_at": "2017-07-21T17:32:28Z",
    "scheduled_end_at": "2017-07-21T17:32:28Z",
    "internal_invitees": [
      "NzAwNTUxOTA5NzczMTQ4MTYw"
    ],
    "outbound_caller_ids": [
      {
        "description": "text",
        "caller_id": "text",
        "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
      }
    ]
  }'

200

4XX

No body