Create Role

Legacy API endpoint Create Single Role (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/create

Online API Call

Request Method

POST

API Constraints

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

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

3. Each live channel can create up to 150 assistants, with a maximum of 16 guests.

4. Creating a guest requires setting the channel's co-streaming participant count and enabling the co-streaming feature.

Request Parameter Description

Request Body Parameter Description

purviewList Parameter Description

Example

http://api.polyv.net/live/v4/channel/account/create?appId=frlr1zazn3&sign=02BBB29D3C5FE62157E6E0ED2AB5D844&channelId=2824409&timestamp=1648778488853

Request body JSON parameters:

{
    "actor": "助教sadboy",
    "role": "Assistant",
    "passwd": "test123456",
    "nickName": "昵称sadboy",
    "avatar": "https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png",
    "purviewList": [
        {
            "code": "chatListEnabled",
            "enabled": "N"
        },
        {
            "code": "monitorEnabled",
            "enabled": "Y"
        }]
}

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. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the downloaded 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 testAddChannelAccount() 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/create";
    String channelId = "2824409";
    String role = "Assistant";
    String actor = "助教sadboy";
    String nickName = "昵称sadboy";
    String avatar = "https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png";
    String passwd = "test123456";
    
    //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", "N");
    purviewList.add(purviewMap1);
    Map<String, String> purviewMap2 = new HashMap<>();
    purviewMap2.put("code", "monitorEnabled");
    purviewMap2.put("enabled", "Y");
    purviewList.add(purviewMap2);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("role", role);
    jsonMap.put("actor", actor);
    jsonMap.put("nickName", nickName);
    jsonMap.put("avatar", avatar);
    jsonMap.put("passwd", passwd);
    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.65.16487784917647731",
    "data":
    {
        "account": "0062824409",
        "userId": "1b448be323",
        "channelId": 2824409,
        "passwd": "test123456",
        "nickname": "昵称sadboy",
        "stream": "l1fs56ih",
        "status": "Y",
        "createdTime": 1648778491961,
        "lastModified": 1648778491961,
        "sort": 6,
        "avatar": "//liveimages.videocc.net/uploaded/images/2022/04/g8fydrvq5l.png",
        "actor": "助教sadboy",
        "pageTurnEnabled": null,
        "notifyEnabled": "Y",
        "checkinEnabled": "Y",
        "voteEnabled": "Y",
        "lotteryEnabled": "Y",
        "chatListEnabled": "N",
        "chatAuditEnabled": null,
        "monitorEnabled": "Y",
        "roundTourEnabled": null,
        "watchLockEnabled": null,
        "role": "Assistant"
    },
    "success": true
}

Error Example

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