Modify Role Information

Legacy API endpoint Modify Role Information (Legacy)

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/update

Online API Call

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

2. Monitor, page turn, and online list permissions cannot be set simultaneously.

Request Parameter Description

Request Body Parameter Description

purviewList Parameter Description

Example

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

Request body JSON parameters:

{
    "account": "0062824409",
    "nickName": "测试修改昵称",
    "purviewList": [
        {
            "code": "chatListEnabled",
            "enabled": "Y"
        },
        {
            "code": "pageTurnEnabled",
            "enabled": "Y"
        },
        {
            "code": "monitorEnabled",
            "enabled": "N"
        }]
}

Response Parameter Description

Error Parameter Description

data Parameter Description

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. HttpUtil.java and LiveSignUtil.java from 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 packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 更新角色信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateChannelAccount() 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/update";
    String channelId = "2824409";
    String account = "0062824409";
    String nickName = "测试修改昵称";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    List<Map<String, String>> purviewList = new ArrayList<>();
    Map<String, String> purviewMap1 = new HashMap<>();
    purviewMap1.put("code", "chatListEnabled");
    purviewMap1.put("enabled", "Y");
    purviewList.add(purviewMap1);
    Map<String, String> purviewMap2 = new HashMap<>();
    purviewMap2.put("code", "pageTurnEnabled");
    purviewMap2.put("enabled", "Y");
    purviewList.add(purviewMap2);
    Map<String, String> purviewMap3 = new HashMap<>();
    purviewMap3.put("code", "monitorEnabled");
    purviewMap3.put("enabled", "N");
    purviewList.add(purviewMap3);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("account", account);
    jsonMap.put("nickName", nickName);
    jsonMap.put("purviewList", purviewList);
    
    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": "86d11d4aa00b49f5993ac0891e670470.59.16487797376158117",
    "data":
    {
        "account": "0062824409",
        "userId": "1b448be323",
        "channelId": 2824409,
        "passwd": "test123456",
        "nickname": "测试修改昵称",
        "stream": "l1fs56ih",
        "status": "Y",
        "createdTime": 1648778492000,
        "lastModified": 1648779737622,
        "sort": 6,
        "avatar": "//liveimages.videocc.net/uploaded/images/2022/04/g8fydrvq5l.png",
        "actor": "助教sadboy",
        "pageTurnEnabled": "Y",
        "notifyEnabled": "Y",
        "checkinEnabled": "Y",
        "voteEnabled": "Y",
        "lotteryEnabled": "Y",
        "chatListEnabled": "Y",
        "chatAuditEnabled": "N",
        "monitorEnabled": "N",
        "roundTourEnabled": "N",
        "watchLockEnabled": "N",
        "role": "Assistant"
    },
    "success": true
}

Error Example

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