Concise description
- Called when starting the application, accessed immediately after obtaining the URL, and the link timeout expired after 20 seconds
Request URL
{{adminHost:8181}}/appli/getStartURL
Request Method
- get
Request Query Parameters
| Field Name | Sample | Required | Type | Note |
|---|---|---|---|---|
| appliId | 1199762458126843904 | 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
{
"code": 1000,
"message": "",
"result": "/webclient/?appliId=1199762458126843904&appliType=2&taskId=1201901299344343040&taskStatus=1&codeRate=15000&frameRate=60&audioCodeRate=32&preferDecoder=h264&useWebCodec=0&renderServerIp=192.168.0.28&renderServerPort=10002&renderSSLServerPort=10004&preferPublicIp=&serverId=c255ced0be4451c5ba5524b926a53816&wsProxy=0&initWinSize=0&initResolutionType=0&initCursorMode=0&fullScreenMode=0&mobileFullScreenMode=0&mobileForceLandscape=1&mobileVirtualJoystick=1&useGamepad=0&mouseZoomDirection=1&playerListToggle=1&noOperationTimeout=0&touchOperateMode=mouse&vrControllerType=0&logLevel=warn&rttLimit=80&rttLimitInterval=30&appliName=test33&wsId=Jx3wQMD1&language=zh-CN&random=1706597200142"
}
Failure Response Example
{
"code": 500,
"message": "appliId is not null"
}
Note
After obtaining the results, it is necessary to concatenate the domain name of the front-end page for use. You can directly open the URL. It should be noted that the connection is valid for 20 seconds