修改角色信息

更新时间：2023-03-29 14:41:14

接口描述

1、修改助教或嘉宾的信息
2、接口URL中的{channelId}为频道号
3、接口支持https协议

接口URL

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

请求方式

POST

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
account	true	String	助教/嘉宾账号（不能以数字类型提交，否则可能去掉角色号前的00）
nickname	false	String	角色昵称
password	false	String	角色密码
avatar	false	String	角色头像链接，不超过200个字符长度，超过将返回400异常
actor	false	String	角色头衔
pageTurnEnabled	false	String	角色翻页权限，只能一个角色有，仅支持三分屏场景 Y：开启 N：关闭
notifyEnabled	false	String	角色公告权限 Y：开启 N：关闭

示例

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

表单参数：

actor=%E5%8A%A9%E6%95%99&password=123456&pageTurnEnabled=Y&notifyEnabled=Y&appId=frlr1zazn3&nickname=%E9%99%88%E8%80%81%E5%B8%88&sign=08B5096C4EBA19C10750D4570004C9E1&avatar=https%3A%2F%2Fs1.videocc.net%2Fdefault-img%2Favatar%2Fassistant.png&account=0052191541&timestamp=1621841976967

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	请求成功时为success，请求失败为空字符串

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 testUpdateAccount() 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/update";
    String channelId = "2149710";
    String account = "0062149710";
    String nickname = "王老师";
    String password = getRandomString(10);
    String avatar = "https://s1.videocc.net/default-img/avatar/assistant.png";
    String actor = "助教";
    String pageTurnEnabled = "Y";
    String notifyEnabled = "Y";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("account", account);
    requestMap.put("nickname", nickname);
    requestMap.put("password", password);
    requestMap.put("avatar", avatar);
    requestMap.put("actor", actor);
    requestMap.put("pageTurnEnabled", pageTurnEnabled);
    requestMap.put("notifyEnabled", notifyEnabled);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置角色信息，返回值：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"success"
}

异常示例

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

直播服务端 API