Web Server API

REST APIs for meeting management, URL join, live streaming, and recording.

Create Meeting

URL: https://xx.com/WebAPI/meetingcreate

Method: POST (Content-Type: multipart/form-data)

Parameters:

Name	Required	Type	Description
key	Yes	string	Enterprise ID
meetingname	Yes	string	Meeting name
starttime	Yes	string	Start time (Unix timestamp, seconds)
endtime	No	string	End time (omit for permanent)
chairmanpwd	Yes	string	Chair password, 4–20 chars
islive	No	string	1 live, 0 not live

Response:

{
    "version": 1173,
    "serial": 754884357,
    "roomid": "5ff66be5bfc2421a04767eb7",
    "sig": "203usx24yeijd3zjfbpTqWGskyA2Hw7z9ngrZDQFV8=",
    "pushurl": "domain/app/754884357?auth_key=...",
    "pullurl": "domain/live/754884357.m3u8?auth_key=...",
    "pullurl2": "domain/hls/754884357.m3u8",
    "recordpath": "domain/upload/754884357.mp4",
    "result": 0
}

Field	Type	Description
serial	int	Meeting ID
roomid	string	Media server room id
sig	string	Used when sharing meetings
pushurl	string	Push stream URL
pullurl	string	Pull stream URL
recordpath	string	Recording file path
result	string	0 success, others error

Modify Meeting

URL: https://xx.com/WebAPI/meetingmodify · Method: POST

Name	Required	Type	Description
key	Yes	string	Enterprise ID
serial	Yes	string	Meeting ID
meetingname	No	string	Meeting name
chairmanpwd	No	string	Chair password
starttime	Yes	string	Start time (timestamp)
endtime	No	string	End time

Delete Meeting

URL: https://xx.com/WebAPI/meetingdelete · Method: POST

Name	Required	Type	Description
key	Yes	string	Enterprise ID
serial	Yes	string	Meeting ID

Get Class Duration

URL: https://xx.com/WebAPI/getClassBeginTime · Method: GET

Name	Required	Type	Description
key	Yes	string	Enterprise ID
serial	Yes	string	Meeting ID

Returns duration (seconds) on success.

Bind Meeting Documents

URL: https://xx.com/WebAPI/meetingbindfile · Method: POST

Name	Required	Type	Description
key	Yes	string	Enterprise ID
serial	Yes	string	Meeting ID
fileidarr[]	Yes	array	File IDs

Upload Meeting Background

URL: https://xx.com/WebAPI/uploadRoomPic · Method: POST

Name	Required	Type	Description
key	Yes	string	Enterprise ID
filedata	Yes	file	Image file
serial	Yes	string	Meeting ID

Get Meeting Document List

URL: https://xx.com/WebAPI/getmeetingfile · Method: GET

Name	Required	Type	Description
key	Yes	string	Enterprise ID
serial	Yes	string	Meeting ID

Get Live Stream

URL: https://xx.com/WebAPI/getLiveStream · Method: GET

Name	Required	Type	Description
key	Yes	string	Enterprise ID
serial	No	string	Meeting ID

Meeting Member Login Records

URL: https://xx.com/WebAPI/getlogininfo · Method: POST

Name	Required	Type	Description
key	Yes	string	Enterprise ID
serial	Yes	string	Meeting ID

URL Join (Multi-Parameter)

URL:

https://xx.com/h5/#/login?serial=123456789&userid=1234&username=name&invisible=1&joinRole=presenter

Method: GET

Name	Required	Type	Description
serial	Yes	string	Meeting ID
userid	Yes	string	Unique user ID
username	Yes	string	Display name
invisible	Yes	string	0 visible, 1 invisible
joinRole	Yes	string	presenter, speaker, or chairman

URL Join (Single Parameter)

URL:

https://xx.com/h5/index.html?token=encrypted-token-string

Method: GET

Token generation (Java):

String param = "{\"serial\":\"111111\",\"userid\":\"123456\",\"username\":\"weiyi我\",\"joinRole\":\"presenter\"}";
// AES-256 encrypt with provided key/iv, URL-encode Base64 result
// See full Java/PHP examples in Chinese doc or contact support for keys

Token generation (PHP):

$arr = array('serial' => '111111', 'userid' => '123456', 'username' => 'weiyi我', "joinRole"=>"presenter");
// AES-256-CBC with provided passkey/passphrase

Full Java and PHP source code is identical to the Chinese version.

Get Recording Files

URL: https://xx.com/WebAPI/getRoomRecord · Method: POST

Name	Required	Type	Description
key	Yes	string	Enterprise ID
serial	No	string	Meeting ID
userid	No	string	Associated user

filepath must be combined with recording server domain and port.

Error Codes

Code	Description
3001	Server expired
3002	Company frozen
3003	Meeting deleted or expired
4001	Company not found
4007	Meeting not found, invalid, or expired
4101	Enterprise ID required
4102	Invalid enterprise ID
4110	Meeting requires password
5205	Display name required
5208	User already logged in
9999	System busy, retry
20001	Use POST request

See Chinese error code reference for the complete list.