Set Channel Virtual User Count

Updated: 2022-09-23 10:07:04

API Description

1、设置频道虚拟人数
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/robot/setting/update

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client. 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	true	String	Channel ID
robotNumber	true	Integer	Virtual user count displayed in the chat room
addRobotModel	true	String	User count display mode timely: Takes effect immediately fixed_time: Takes effect over a scheduled period
changeTime	false	Integer	Effective time, required when addRobotModel is fixed_time. Unit: seconds. Minimum: 20 (20 seconds), Maximum: 18000 (300 minutes)
virtualBookingNumber	false	Integer	Virtual booking count

Example

http://api.polyv.net/live/v4/channel/robot/setting/update?virtualBookingNumber=100&robotNumber=500&appId=frlr1zazn3&sign=DA900BC65A31EEA40F5CE9FAF22805E0&addRobotModel=timely&channelId=3335806&timestamp=1662690079780

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, should not be tied to business logic
error	Object	Error information when status code is not 200 [See Error Field Description]
data	Object	Returns null on successful response

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponds to error.code

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 设置频道虚拟人数
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateRobotSettingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/robot/setting/update";
    String channelId = "3335806";
    String robotNumber = "500";
    String addRobotModel = "timely";
    String virtualBookingNumber = "100";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("robotNumber", robotNumber);
    requestMap.put("addRobotModel", addRobotModel);
    requestMap.put("virtualBookingNumber", virtualBookingNumber);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);
    
    log.info("测试设置频道虚拟人数成功：{}", response);
    //do somethings
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "61b9319c9e3b42979f8a152dfa6b3f40.73.16626900842179815",
    "data": null,
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.117.16360830583026105",
    "error": {
        "code": 30004,
        "desc": "找不到频道"
    },
    "success": false
}

Live Streaming Server API