Modify Role Audience Settings

Updated: 2024-07-29 17:24:49

API Description

1、修改角色观众设置信息
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/account/viewer/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 saved 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

Request Body Parameter Description

Parameter	Required	Type	Description
actor	false	String	Title
actorEnabled	false	String	Title toggle, Y to enable, N to disable
questionStudentTitle	false	String	Question area label title
questionStudentTitleEnabled	false	String	Question area label toggle, Y to enable, N to disable

Example

http://api.polyv.net/live/v4/channel/account/viewer/update?appId=frlr1zazn3&sign=417802BACAD3375E72CA1A53848E0A53&channelId=2824409&timestamp=1648779734640

Request body JSON parameters:

{
  "actor": "头衔",
  "actorEnabled": "Y",
  "questionStudentTitle": "提问区标签标题",
  "questionStudentTitleEnabled": "Y"
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by 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 for troubleshooting and debugging, not for business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	Response content returned on success

Error Parameter Description

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

Java Request Example

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 更新角色观众设置信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateChannelAccountViewer() 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/account/viewer/update";
    String channelId = "2824409";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("actor", "学生");
    jsonMap.put("questionStudentTitle", "学生");
    jsonMap.put("actorEnabled", "Y");
    jsonMap.put("questionStudentTitleEnabled", "N");
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    log.info("测试更新角色观众设置信息成功：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
  "code": 200,
  "status": "success",
  "requestId": "089f1962c0c64e15b1c0619f36133092.77.17222399456840137",
  "data": null,
  "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