Create conference server

POST /conference_server/create
Create conference 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

    Host port for conference server.
  • type

    string

    required

    Every PortSIP PBX has a built-in conference server with type 1 (default); the new added conference server MUST be typed with "EXTERNAL".

    enum : ['DEFAULT', 'EXTERNAL']

  • ipv6

    string

    required

    Host IPV6 address for conference server.
  • ipv4

    string

    required

    Host IPV4 address for conference server.
  • max_rooms

    integer

    required

    The maximum number of rooms for conference server.
  • max_participants

    integer

    required

    The maximum number of participants for conference server.
  • name

    string

    required

    Name of conference server.

Sample Request

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

Responses

200
Created conference server
application/json
  • id

    integer

    The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only.

    format : int64

Sample Response

                      
{
    "id": 1234
}

Destroy conference room

POST /conference_room/destroy
Destroy conference room
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The ID of conference room.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/conference_room/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

404
User not found
200
Successful operation
400
Invalid username supplied

Sample Response

update conference room participant

POST /conference_room/participants/update
update conference room participant
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • op

    string

    required

    enum : ['MUTE/UNMUTE', 'INVITE', 'DELETE']

  • participant_extension

    string

    required

    Extension for conference room. NOTE: It MUST be a non-existent extension.
  • id

    integer

    required

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/conference_room/participants/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'

Responses

200
update conference room participant

Sample Response

update conference room chairman

POST /conference_room/chairman/update
update conference room chairman
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • participant_extension

    string

    required

    Extension for conference room. NOTE: It MUST be a non-existent extension.
  • id

    integer

    required

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/conference_room/chairman/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'

Responses

200
update conference room chairman

Sample Response

Retrieve conference room

GET /conference_room/show
Retrieve conference room
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The ID of conference room.

    format : int64

Sample Request

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

Responses

200
Successful operation
application/json
  • language

    string

    Language for prompt in the conference room.

    enum : ['zh_CN', 'en_US', 'pt_BR']

  • admin_pin

    string

    PIN for admin of the conference room.
  • room_pin

    string

    PIN for the conference room.
  • framerate

    integer

    The framerate for video conference room.

    minimum: 5

    maximum: 30

  • layout

    integer

    The number of grids allowed for video conference room. Values : 1, 2, 3, 4, 6 or 9.
  • mode

    string

    AUDIO for audio conference room; VIDEO for video conference room.

    enum : ['AUDIO', 'VIDEO']

  • subject

    string

    Subject of conference room.
  • id

    integer

    format : int64

  • bitrate

    integer

    The transmission rate for video conference room. Values: 128 ~ 2048 (it MUST be an integer).
  • max_participants

    integer

    The maximum number of participants allowed in the room.
  • resolution

    string

    The video resolution for video conference room.

    enum : ['QCIF', 'CIF', 'VGA', 'SVGA', 'XVGA', '720P', 'QVGA']

  • outbound_caller_id

    string

    outbound_caller_id of conference room.
  • unattended

    boolean

    Cancellation of interactive voice .
  • extension_number

    string

    Extension for conference room. NOTE: It MUST be a non-existent extension.

Sample Response

                      
{
    "id": 1234
}

Retrieve a collection of conference rooms

GET /conference_room/list
Retrieve a collection of conference rooms
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/conference_room/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • pagesize

    integer

  • count

    integer

  • pagination

    integer

  • rooms

    array

    Show child attributes
  • sort_by

    string

Sample Response

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

Retrieve a collection of conference servers

GET /conference_server/list
Retrieve a collection of conference 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/conference_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"
}

Update conference server

POST /conference_server/update
Update conference server
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • max_rooms

    integer

    required

    The maximum number of rooms for conference server.
  • max_participants

    integer

    required

    The maximum number of participants for conference server.
  • id

    integer

    required

    The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only.

    format : int64

Sample Request

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

Responses

200
Successful operation

Sample Response

Update conference room

