创建单个角色

接口描述

1、创建频道的助教或嘉宾角色
   助教：使用助教管理后台，能够观看直播、参与互动、进行聊天室管理，发送图文直播，监控直播等操作
   嘉宾：讲师和嘉宾可同时讲一堂课，支持连麦互动
2、接口URL中的{channelId}为频道号
3、接口支持https协议

接口URL

http://api.polyv.net/live/v2/channelAccount/{channelId}/add

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、每个直播频道最多可以创建150个助教，嘉宾最大数量为16

3、创建嘉宾需要设置频道连麦人数，开启连麦功能

请求参数描述

示例

http://api.polyv.net/live/v2/channelAccount/2191541/add

表单参数：

actor=%E5%8A%A9%E6%95%99&role=Assistant&appId=frlr1zazn3&nickname=%E5%88%98%E8%80%81%E5%B8%88&sign=F9953D904B2177872672A693F53D86EB&avatar=https%3A%2F%2Fs1.videocc.net%2Fdefault-img%2Favatar%2Fassistant.png&timestamp=1621841707106

响应参数描述

data字段描述

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 创建角色
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testAddAccount() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v2/channelAccount/%s/add";
    String channelId = "2149813";
    String role = "Assistant";
    String nickname = "刘老师";
    String actor = "助教";
    String avatar = "https://s1.videocc.net/default-img/avatar/assistant.png";

    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("role", role);
    requestMap.put("nickname", nickname);
    requestMap.put("actor", actor);
    requestMap.put("avatar", avatar);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试创建角色，返回值：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "account":"0072149710",
        "userId":"1b448be323",
        "channelId":2149710,
        "passwd":"xxxxxx",
        "nickname":"赵老师",
        "stream":"km1fvuo3",
        "status":"Y",
        "createdTime":1615259640000,
        "lastModified":1615259640000,
        "channelSessionId":null,
        "sort":7,
        "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"
    }
}

异常示例

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