Obtain a license
Description
You can call this method to obtain the license of the audio component.
Request method and endpoint
- Request method: GET
- Request endpoint:
https://auth-api.zego.im?Action=CgiDescribeZIMAudioLicense - Transmission protocol: HTTPS
- QPS limit: 20 calls per second
Request parameters
The following table describes only some common request parameters. For the complete list of common request parameters, see Accessing Server APIs.
Sample request
Untitled
https://auth-api.zego.im?Action=CgiDescribeZIMAudioLicense
&<Common request parameters>
1
Response parameters
| Parameter | Type | Description |
|---|---|---|
| Code | Number | The return code. |
| Message | String | The description of the request result. |
| Data | Object | If the value of the Code is 0, this parameter indicates the license. |
| └License | String | The content of the license, which is valid for seven days. |
Sample response
Untitled
{
"Code": 0,
"Message": "Success.",
"Data": {
"License": "1234567890QWERTYUIOASDFGHJKLZXCVNM"
}
}
1
Return codes
The following table describes only the return codes related to the business logic of the method. For the complete list of return codes, see Return codes.
| Return code | Description | Solution |
|---|---|---|
| 910001 | Invalid parameter. | Check the input parameter. |
| 910002 | Invalid license. | Contact ZEGOCLOUD technical support. |
| 910003 | Internal service error. | Contact ZEGOCLOUD technical support. |
| 910004 | Incorrect license information. | Check the license information in the common request parameters. |