Batch Create Roles

API Description

1、批量创建角色，角色包括Guest(嘉宾)、Assistant(助教)
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/account/batch-create

Online API Call

Request Method

POST

API Constraints

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

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

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

Request Parameters Description

Request Body Parameters Description

Example

http://api.polyv.net/live/v3/channel/account/batch-create?appId=frlr1zazn3&sign=7D0C4520C6968C948EFA7B5B912FB979&channelId=2191569&timestamp=1621841813383

Request Body Parameters

[{
        "role": "Guest",
        "nickname": "嘉宾",
        "passwd": 123456
    },
    {
        "role": "Assistant",
        "nickname": "助教",
        "passwd": 123456
    }
]

Response Parameters Description

Data Parameter Description

Java Request Example

For quick integration, 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 case files HttpUtil.java and LiveSignUtil.java are included in the download package.

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 testBatchCreate() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url="http://api.polyv.net/live/v3/channel/account/batch-create";
    String channelId="2191569";

    //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 json = "[{\"role\":\"Guest\",\"nickname\":\"嘉宾\",\"passwd\":123456},{\"role\":\"Assistant\",\"nickname\":\"助教\",\"passwd\":123456}]";
    url = HttpUtil.appendUrl(url,requestMap);
    String response= HttpUtil.postJsonBody(url,json,null);
    log.info("测试批量创建角色，返回值：{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "account":"0052191569",
            "userId":"1b448be323",
            "channelId":2191569,
            "passwd":"******",
            "nickname":"嘉宾",
            "stream":"kmd6qbz0",
            "status":"Y",
            "createdTime":1615969860000,
            "lastModified":1615969860000,
            "channelSessionId":null,
            "sort":5,
            "avatar":"//s1.videocc.net/default-img/avatar/guest.png",
            "actor":"嘉宾",
            "pageTurnEnabled":"N",
            "notifyEnabled":"N",
            "checkinEnabled":"Y",
            "voteEnabled":"N",
            "lotteryEnabled":"N",
            "role":"Guest",
            "chatListEnabled":"Y",
            "chatAuditEnabled":"N",
            "monitorEnabled":"N",
            "roundTourEnabled":"N",
            "watchLockEnabled":"N",
            "loginUrl":null
        },
        {
            "account":"0062191569",
            "userId":"1b448be323",
            "channelId":2191569,
            "passwd":"******",
            "nickname":"助教",
            "stream":"kmd6qbz3",
            "status":"Y",
            "createdTime":1615969860000,
            "lastModified":1615969860000,
            "channelSessionId":null,
            "sort":6,
            "avatar":"//s1.videocc.net/default-img/avatar/assistant.png",
            "actor":"助教",
            "pageTurnEnabled":"N",
            "notifyEnabled":"Y",
            "checkinEnabled":"Y",
            "voteEnabled":"Y",
            "lotteryEnabled":"Y",
            "role":"Assistant",
            "chatListEnabled":"Y",
            "chatAuditEnabled":"N",
            "monitorEnabled":"N",
            "roundTourEnabled":"N",
            "watchLockEnabled":"N",
            "loginUrl":null
        }
    ]
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}