Media servers

List media servers

Retrieve a collection of media servers

GEThttp://127.0.0.1:8888/api/media_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/media_servers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "type": "INTERNAL",
      "enabled": true,
      "private_ipv4": "text",
      "private_ipv6": "text",
      "public_ipv4": "text",
      "public_ipv6": "text",
      "custom_options": "text"
    }
  ]
}

Create a media server

POSThttp://127.0.0.1:8888/api/media_servers

Body

application/json

name*string

The name of media server.

enabledboolean

The activate status or deactivated status.

private_ipv4string

Host IPV4 address.

private_ipv6string

Host IPV6 address.

public_ipv4string

Host IPV4 address.

public_ipv6string

Host IPV6 address.

max_concurrencyinteger (int32)

Max concurrent sessions.

custom_optionsstring

Some custom configuration options serialized as json string

Response

2004XX

Created media server

Body

application/json

idall of

The unique ID of media server.

Request

JavaScriptCurlPython

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

Response

200

{
  "id": {}
}

Retrieve a media server

Retrieve a media server.

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

Path parameters

id*all of

The unique ID of media server.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of media server.

namestring

The name of media server.

typeenum

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

INTERNALEXTERNAL

enabledboolean

The activate status or deactivated status.

private_ipv4string

Host IPV4 address.

private_ipv6string

Host IPV6 address.

public_ipv4string

Host IPV4 address.

public_ipv6string

Host IPV6 address.

max_concurrencyinteger (int32)

Max concurrent sessions.

custom_optionsstring

Some custom configuration options serialized as json string

Request

JavaScriptCurlPython

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

Response

200

{
  "id": {},
  "name": "text",
  "type": "INTERNAL",
  "enabled": true,
  "private_ipv4": "text",
  "private_ipv6": "text",
  "public_ipv4": "text",
  "public_ipv6": "text",
  "custom_options": "text"
}

Update a media server

Update a media server

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

Path parameters

id*all of

The unique ID of media server.

Body

application/json

enabledboolean

The activate status or deactivated status.

max_concurrencyinteger (int32)

Max concurrent sessions.

custom_optionsstring

Some custom configuration options serialized as json string

Response

2004XX

OK

Request

JavaScriptCurlPython

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