Conference servers

PreviousCustom headers NextStatus

Was this helpful?

List conference servers

get

/conference_servers

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

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

topinteger · int32 · min: 1 · max: 100 · default: 100

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/conference_servers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Create a conference server

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

post

/conference_servers

Authorizations

Body

namestring · min: 1 · max: 64required

The name of conference server.

enabledboolean · default: true

The activate status or deactivated status.

ipv4string

Host IPV4 address.

ipv6string

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/conference_servers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "ipv4": "text",
    "ipv6": "text",
    "max_rooms": 1,
    "max_participants": 1
  }'

200

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a conference server

Retrieve a conference server.

get

/conference_servers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of conference server.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/conference_servers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Update a conference server

post

/conference_servers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of conference server.

The unique ID of the resource.

Body

enabledboolean · default: true

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.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/conference_servers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true,
    "max_rooms": 1,
    "max_participants": 1
  }'

200

4XX

No body