Query Channel Virtual Audience Settings

Updated: 2022-09-15 09:50:53

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to rate 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 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 and obtain response data.` See Signature Generation Rules
channelId	true	String	Channel ID

Example

http://api.polyv.net/live/v4/channel/robot/setting/get?appId=frlr1zazn3&sign=ACD429EFC4656840A64039FF2CF79776&channelId=3335806&timestamp=1662688925470

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, not tied to business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	See data Field Description

Error Parameter Description

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

data Parameter Description

Parameter	Type	Description
channelId	Integer	Channel ID
robotNumber	Integer	Virtual audience count displayed in the chat room
addRobotModel	String	Audience display mode timely: Takes effect immediately fixed_time: Takes effect at a scheduled time
virtualBookingNumber	Integer	Virtual booking count
changeTime	Integer	Effective time, in milliseconds
leftTime	Long	Time remaining until the next setting can be made, in milliseconds

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 code 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 getRobotSettingTest() 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/get";
    String channelId = "3335806";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询频道虚拟人数设置成功：{}", response);
    //do somethings
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "61b9319c9e3b42979f8a152dfa6b3f40.71.16626889287143865",
    "data": {
        "channelId": 3335806,
        "robotNumber": 100,
        "addRobotModel": "fixed_time",
        "virtualBookingNumber": 30,
        "changeTime": 20000,
        "leftTime": 0
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API