Conference | PortSIP Knowledge Base

List conference servers

get

List conference servers

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/conference_servers

GET /api/conference_servers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "enabled": true,
      "type": "INTERNAL",
      "ipv4": "text",
      "ipv6": "text",
      "max_rooms": 1,
      "max_participants": 1
    }
  ]
}

Create a conference server

post

Create a conference server. Please note that: at least one of ipv4 or ipv6 must be specified.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

The name of conference server.

enabledbooleanOptional

The activate status or deactivated status.

Default: true

ipv4stringOptional

Host IPV4 address.

ipv6stringOptional

Host IPV6 address.

max_roomsinteger · int32Required

The maximum number of rooms for conference server.

max_participantsinteger · int32Required

The maximum number of participants for conference server.

Responses

200

OK

application/json

idall ofOptional

The unique ID of conference server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post

/conference_servers

POST /api/conference_servers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "text",
  "enabled": true,
  "ipv4": "text",
  "ipv6": "text",
  "max_rooms": 1,
  "max_participants": 1
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a conference server

get

Retrieve a conference server.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of conference server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of conference server.

enabledbooleanOptional

The activate status or deactivated status.

Default: true

typestring · enumRead-onlyOptional

Every PortSIP PBX has a built-in conference server marked as INTERNAL;
Newly added conference servers will be marked as "EXTERNAL".

Possible values:

ipv4stringOptional

Host IPV4 address.

ipv6stringOptional

Host IPV6 address.

max_roomsinteger · int32Optional

The maximum number of rooms for conference server.

max_participantsinteger · int32Optional

The maximum number of participants for conference server.

4XX

Error

get

/conference_servers/{id}

GET /api/conference_servers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "enabled": true,
  "type": "INTERNAL",
  "ipv4": "text",
  "ipv6": "text",
  "max_rooms": 1,
  "max_participants": 1
}

Update a conference server

post

Update a conference server

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

enabledbooleanOptional

The activate status or deactivated status.

Default: true

max_roomsinteger · int32Optional

The maximum number of rooms for conference server.

max_participantsinteger · int32Optional

The maximum number of participants for conference server.

Responses

200

OK

No content

4XX

Error

post

/conference_servers/{id}

POST /api/conference_servers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "enabled": true,
  "max_rooms": 1,
  "max_participants": 1
}

No content

Query conference server status

get

Retrieve a conference server's status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

rooms_countintegerOptional

The number of rooms for conference server.

participants_countintegerOptional

The number of participants for conference server.

cpu_usageintegerOptional

CPU usage.

memory_usageintegerOptional

Memory usage.

statusstring · enumOptional

Conference room's status:

ONLINE: room is online.
OFFLINE: room is offline.

Possible values:

4XX

Error

get

/conference_servers/{id}/status

GET /api/conference_servers/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rooms_count": 1,
  "participants_count": 1,
  "cpu_usage": 1,
  "memory_usage": 1,
  "status": "ONLINE"
}

Delete a conference server

post

Delete a conference server

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid server id supplied

404

User not found

post

/conference_servers/{id}/destroy

POST /api/conference_servers/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List conference rooms

get

Retrieve a collection of conference rooms

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/conference_rooms

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": 720,
      "width": 1280,
      "bitrate": 1024,
      "framerate": 15,
      "layout": "LAYOUT0",
      "subject": "text",
      "language": "en-US",
      "capacity": 9,
      "admin_pin": "text",
      "room_pin": "text",
      "enable_recording": false,
      "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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

4XX

Error

post

/conference_rooms

POST /api/conference_rooms HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 594

{
  "extension_number": "text",
  "mode": "AUDIO",
  "control": "FREE",
  "height": 720,
  "width": 1280,
  "bitrate": 1024,
  "framerate": 15,
  "layout": "LAYOUT0",
  "subject": "text",
  "language": "en-US",
  "capacity": 9,
  "admin_pin": "text",
  "room_pin": "text",
  "enable_recording": false,
  "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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Optional

The extension number.

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

modestring · enumOptional

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

created_atall ofOptional

The creation time of conference room.

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

domainstring · min: 1 · max: 280Optional

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_hoststringOptional

The SBC domain.

sbc_portall ofOptional

The SBC web port fot https.

Default: 8883

integer · int32 · max: 65535Optional

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

Example: 80

tokenstringOptional

Access token to be passed as a header

Example: 4DFCF1D4C30B4D798ECE3AE43769F008.

custom_optionsstringOptional

Some custom configuration options serialized as json string

4XX

Error

get

/conference_rooms/{id}

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": 720,
  "width": 1280,
  "bitrate": 1024,
  "framerate": 15,
  "layout": "LAYOUT0",
  "subject": "text",
  "language": "en-US",
  "capacity": 9,
  "admin_pin": "text",
  "room_pin": "text",
  "enable_recording": false,
  "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": 8883,
  "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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

No content

4XX

Error

post

/conference_rooms/{id}

POST /api/conference_rooms/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 528

{
  "control": "FREE",
  "height": 720,
  "width": 1280,
  "bitrate": 1024,
  "framerate": 15,
  "layout": "LAYOUT0",
  "subject": "text",
  "language": "en-US",
  "capacity": 9,
  "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

Delete a conference room

post

Destroy a conference room

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid username supplied

404

Not found

post

/conference_rooms/{id}/destroy

POST /api/conference_rooms/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Query conference room's status

get

Query conference room's status by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

statusstring · enumOptional

The conference room status. Can be either:

ONLINE:
OFFLINE:
ON_CALL:

Possible values:

lockedbooleanOptional

Whether the conference room was locked.

mutedbooleanOptional

Whether the conference room was muted.

recordingbooleanOptional

Whether the conference room is recording.

4XX

Error

get

/conference_rooms/{id}/status

GET /api/conference_rooms/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "ONLINE",
  "locked": true,
  "muted": true,
  "recording": true
}

Mute conference room

post

Mute conference room.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/mute

POST /api/conference_rooms/{id}/mute HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unmute conference room

post

Unmute conference room by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/unmute

POST /api/conference_rooms/{id}/unmute HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Lock conference room

post

Lock conference room by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/lock

POST /api/conference_rooms/{id}/lock HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unlock conference room

post

Unlock conference room by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/unlock

POST /api/conference_rooms/{id}/unlock HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Start recording in conference room

post

Start recording in conference room.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/start_recording

POST /api/conference_rooms/{id}/start_recording HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Stop recording in conference room

post

Stop recording in conference room.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/stop_recording

POST /api/conference_rooms/{id}/stop_recording HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List room participants

get

Retrieve a collection of conference room participants.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/conference_rooms/{id}/participants

GET /api/conference_rooms/{id}/participants HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "display_name": "\"example\"<sip:[email protected]>",
      "muted": true,
      "chairman": true,
      "position": 1
    }
  ]
}

