Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Conference

Retrieve a conference room

Retrieve a conference room.

get/conference_rooms/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the conference room.

Response

OK

idstring

The unique ID of the resource.

extension_numberstring

The extension number.

mode'AUDIO' | 'VIDEO'

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

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

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".

created_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_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.

domainstring

The SIP domain of tenant.
It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.

sbc_hoststring

The SBC domain.

sbc_portinteger

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

tokenstring

Access token to be passed as a header

custom_optionsstring

Some custom configuration options serialized as json string

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "language": "en-US",
  "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"
  ],
  "sbc_port": 80,
  "token": "4DFCF1D4C30B4D798ECE3AE43769F008.",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}