# 批量创建角色 ### 接口描述 ``` 1、批量创建角色，角色包括Guest(嘉宾)、Assistant(助教) 2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】 3、接口支持https协议 ``` ### 接口URL ``` http://api.polyv.net/live/v3/channel/account/batch-create ``` [在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/account/batch-create/README.md) ### 请求方式 ``` POST ``` ### 接口约束 1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md) 2、每个直播频道最多可以创建150个助教，嘉宾最大数量为16 3、创建嘉宾需要设置频道连麦人数，开启连麦功能 ### 请求参数描述 | 参数名 | 必选 | 类型 | 说明 | | --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appId | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】 | | timestamp | true | Long | 当前13位毫秒级时间戳，3分钟内有效 | | sign | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 | | channelId | true | String | 频道号 | ### 请求体参数描述 | 参数名 | 必选 | 类型 | 说明 | | -------- | ----- | ------ | ----------------------------------------------- | | passwd | true | String | 角色密码 | | role | false | String |

角色类型，默认为助教，
Assistant：助教，
Guest：嘉宾

| | nickname | false | String | 创建的助教或嘉宾昵称 | | actor | false | String | 创建的助教或嘉宾头衔 | | avatar | false | String | 创建的助教或嘉宾头像 | ### 示例 ```requestUrl http://api.polyv.net/live/v3/channel/account/batch-create?appId=frlr1zazn3&sign=7D0C4520C6968C948EFA7B5B912FB979&channelId=2191569×tamp=1621841813383 ``` 请求体参数 ```json [{ "role": "Guest", "nickname": "嘉宾", "passwd": 123456 }, { "role": "Assistant", "nickname": "助教", "passwd": 123456 } ] ``` ### 响应参数描述 | 参数名 | 类型 | 说明 | | ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | code | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】 | | status | String | 响应状态文本信息 | | message | String | 响应描述信息，当code为400或者500的时候，辅助描述错误原因 | | data | Array | 响应成功时返回角色信息【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/channel/operate/batch_create.md?id=polyv1)】 | **Data参数描述** | 参数名 | 类型 | 说明 | | ---------------- | ------- | ---------------------------------------- | | account | String | 助教/嘉宾账号 | | userId | String | POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置） | | channelId | String | 频道号 | | passwd | String | 角色密码 | | nickname | String | 角色名称 | | stream | String | 角色流名（单独使用无效） | | status | String | 角色状态 | | createdTime | Long | 创建角色时间，13位毫秒级时间戳 | | lastModified | Long | 角色最后修改时间，13位毫秒级时间戳 | | channelSessionId | String | 场次号 | | sort | Integer | 频道角色序号 | | avatar | String | 角色头像 | | actor | String | 创建的助教或嘉宾头衔 | | pageTurnEnabled | String |

助教翻页权限（只能一个助教有）
Y：开启
N：关闭

| | notifyEnabled | String |

发布公告权限
Y：开启
N：关闭

| | checkinEnabled | String |

开启签到权限
Y：开启
N：关闭

| | voteEnabled | String |

发起投票权限
Y：开启
N：关闭

| | lotteryEnabled | String |

是否拥有抽奖权限
Y：开启
N：关闭

| | role | String |

角色
Assistant：助教
Guest：嘉宾

| | chatListEnabled | String |

助教页在线列表显示开关
Y：开启
N：关闭

| | chatAuditEnabled | String |

助教聊天审核权限
Y：开启
N：关闭

| | monitorEnabled | String |

监播权限开关
Y：开启
N：关闭

| | roundTourEnabled | String |

助教轮巡权限开关
Y：开启
N：关闭

| | watchLockEnabled | String |

锁定直播间权限
Y：开启
N：关闭

| | loginUrl | String | 子账号（嘉宾）登录地址 | ### Java请求示例 快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。 > 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。 ```java 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 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 } ``` ### 响应示例 系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md) 成功示例 ```json { "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 } ] } ``` 异常示例 ```json { "code": 400, "status": "error", "message": "invalid signature.", "data": "" } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://polyv.gitbook.io/document/docs/live/api/channel/operate/batch_create.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.