POportsip
Conference

Create a conference room

Create a conference room

post/conference_rooms

Request

Request body

extension_numberstring required

The extension number.

mode'AUDIO' | 'VIDEO' required

The conference room mode.
Can be either:

  • AUDIO: audio conference room.
  • VIDEO: video conference room.
control'FREE' | 'MASTER'

The conference control type.
Can be either:

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

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

widthinteger

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

bitrateinteger

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

framerateinteger

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

layout'LAYOUT0' | 'LAYOUT1' | 'LAYOUT2' | 'LAYOUT3' | 'LAYOUT4' | 'LAYOUT6' | 'LAYOUT9'

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

  • LAYOUT0:
  • LAYOUT1:
  • LAYOUT2:
  • LAYOUT3:
  • LAYOUT4:
  • LAYOUT6:
  • LAYOUT9:
subjectstring required

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.

capacityinteger required

The maximum number of participants allowed in the room.

admin_pinstring

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

room_pinstring

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

enable_recordingboolean

Whether to enable recording when created.

enable_promptboolean

Whether to enable voice menu.

timezonestring

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

scheduled_start_atstring date_time

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_atstring date_time

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

Dial from landline/mobile phone to this number.

internal_inviteesstring[]
external_inviteesstring

The invitees to send invitation emails to.

custom_optionsstring

Some custom configuration options serialized as json string

Example request

{
  "language": "en-US",
  "scheduled_start_at": "2017-07-21T17:32:28Z",
  "scheduled_end_at": "2017-07-21T17:32:28Z",
  "internal_invitees": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ],
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Response

Created

idstring

The unique ID of the resource.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Changes

No recorded changes to this operation across all 1 revision of this API.