Update conference room participant layout

post

Update conference room participants layout based on room layout.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/participants/layout

POST /api/conference_rooms/{id}/participants/layout HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "items": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ]
}

No content

Get room participant details

get

Get room participant details.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

display_namestringOptional

The display name of conference room participant.

Example: "example"<sip:[email protected]>

mutedbooleanOptional

Whether the participant is muted.

chairmanbooleanOptional

Indicates whether the user is chairman of the conference room.

positioninteger · int32 · min: -1 · max: 8Optional

The position of room member.
The member will not be displayed when -1 is specified.

4XX

Error

get

/conference_rooms/{id}/participants/{participant_id}

GET /api/conference_rooms/{id}/participants/{participant_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "display_name": "\"example\"<sip:[email protected]>",
  "muted": true,
  "chairman": true,
  "position": 1
}

Invite as room participant

post

Invite an user as conference room participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

numberstringOptional

The number of invited participant.

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/participants/invite

POST /api/conference_rooms/{id}/participants/invite HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "number": "text"
}

No content

Mute room participant

post

Mute conference room participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/participants/{participant_id}/mute

POST /api/conference_rooms/{id}/participants/{participant_id}/mute HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unmute room participant

post

Unmute conference room participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/participants/{participant_id}/unmute

POST /api/conference_rooms/{id}/participants/{participant_id}/unmute HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Transfer room ownership

post

Transfer room ownership to another participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/participants/{participant_id}/chairman

POST /api/conference_rooms/{id}/participants/{participant_id}/chairman HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set conference room participant position

post

Set conference room participant position.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

positioninteger · int32 · min: -1 · max: 8Optional

The position of room member.
The member will not be displayed when -1 is specified.

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/participants/{participant_id}/position

POST /api/conference_rooms/{id}/participants/{participant_id}/position HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "position": 1
}

No content

Kick out room participant

post

Kick out conference room participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/conference_rooms/{id}/participants/{participant_id}/destroy

POST /api/conference_rooms/{id}/participants/{participant_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List conference recordings

get

Retrieve a collection of conference room's recordings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/conference_rooms/{id}/recordings

GET /api/conference_rooms/{id}/recordings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "answered_at": "2017-07-21T17:32:28Z",
      "ended_at": "2017-07-21T17:32:28Z",
      "duration": 1,
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Delete a conference record

post

Delete a conference recording of conference room.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

recording_idall ofRequired

The unique ID of conference recording.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/conference_rooms/{id}/recordings/{recording_id}/destroy

POST /api/conference_rooms/{id}/recordings/{recording_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update conference recording status to read

post

Update conference recording status to read

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

recording_idall ofRequired

The unique ID of conference recording.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/recordings/{recording_id}/set_read

POST /api/conference_rooms/{id}/recordings/{recording_id}/set_read HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update conference recording status to read

post

Update conference recording status to read

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

recording_idall ofRequired

The unique ID of conference recording.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/conference_rooms/{id}/recordings/{recording_id}/set_unread

POST /api/conference_rooms/{id}/recordings/{recording_id}/set_unread HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

hashtagList conference servers

hashtagCreate a conference server

hashtagRetrieve a conference server

hashtagUpdate a conference server

hashtagQuery conference server status

hashtagDelete a conference server

hashtagList conference rooms

hashtagCreate a conference room

hashtagRetrieve a conference room

hashtagUpdate a conference room

hashtagDelete a conference room

hashtagQuery conference room's status

hashtagMute conference room

hashtagUnmute conference room

hashtagLock conference room

hashtagUnlock conference room

hashtagStart recording in conference room

hashtagStop recording in conference room

hashtagList room participants

hashtagUpdate conference room participant layout

hashtagGet room participant details

hashtagInvite as room participant

hashtagMute room participant

hashtagUnmute room participant

hashtagTransfer room ownership

hashtagSet conference room participant position

hashtagKick out room participant

hashtagList conference recordings

hashtagDelete a conference record

hashtagUpdate conference recording status to read

hashtagUpdate conference recording status to read

List conference servers

Create a conference server

Retrieve a conference server

Update a conference server

Query conference server status

Delete a conference server

List conference rooms

Create a conference room

Retrieve a conference room

Update a conference room

Delete a conference room

Query conference room's status

Mute conference room

Unmute conference room

Lock conference room

Unlock conference room

Start recording in conference room

Stop recording in conference room

List room participants

Update conference room participant layout

Get room participant details

Invite as room participant

Mute room participant

Unmute room participant

Transfer room ownership

Set conference room participant position

Kick out room participant

List conference recordings

Delete a conference record

Update conference recording status to read

Update conference recording status to read