创建MR频道

更新时间：2023-12-04 17:25:11

接口描述

1、创建MR频道
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/mr/create

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】

请求体参数描述

参数名	必选	类型	说明
name	true	String	直播名称，最大长度100
categoryId	false	Integer	分类ID
startTime	false	Long	开始时间，13位毫秒级时间戳【注：仅做直播前倒计时显示，不对讲师开播操作产生影响】
channelPasswd	false	String	MR控制台密码，长度6-16位，必须同时包含字母和数字，不传则由系统随机生成
assistantPasswd	false	String	MR直播助理角色密码，长度6-16位，必须同时包含字母和数字，不传则由系统随机生成
splashImg	false	String	引导页图片地址，非保利威域名下的图片需先调用上传频道所有装修图片素材上传
subAccount	false	String	子帐号邮箱，提交后，该频道帐号在后台拥有的权限会跟随该子帐号的频道权限

示例

http://api.polyv.net/live/v4/channel/mr/create?appId=frlr1zazn3&sign=ECFC0A76E357F3EF2D1110BEB92C1045&timestamp=1659063884736

请求体json参数：

{
    "name": "MR直播测试频道",
    "startTime": "1779254040000",
    "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg"
}

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	【详见data字段说明】

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

data参数描述

参数名	类型	说明
channelId	String	频道ID
name	String	频道名称
userId	String	直播账号userId
channelPasswd	String	MR直播-控制台登录密码
assistantAccount	String	MR直播-直播助理账号
assistantPasswd	String	MR直播-直播助理登录密码

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 创建MR频道
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testCreateMrChannel() 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/mr/create";
    
    String name = "MR直播接口测试";
    String categoryId = "391352";
    Long startTime = new Date().getTime() + 30 * 60 * 1000l;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, String> bodyMap = new HashMap<>();
    bodyMap.put("name", name);
    bodyMap.put("categoryId", categoryId);
    bodyMap.put("startTime", String.valueOf(startTime));
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String body = JSON.toJSONString(bodyMap);
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, body, null);
    
    log.info("测试创建MR频道成功：{}", response);
    //do somethings
}

响应示例

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

成功示例（测试示例频道号已隐藏）

{
    "code": 200,
    "status": "success",
    "requestId": "ddf972812a804e0ba9122fd721274592.69.16590638894645319",
    "data": {
        "channelId": ******,
        "name": "MR直播接口测试",
        "userId": "1b448be323",
        "channelPasswd": "9cNkSc",
        "assistantAccount": "0013265559",
        "assistantPasswd": "38kYPY"
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

直播服务端 API