Retrive conference rooms
Request
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/conference_room/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT
Response
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.rooms
array
required
Show child attributesThe count of conference rooms.
Sample Response
{
"pagination": 1,
"pagesize": 100,
"sort_by": "DEFAULT",
"page_count": 100,
"count": 100,
"rooms": [
{
"room_number": "155",
"room_pin": "155",
"admin_pin": "155",
"server_ip_v4": "192.168.1.1",
"server_ip_v6": "",
"server_port": 8876,
"mode": "AUDIO",
"status": "ONLINE",
"maximum_participants": 12
}
]
}
Retrive conference room settings
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.room_number
string
required
Extension number for conference room
Sample Request
https://example.com/api/conference_room/show?access_token=196ACE20C6F34027895F7F95402BB164&room_number=123
Response
room_number
string
required
Extension number for conference room.room_pin
string
required
PIN for conference room.admin_pin
string
required
PIN for admin of the conference room.subject
string
required
Subject of conference room.mode
string
required
Values:
AUDIO – audio conference room;
VIDEO – video conference room.status
string
required
Values: "ONLINE" or "OFFLINE".unattended
boolean
required
Cancellation of interactive voice.recording
boolean
optional
Parameter is valid only if "status" is set to "ONLINE".locked
boolean
optional
Parameter is valid only if "status" is set to "ONLINE".muted
boolean
optional
Parameter is valid only if "status" is set to "ONLINE".participants
integer
required
The count of participants in room now.max_participants
integer
optional
The maximum number of participants allowed in the room.layout
integer
required
The number of grids allowed for video conference room. Values: 1, 2, 3, 4, 6 or 9.bitrate
integer
required
The transmission rate for video conference room. Values: 128 ~ 2048 (it MUST be an integer).framerate
integer
required
The framerate for video conference room.
Values: 5 ~ 30 (it MUST be an integer).resolution
string
required
The video resolution for video conference room.
Valid values include:
QCIF, CIF, VGA, SVGA, XVGA, 720P, QVGA.language
string
required
Language for prompt in the conference room,
including:
zh-cn, en-us and pt-br.
Sample Response
{
"room_number": "155",
"room_pin": "155",
"admin_pin": "155",
"mode": "AUDIO",
"status": "ONLINE",
"unattended": false,
"recording": false,
"locked": false,
"muted": false,
"participants": 0,
"maximum_participants": 12,
"layout": 2,
"bitrate": 1024,
"framerate": 20,
"resolution": "QCIF",
"language": "en-us"
}
Add a conference room
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.room_number
string
required
Extension for conference room. NOTE: It MUST be a non-existent extension.room_pin
string
optional
PIN for the conference room.admin_pin
string
optional
PIN for admin of the conference room.subject
string
required
Subject of conference room.mode
string
required
Values:
AUDIO – audio conference room;
VIDEO – video conference room.unattended
boolean
required
Cancellation of interactive voice .max_participants
integer
optional
The maximum number of participants allowed in the room.layout
integer
required
The number of grids allowed for video conference room.
Values : 1, 2, 3, 4, 6 or 9.bitrate
integer
required
The transmission rate for video conference room.
Values: 128 ~ 2048 (it MUST be an integer).framerate
integer
required
The framerate for video conference room.
Values: 5 ~ 30 (it MUST be an integer).resolution
string
required
The video resolution for video conference room.
Valid values include QCIF, CIF, VGA, SVGA, XVGA, 720P and QVGA.language
string
required
Language for prompt in the conference room,
including zh-cn, en-us and pt-br.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"room_number": "155",
"room_pin": "155",
"admin_pin": "155",
"mode": "AUDIO",
"unattended": false,
"max_participants": 10,
"layout": 2,
"bitrate": 1024,
"framerate": 20,
"resolution": "QCIF",
"language": "en-us"
}
Response
Sample Response
Update a conference room
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.room_number
string
required
Extension for conference room. NOTE: It MUST be a non-existent extension.room_pin
string
optional
PIN for the conference room.admin_pin
string
optional
PIN for admin of the conference room.subject
string
required
Subject of conference room.unattended
boolean
required
Cancellation of interactive voice .max_participants
integer
optional
The maximum number of participants allowed in the room.layout
integer
required
The number of grids allowed for video conference room. Values : 1, 2, 3, 4, 6 or 9.bitrate
integer
required
The transmission rate for video conference room. Values: 128 ~ 2048 (it MUST be an integer).framerate
integer
required
The framerate for video conference room. Values: 5 ~ 30 (it MUST be an integer).resolution
string
required
The video resolution for video conference room. Valid values include QCIF, CIF, VGA, SVGA, XVGA, 720P and QVGA.language
string
required
Language for prompt in the conference room,
including zh-cn, en-us and pt-br.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"room_number": "155",
"room_pin": "155",
"admin_pin": "155",
"unattended": false,
"max_participants": 10,
"layout": 2,
"bitrate": 1024,
"framerate": 20,
"resolution": "QCIF",
"language": "en-us"
}
Response
Sample Response
Remove a conference room
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.room_number
string
required
Extension number for conference room.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"room_number": "123"
}
Response
Sample Response
Retrieve conference participants
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.room_number
string
required
Extension number for conference room.
Sample Request
https://example.com/api/conference_room/participants/list?access_token=196ACE20C6F34027895F7F95402BB164&room_number=123
Response
count
integer
required
The number of participants in conference room.participants
array
required
Show child attributesCollection of room participant objects.
Sample Response
{
"count": 1,
"participants": [
{
"participant": "101",
"muted": true
}
]
}
Update settings for participant
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.room_number
string
required
Extension number for conference room.op
string
required
Values:
MUTE/UNMUTE – mute/unmute;
INVITE – invite;
DELETE – deleteparticipant_extension
string
required
Extension number for participant.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"room_number": "123",
"op": "INVITE",
"participant_extension": "456"
}
Response
Sample Response
Update settings for participant
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.room_number
string
required
Extension number for conference room.participant_extension
string
required
Extension number for participant.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"room_number": "123",
"participant_extension": "456"
}
Response
Sample Response
Retrive conference servers
Request
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/conference_server/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT
Response
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
Show child attributesServer list
Sample Response
{
"pagination": 1,
"pagesize": 100,
"sort_by": "DEFAULT",
"page_count": 100,
"count": 100,
"servers": [
{
"count": 1,
"servers": {
"name": "Built-in Server",
"ipv4": "192.168.100.164",
"ipv6": "",
"port": 8878,
"enabled": true,
"type": "DEFAULT",
"max_rooms": 10,
"max_participants": 100
}
}
]
}
Add a conference server
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.name
string
required
Name of conference server.ipv4
string
required
Host IPV4 address for conference server.ipv6
string
required
Host IPV6 address for conference server.port
integer
required
Host port 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.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"name": "Built-in Server",
"ipv4": "192.168.100.164",
"ipv6": "",
"port": 8878,
"max_rooms": 10,
"max_participants": 100
}
Response
Sample Response
null
Update conference server
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.name
string
required
Name of conference server.max_rooms
integer
optional
The maximum number of rooms for conference server.max_participants
integer
optional
The maximum number of participants for conference server.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"name": "Built-in Server",
"max_rooms": 10,
"max_participants": 100
}
Response
Sample Response
Obtain status of conference server
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.name
string
required
Name of conference server.
Sample Request
https://example.com/api/conference_server/show?access_token=196ACE20C6F34027895F7F95402BB164&name=Built-in+Server
Response
name
string
required
Name of conference server.ipv4
string
required
Host IPV4 address for conference server.ipv6
string
required
Host IPV6 address for conference server.port
integer
required
Host port for conference server.rooms_count
integer
required
The count of current conference rooms.participants_count
integer
required
The count of participants for current 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.cpu_usage
integer
required
Current host CPU usage for conference server, such as "65". It could be in the range of 0 ~ 100.memory_usage
integer
required
Current host memory usage for conference server, such as "35". It could be in the range of 0 ~ 100.
Sample Response
{
"rooms_count": 10,
"participants_count": 10,
"cpu_usage": 10,
"memory_usage": 39
}
Delete conference server
Request
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.name
string
required
The name of conference server.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"name": "server1"
}