update conference room main_screen

POST /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
  • id

    integer

    required

    format : int64

  • participant_extension

    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/main_screen/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'
                      
                    

Responses

200
update conference room main_screen

Sample Response

                      
                      
                    

Retrieve conference server

GET /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
  • max_participants

    integer

    The maximum number of participants for conference server.
  • participants_count

    integer

    The number of participants for conference server.
  • memory_usage

    integer

    The memory_usage for conference server.
  • rooms_count

    integer

    The number of rooms for conference server.
  • max_rooms

    integer

    The maximum number of rooms for conference server.
  • cpu_usage

    integer

    The cpu_usage for conference server.
  • port

    integer

    Host port for conference server.
  • name

    string

    Name of conference server.
  • ipv4

    string

    Host IPV4 address for conference server.
  • 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']

  • status

    string

    enum : ['ONLINE', 'OFFLINE']

  • ipv6

    string

    Host IPV6 address for conference server.

Sample Response

                      
{}
                      
                    

Update conference server

POST /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_participants

    integer

    required

    The maximum number of participants for conference server.
  • max_rooms

    integer

    required

    The maximum number of rooms 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

                      
                      
                    

Create conference room

POST /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
  • subject

    string

    required

    Subject of conference room.
  • room_pin

    string

    required

    PIN for the conference room.
  • unattended

    boolean

    required

    Cancellation of interactive voice .
  • admin_pin

    string

    required

    PIN for admin of the conference room.
  • layout

    integer

    required

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

    integer

    required

    The framerate for video conference room.

    minimum: 5

    maximum: 30

  • mode

    string

    required

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

    enum : ['AUDIO', 'VIDEO']

  • max_participants

    integer

    required

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

    string

    required

    Language for prompt in the conference room.

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

  • extension_number

    string

    required

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

    string

    required

    outbound_caller_id of conference room.
  • bitrate

    integer

    required

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

    string

    required

    The video resolution for video conference room.

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

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
}
                      
                    

Destroy conference room

POST /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

200
Successful operation
404
User not found
400
Invalid username supplied

Sample Response

                      
                      
                    

update conference room participant

POST /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
  • id

    integer

    required

    format : int64

  • op

    string

    required

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

  • participant_extension

    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/participants/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'
                      
                    

Responses

200
update conference room participant

Sample Response

                      
                      
                    

Retrieve a collection of conference servers

GET /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
  • sort_by

    string

  • servers

    array

    Show child attributes
  • pagesize

    integer

  • pagination

    integer

  • count

    integer

Sample Response

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

Destroy conference server

POST /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

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

Sample Response

                      
                      
                    

Retrieve conference room

GET /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
  • subject

    string

    Subject of conference room.
  • id

    integer

    format : int64

  • room_pin

    string

    PIN for the conference room.
  • unattended

    boolean

    Cancellation of interactive voice .
  • admin_pin

    string

    PIN for admin of the conference room.
  • layout

    integer

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

    integer

    The framerate for video conference room.

    minimum: 5

    maximum: 30

  • mode

    string

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

    enum : ['AUDIO', 'VIDEO']

  • max_participants

    integer

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

    string

    Language for prompt in the conference room.

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

  • extension_number

    string

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

    string

    outbound_caller_id of conference room.
  • bitrate

    integer

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

    string

    The video resolution for video conference room.

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

Sample Response

                      
{
    "id": 1234
}
                      
                    

Create conference server

POST /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
  • max_rooms

    integer

    required

    The maximum number of rooms 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']

  • port

    integer

    required

    Host port for conference server.
  • name

    string

    required

    Name of conference server.
  • ipv4

    string

    required

    Host IPV4 address for conference server.
  • max_participants

    integer

    required

    The maximum number of participants for conference server.
  • ipv6

    string

    required

    Host IPV6 address for 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
}
                      
                    

Retrieve a collection of conference rooms

GET /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
  • sort_by

    string

  • pagesize

    integer

  • rooms

    array

    Show child attributes
  • pagination

    integer

  • count

    integer

Sample Response

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

update conference room chairman

POST /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
  • id

    integer

    required

    format : int64

  • participant_extension

    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/chairman/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'
                      
                    

Responses

200
update conference room chairman

Sample Response

                      
                      
                    

Retrieve a collection of conference room participants

GET /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
}
                      
                    

Update conference room

POST /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
  • subject

    string

    required

    Subject of conference room.
  • id

    integer

    required

    format : int64

  • room_pin

    string

    required

    PIN for the conference room.
  • admin_pin

    string

    required

    PIN for admin of the conference room.
  • unattended

    boolean

    required

    Cancellation of interactive voice .
  • layout

    integer

    required

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

    integer

    required

    The framerate for video conference room.

    minimum: 5

    maximum: 30

  • locked

    boolean

    required

    locked or unlocked .
  • muted

    boolean

    required

    muted or unmuted .
  • max_participants

    integer

    required

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

    string

    required

    Language for prompt in the conference room.

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

  • recording

    boolean

    required

    recording or stop recording .
  • outbound_caller_id

    string

    required

    outbound_caller_id of conference room.
  • bitrate

    integer

    required

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

    string

    required

    The video resolution for video conference room.

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

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