Conference servers

List conference servers

List conference servers

GEThttp://127.0.0.1:8888/api/conference_servers

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/conference_servers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a conference server

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

POSThttp://127.0.0.1:8888/api/conference_servers

Body

application/json

Conference room object

name*string

The name of conference server.

enabledboolean

The activate status or deactivated status.

ipv4string

Host IPV4 address.

ipv6string

Host IPV6 address.

max_rooms*integer (int32)

The maximum number of rooms for conference server.

max_participants*integer (int32)

The maximum number of participants for conference server.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of conference server.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/conference_servers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "max_rooms": 0,
      "max_participants": 0
    }),
});
const data = await response.json();

Response

200

{
  "id": {}
}

Retrieve a conference server

Retrieve a conference server.

GEThttp://127.0.0.1:8888/api/conference_servers/{id}

Path parameters

id*all of

The unique ID of conference server.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of conference server.

namestring

The name of conference server.

enabledboolean

The activate status or deactivated status.

typeenum

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

INTERNALEXTERNAL

ipv4string

Host IPV4 address.

ipv6string

Host IPV6 address.

max_roomsinteger (int32)

The maximum number of rooms for conference server.

max_participantsinteger (int32)

The maximum number of participants for conference server.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/conference_servers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update a conference server

Update a conference server

POSThttp://127.0.0.1:8888/api/conference_servers/{id}

Path parameters

id*all of

The unique ID of conference server.

Body

application/json

enabledboolean

The activate status or deactivated status.

max_roomsinteger (int32)

The maximum number of rooms for conference server.

max_participantsinteger (int32)

The maximum number of participants for conference server.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/conference_servers/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();