Concise description
- This interface is a direct jump interface for entering the application, used in conjunction with the A tag, and does not return a message code
Request URL
{{adminHost:8181}}webclient
Request Method
- get
Request Query Parameters
| Field Name | Sample | Required | Type | Note |
|---|---|---|---|---|
| appliId | Yes | string | Application ID | |
| endDate | No | string | The scheduled end time is a millisecond timestamp | |
| clientMac | No | string | Mac address for glasses client (required for glasses client, otherwise monitoring data will not be displayed) | |
| groupId | No | string | Group ID, used for server/client group management | |
| regionId | No | string | The data center partition ID is generally used to prioritize the use of server nodes in the specified partition by clients after partition testing, and cannot be specified at the same time as groupId. | |
| taskId | No | string | The task ID for running the application instance | |
| playerMode | No | string | Startup mode: 0-Normal mode, 1-Demonstration mode (one person operates for multiple people to watch), 2-Interactive mode (keyboard and mouse release, application cooperation required) | |
| userType | No | string | User category in demonstration/interactive mode, 1-Task owner (controller), 0-Participant | |
| nickname | No | string | User’s nickname in demonstration/interactive mode | |
| authCode | No | string | The room password in demonstration/interactive mode is unique; the access password for private applications is not unique. | |
| codeRate | No | string | bit rate | |
| frameRate | No | string | Frame rate | |
| audioCodeRate | No | string | Audio encoding rate | |
| preferDecoder | No | string | The decoding format that the client prioritizes, which can be passed as’ auto ‘,’ vp8 ‘,’ vp9 ‘,’ h264 ‘,’ h265 ‘,’ hevc ‘,’ av1 ‘,’ av1x ‘ | |
| shareId | No | string | Share link ID | |
| extraParam. XXX | No | string | Additional parameters passed to cloud applications, with a total length of 7000 characters or less. These parameters can be directly obtained through command line parameters in the application. Please refer to Example 2 for details. | |
| wsId | No | string | The workspace ID, which must be passed when encrypting the workspace to which the application belongs. | |
| timestamp | No | string | Timestamp (ms), which must be passed when encrypting the working interval to which the application belongs. | |
| signature | No | string | Signature, this parameter must be passed when encrypting the working interval to which the application belongs. |
Success Response Example
//Reference Example 1
<a href=“ http://192.168.0.55:8181/webclient?appliId=879408743551336448&codeRate=8000&frameRate=30 "Target=" _blank ">
<button>Enter the application</button>
</a>
//Reference Example 2 (Additional Parameters)
1) Default parameter transmission [zhangsan 12 1200439309006536704] URL appends the&cmdLineParamStyle=0 parameter or does not append the&cmdLineParamStyle parameter
Http://[Server IP]: 8181/webclient? AppliId=[application id]&extraParam. userName=zhangsan&extraParam. age=12&extraParam. cmdLineParamStyle=0
2) Default pass parameter [-- cmdLineParamStyle=1-- userName=zhangsan -- age=12-- taskId=124039309006536704] URL append&cmdLineParamStyle=1 parameter
Http://[Server IP]: 8181/webclient? AppliId=[application id]&extraParam. userName=zhangsan&extraParam. age=12&extraParam. cmdLineParamStyle=1
3) Default pass parameter [- cmdLineParamStyle 2- userName zhangsan - age 12- taskId 1200439309006536704] URL add&cmdLineParamStyle=2 parameter
Http://[Server IP]: 8181/webclient? AppliId=[application id]&extraParam. userName=zhangsan&extraParam. age=12&extraParam. cmdLineParamStyle=1
//Reference Example 3 (Demonstration/Interactive Mode)
1) Password mode
Generate AuthCode
Presenter: http://192.168.0.55:8181/webclient?appliId=879408743551336448playerMode=1&userType=1&authCode=888888
Viewers (Participants): http://192.168.0.55:8181/appli/start?appliId=879408743551336448&playerMode=1&userType=0&authCode=888888
2) TaskId mode (the participant's taskId is the taskId generated by the presenter after entering the application)
Presenter: http://192.168.0.55:8181/webclient?appliId=879408743551336448&playerMode=1&userType=1
Viewers (Participants): http://192.168.0.55:8181/webclient?appliId=879408743551336448&playerMode=1&userType=0&taskId=733006441014624256
Demonstration/interactive mode using workspace encryption access
Demonstrator: It is necessary to enter the application within the validity period of the key;
Add parameters after Url:&wsId=77Ekeapp×tamp=1594804883818&signature=EA4A9425AE1BBBB52FEEC27B4A478E268466D3E
Viewers (participants): There is no need to be within the validity period of the key, as long as the presenter has not logged out of the application, they can enter the application at any time;
Add parameters after connection:&wsId=77Ekeapp×tamp=1594804883818&signature=EA4A9425AE1BBBB52FEEC27B4A478E268466D3E
Note
Please refer to getSignature for the generation of signatures