Retrieve media server

GET /show
Retrieve media server
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The ID of Media Server.

    format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/media_server/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • private_ipv6

    string

    IPV6 address for Media Server.
  • enabled

    boolean

    The activate status or deactivated status.
  • cpu_usage

    integer

    cpu or memory usage.
  • private_ipv4

    string

    IPV4 address for Media Server.
  • active_call_sessions

    integer

    active concurrent sessions.
  • name

    string

    The name of Media Server.

    minLength: 64

    maxLength: 64

  • port

    integer

    Port for Media server.
  • status

    string

    OFFLINE or ONLINE

    enum : ['OFFLINE', 'ONLINE']

  • memory_usage

    integer

    cpu or memory usage.
  • public_ipv4

    string

    IPV4 address for Media Server.
  • max_concurrent_sessions

    integer

    Max concurrent sessions.
  • public_ipv6

    string

    IPV6 address for Media Server.

Sample Response

                      
{
    "private_ipv6": "::1",
    "public_ipv4": "192.168.1.1",
    "enabled": true,
    "private_ipv4": "192.168.1.1",
    "name": "server1",
    "public_ipv6": "::1"
}

Destroy media server

POST /destroy
Destroy media server
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • id

    integer

    required

    The name of Media Server.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/media_server/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 123
}'

Responses

200
Successful operation
400
Invalid server ID supplied.

Sample Response

Update media server

POST /update
Update media server
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • enabled

    boolean

    required

    The activate status or deactivated status.
  • max_concurrent_sessions

    integer

    required

    Max concurrent sessions.
  • id

    integer

    required

    The name of Media Server.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/media_server/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "enabled": true,
    "id": 123
}'

Responses

200
Successful operation

Sample Response

Create media server

POST /create
Create media server
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • port

    integer

    required

    Port for Media server.
  • private_ipv6

    string

    required

    IPV6 address for Media Server.
  • public_ipv4

    string

    required

    IPV4 address for Media Server.
  • enabled

    boolean

    required

    The activate status or deactivated status.
  • private_ipv4

    string

    required

    IPV4 address for Media Server.
  • name

    string

    required

    The name of Media Server.

    minLength: 64

    maxLength: 64

  • max_concurrent_sessions

    integer

    required

    Max concurrent sessions.
  • public_ipv6

    string

    required

    IPV6 address for Media Server.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/media_server/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "private_ipv6": "::1",
    "public_ipv4": "192.168.1.1",
    "enabled": true,
    "private_ipv4": "192.168.1.1",
    "name": "server1",
    "public_ipv6": "::1"
}'

Responses

200
Created media server
application/json
  • id

    integer

    The name of Media Server.

    format : int64

Sample Response

                      
{
    "id": 123
}

Retrieve a collection of media servers

GET /list
Retrieve a collection of media servers
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • pagination

    integer

    required

    The pagination of paging.

    format : int32

  • pagesize

    integer

    required

    The size of paging.
  • sort_by

    string

    optional

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

    enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/media_server/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • pagesize

    integer

  • count

    integer

  • servers

    array

    Show child attributes
  • pagination

    integer

  • sort_by

    string

Sample Response

                      
{
    "pagesize": 10,
    "count": 100,
    "pagination": 8,
    "sort_by": "DEFAULT"
}