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 · int32Optional

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

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

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

Default: 100
Responses
200
OK
application/json
get
GET /api/conference_rooms HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
    }
  ]
}

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.
Possible values:
controlstring · enumOptional

The conference control type.
Can be either:

  • FREE: the free mode.
  • MASTER: the master mode.
Default: FREEPossible values:
heightinteger · int32 · min: 144 · max: 1920Optional

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

Default: 720
widthinteger · int32 · min: 144 · max: 1920Optional

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

Default: 1280
bitrateinteger · int32 · min: 128 · max: 10240Optional

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

Default: 1024
framerateinteger · min: 5 · max: 30Optional

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

Default: 15
layoutstring · enumOptional

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

  • LAYOUT0:
  • LAYOUT1:
  • LAYOUT2:
  • LAYOUT3:
  • LAYOUT4:
  • LAYOUT6:
  • LAYOUT9:
Default: LAYOUT0Possible values:
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: 200Required

The maximum number of participants allowed in the room.

Default: 9
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_recordingbooleanOptional

Whether to enable recording when created.

Default: false
enable_promptbooleanOptional

Whether to enable voice menu.

Default: true
timezonestringOptional

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

scheduled_start_atall ofOptional

The scheduled start time of meeting.

string · date_timeOptional

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

Example: 2017-07-21T17:32:28Z
scheduled_end_atall ofOptional

The scheduled end time of meeting.

string · date_timeOptional

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

Example: 2017-07-21T17:32:28Z
numbersstring · max: 128Optional

Dial from landline/mobile phone to this number.

external_inviteesstringOptional

The invitees to send invitation emails to.

custom_optionsstringOptional

Some custom configuration options serialized as json string

Responses
201
Created
application/json
post
POST /api/conference_rooms HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 584

{
  "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"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a conference room

get

Retrieve a conference room.

Authorizations
Path parameters
idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/conference_rooms/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
}

Update a conference room

post

Update a conference room

Authorizations
Path parameters
idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
controlstring · enumOptional

The conference control type.
Can be either:

  • FREE: the free mode.
  • MASTER: the master mode.
Default: FREEPossible values:
heightinteger · int32 · min: 144 · max: 1920Optional

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

Default: 720
widthinteger · int32 · min: 144 · max: 1920Optional

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

Default: 1280
bitrateinteger · int32 · min: 128 · max: 10240Optional

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

Default: 1024
framerateinteger · min: 5 · max: 30Optional

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

Default: 15
layoutstring · enumOptional

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

  • LAYOUT0:
  • LAYOUT1:
  • LAYOUT2:
  • LAYOUT3:
  • LAYOUT4:
  • LAYOUT6:
  • LAYOUT9:
Default: LAYOUT0Possible values:
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: 200Optional

The maximum number of participants allowed in the room.

Default: 9
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_promptbooleanOptional

Whether to enable voice menu.

Default: true
timezonestringOptional

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

scheduled_start_atall ofOptional

The scheduled start time of meeting.

string · date_timeOptional

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

Example: 2017-07-21T17:32:28Z
scheduled_end_atall ofOptional

The scheduled end time of meeting.

string · date_timeOptional

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

Example: 2017-07-21T17:32:28Z
numbersstring · max: 128Optional

Dial from landline/mobile phone to this number.

external_inviteesstringOptional

The invitees to send invitation emails to.

custom_optionsstringOptional

Some custom configuration options serialized as json string

Responses
200
OK
post
POST /api/conference_rooms/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 519

{
  "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"
}
No content
PreviousDestroyNextDestroy

Was this helpful?