POST /conference_room/update
Update conference room
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • language

    string

    required

    Language for prompt in the conference room.

    enum : ['zh_CN', 'en_US', 'pt_BR']

  • admin_pin

    string

    required

    PIN for admin of the conference room.
  • room_pin

    string

    required

    PIN for the conference room.
  • framerate

    integer

    required

    The framerate for video conference room.

    minimum: 5

    maximum: 30

  • layout

    integer

    required

    The number of grids allowed for video conference room. Values : 1, 2, 3, 4, 6 or 9.
  • locked

    boolean

    required

    locked or unlocked .
  • subject

    string

    required

    Subject of conference room.
  • id

    integer

    required

    format : int64

  • unattended

    boolean

    required

    Cancellation of interactive voice .
  • recording

    boolean

    required

    recording or stop recording .
  • resolution

    string

    required

    The video resolution for video conference room.

    enum : ['QCIF', 'CIF', 'VGA', 'SVGA', 'XVGA', '720P', 'QVGA']

  • outbound_caller_id

    string

    required

    outbound_caller_id of conference room.
  • muted

    boolean

    required

    muted or unmuted .
  • bitrate

    integer

    required

    The transmission rate for video conference room. Values: 128 ~ 2048 (it MUST be an integer).
  • max_participants

    integer

    required

    The maximum number of participants allowed in the room.

Sample Request

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

Responses

200
Updated tenant object

Sample Response

Retrieve a collection of conference room participants

GET /conference_room/participants/list
Retrieve a collection of conference room participants
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The ID of conference room.

    format : int64

Sample Request

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

Responses

200
Successful operation
application/json
  • --

    object

    Show child attributes

Sample Response

                      
{
    "id": 1234
}

Retrieve conference server

GET /conference_server/show
Retrieve conference server
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The ID of conference server.

    format : int64

Sample Request

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

Responses

200
Successful operation
application/json
  • type

    string

    Every PortSIP PBX has a built-in conference server with type 1 (default); the new added conference server MUST be typed with "EXTERNAL".

    enum : ['DEFAULT', 'EXTERNAL']

  • participants_count

    integer

    The number of participants for conference server.
  • ipv6

    string

    Host IPV6 address for conference server.
  • cpu_usage

    integer

    The cpu_usage for conference server.
  • rooms_count

    integer

    The number of rooms for conference server.
  • name

    string

    Name of conference server.
  • port

    integer

    Host port for conference server.
  • status

    string

    enum : ['ONLINE', 'OFFLINE']

  • memory_usage

    integer

    The memory_usage for conference server.
  • ipv4

    string

    Host IPV4 address for conference server.
  • max_rooms

    integer

    The maximum number of rooms for conference server.
  • max_participants

    integer

    The maximum number of participants for conference server.

Sample Response

                      
{}

update conference room main_screen

POST /conference_room/main_screen/update
update conference room main_screen
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • participant_extension

    string

    required

    Extension for conference room. NOTE: It MUST be a non-existent extension.
  • id

    integer

    required

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/conference_room/main_screen/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'

Responses

200
update conference room main_screen

Sample Response

Destroy conference server

POST /conference_server/destroy
Destroy conference 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 userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only.

    format : int64

Sample Request

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

Responses

404
User not found
200
Successful operation
400
Invalid server id supplied

Sample Response

Create conference room

POST /conference_room/create
Create conference room
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • language

    string

    required

    Language for prompt in the conference room.

    enum : ['zh_CN', 'en_US', 'pt_BR']

  • admin_pin

    string

    required

    PIN for admin of the conference room.
  • room_pin

    string

    required

    PIN for the conference room.
  • framerate

    integer

    required

    The framerate for video conference room.

    minimum: 5

    maximum: 30

  • layout

    integer

    required

    The number of grids allowed for video conference room. Values : 1, 2, 3, 4, 6 or 9.
  • mode

    string

    required

    AUDIO for audio conference room; VIDEO for video conference room.

    enum : ['AUDIO', 'VIDEO']

  • subject

    string

    required

    Subject of conference room.
  • bitrate

    integer

    required

    The transmission rate for video conference room. Values: 128 ~ 2048 (it MUST be an integer).
  • max_participants

    integer

    required

    The maximum number of participants allowed in the room.
  • resolution

    string

    required

    The video resolution for video conference room.

    enum : ['QCIF', 'CIF', 'VGA', 'SVGA', 'XVGA', '720P', 'QVGA']

  • outbound_caller_id

    string

    required

    outbound_caller_id of conference room.
  • unattended

    boolean

    required

    Cancellation of interactive voice .
  • extension_number

    string

    required

    Extension for conference room. NOTE: It MUST be a non-existent extension.

Sample Request

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

Responses

200
Created conference room object
application/json
  • id

    integer

    format : int64

Sample Response

                      
{
    "id": 1234
}