Conference rooms

List conference rooms

get

Retrieve a collection of conference rooms

Authorizations

Query parameters

filterstringoptional

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

searchstringoptional

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

orderbystringoptional

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: 0optional

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: 100optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

Create a conference room

post

Create a conference room

Authorizations

Body

extension_numberstring · min: 3 · max: 64required

The extension number.

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

modestring · enumrequired

The conference room mode.
Can be either:

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

Options: AUDIO, VIDEO

controlstring · enum · default: "FREE"optional

The conference control type.
Can be either:

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

Options: FREE, MASTER

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

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

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

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

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

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

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

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

layoutstring · enum · default: "LAYOUT0"optional

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

subjectstring · min: 1 · max: 64required

The subject of conference room.

languagestringoptional

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: 6optional

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

room_pinstring · min: 3 · max: 6optional

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

enable_recordingboolean · default: falseoptional

Whether to enable recording when created.

enable_promptboolean · default: trueoptional

Whether to enable voice menu.

timezonestringoptional

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

scheduled_start_atall ofoptional

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 ofoptional

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

numbersstring · max: 128optional

Dial from landline/mobile phone to this number.

internal_inviteesall of[]optional

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

external_inviteesstringoptional

The invitees to send invitation emails to.

outbound_caller_idsobject[]optional

A collection of outbound caller IDs.

custom_optionsstringoptional

Some custom configuration options serialized as json string

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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",
    "mode": "AUDIO",
    "control": "FREE",
    "height": 1,
    "width": 1,
    "bitrate": 1,
    "framerate": 1,
    "layout": "LAYOUT0",
    "subject": "text",
    "language": "en-US",
    "capacity": 1,
    "admin_pin": "text",
    "room_pin": "text",
    "enable_recording": true,
    "enable_prompt": true,
    "timezone": "text",
    "scheduled_start_at": "2017-07-21T17:32:28Z",
    "scheduled_end_at": "2017-07-21T17:32:28Z",
    "numbers": "text",
    "internal_invitees": [
      "NzAwNTUxOTA5NzczMTQ4MTYw"
    ],
    "external_invitees": "text",
    "outbound_caller_ids": [
      {
        "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
        "caller_id": "text",
        "description": "text"
      }
    ],
    "custom_options": "text"
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve a conference room

get

Retrieve a conference room.

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

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

200

4XX

200

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

OK

Update a conference room

post

Update a conference room

Authorizations

Path parameters

idall ofrequired

The unique ID of conference room.

The unique ID of the resource.

Body

controlstring · enum · default: "FREE"optional

The conference control type.
Can be either:

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

Options: FREE, MASTER

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

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

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

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

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

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

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

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

layoutstring · enum · default: "LAYOUT0"optional

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

subjectstring · min: 1 · max: 64optional

The subject of conference room.

languagestringoptional

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: 9optional

The maximum number of participants allowed in the room.

admin_pinstring · min: 3 · max: 6optional

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

room_pinstring · min: 3 · max: 6optional

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

enable_promptboolean · default: trueoptional

Whether to enable voice menu.

timezonestringoptional

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

scheduled_start_atall ofoptional

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 ofoptional

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

numbersstring · max: 128optional

Dial from landline/mobile phone to this number.

internal_inviteesall of[]optional

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

external_inviteesstringoptional

The invitees to send invitation emails to.

outbound_caller_idsobject[]optional

A collection of outbound caller IDs.

custom_optionsstringoptional

Some custom configuration options serialized as json string

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

No body

OK