Retrive media servers

GET /media_server/list
Retrieves a list of media servers. Note: this feature is available for admin user only.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional".
    Default value will be used when user has not specified value for this field.

Sample Request

https://example.com/api/media_server/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT

Response

Placeholders
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional".
    Default value will be used when user has not specified value for this field.
  • page_count

    integer

    required

    The total count of pages.
  • count

    integer

    required

    Current pagesize.
  • servers

    array

    required

    The collection of media server objects.
    Show child attributes

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "servers": [
        {
            "name": "BUILT_IN_SERVER",
            "ipv4": "127.0.0.1",
            "ipv6": ":1",
            "port": 8894,
            "type": "DEFAULT",
            "enabled": true,
            "status": "ONLINE"
        }
    ]
}

Create a media server.

POST /media_server/create
Create a new media server. Note: this feature is available for admin user only.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • name

    string

    required

    The name of Media Server.
  • enabled

    boolean

    required

    Indicates if the current Media Server has been enabled for PortSIP PBX.
  • ipv4

    string

    required

    IPV4 address for Media Server.
  • ipv6

    string

    required

    IPV6 address for Media Server.
  • port

    integer

    required

    Port for Media server.
  • max_concurrent_sessions

    integer

    required

    Max concurrent sessions.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "name": "Sample_server_name",
    "enabled": true,
    "ipv4": "192.168.1.12",
    "ipv6": "",
    "port": 8894,
    "max_concurrent_sessions": 100
}

Response

Placeholders

Sample Response

Retrive settings of media server

GET /media_server/show
Returns the settings of an added media server. Note: this feature is available for admin user only.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • name

    string

    required

    The name of Media Server.

Sample Request

https://example.com/api/media_server/show?access_token=196ACE20C6F34027895F7F95402BB164&name=BUILT_IN_SERVER

Response

Placeholders
  • name

    string

    required

    The name of Media Server.
  • enabled

    boolean

    required

    Indicates if the current Media Server has been enabled for PortSIP PBX.
  • ipv4

    string

    required

    IPV4 address for Media Server.
  • ipv6

    string

    required

    IPV6 address for Media Server.
  • port

    integer

    required

    Port for Media server.
  • max_concurrent_sessions

    integer

    required

    Max concurrent sessions.

Sample Response

{
    "name": "Sample_server_name",
    "enabled": true,
    "ipv4": "192.168.1.12",
    "ipv6": "",
    "port": 8894,
    "max_concurrent_sessions": 100
}

Update settings for media server

POST /media_server/update
Modify the settings of an added media server. Note: this is available for admin user only.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • name

    string

    required

    The name of Media Server.
  • enabled

    boolean

    required

    Indicates if the current Media Server has been enabled for PortSIP PBX.
  • port

    integer

    required

    Port for Media server.
  • max_concurrent_sessions

    integer

    required

    Specify the maximum number of concurrent sessions supported for your media server.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "name": "Sample_server_name",
    "enabled": true,
    "port": 8894,
    "max_concurrent_sessions": 100
}

Response

Placeholders

Sample Response

Remove a media server

POST /media_server/destroy
Remove an existing media server. Note: this is available for admin user only.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • name

    string

    required

    The name of Media Server.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "name": "BUILT_IN_SERVER"
}

Response

Placeholders

Sample Response