Set Channel Virtual User Count
Updated: 2022-09-02 18:08:07
Interface URL
https://api.polyv.net/live/v3/channel/basic/update-rebot-setting
Interface Description
1、接口用于设置频道虚拟人数信息
2、接口支持https
Supported Format
JSON
Request Method
POST
Request Limit
TRUE
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | Yes | string | Obtained from API settings, the appId registered in the live streaming system |
| timestamp | Yes | long | Current 13-digit millisecond timestamp |
| sign | Yes | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data. See signature generation rules |
| channelId | Yes | int | Channel ID |
| robotNumber | Yes | int | Virtual user count, minimum 0, maximum 2999 |
| robotNumberTimes | No | int | Virtual user count multiplier, default 1, minimum 1, maximum 20 |
| addRobotModel | Yes | string | Virtual user display mode: timely (immediate effect) or fixed_time (time-distributed effect) |
| changeTime | No | int | Time interval for distributing virtual audience addition, in milliseconds. Valid when addRobotModel is timely. Default 20000, minimum 20000, maximum 1800000 |
Successful Response JSON Example:
{
"code": 200,
"status": "success",
"message": "",
"data": null
}
Response Field Description
| Parameter | Description |
|---|---|
| code | Status code: 200 for success, 403 for signature failure, 400 for parameter error, 500 for server error |
| status | success for success, error for error |
| message | Empty string for success, error description for failure |
| data | Response data |
Failed Response JSON Example:
Parameter error
{
"code": 400,
"status": "error",
"message": "param validate error",
"data": ""
}
Missing appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
Incorrect appId
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
Timestamp error
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
Signature error
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Invalid channel ID
{
"code": 403,
"status": "error",
"message": "illegal channel id: %s",
"data": ""
}
Java Request Example
public void testAddRecordTask() {
String url = "https://api.polyv.net/live/v3/channel/basic/update-rebot-setting";
// appId和加密串
String appId = "xxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxx";
Map<String, String> params = new HashMap<>();
params.put("channelId", "2180007");
params.put("robotNumber", "10");
params.put("addRobotModel", "fixed_time");
params.put("changeTime", "30000");
// 调用Polyv的工具类方法设置sign
PolyvTool.setLiveSign(params, appId, appSecret);
String content = HttpClientUtil.getInstance()
.sendHttpPost(url, params);
System.out.println(content);
}
