修改主播

接口描述

1、修改主播
2、接口支持https协议

接口URL

https://api.polyv.net/live/v4/channel/anchor/update

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名
必选
类型
说明

appId

true

String

timestamp

true

Long

当前13位毫秒级时间戳，3分钟内有效

sign

true

String

请求体参数描述

参数名
必选
类型
说明

anchorId

true

Long

主播ID

nickname

false

String

昵称，最多20个字符

sex

false

String

性别，M-男，W-女

avatar

false

String

头像，最多255个字符

description

false

String

简介，最多150个字符

addChannelIds

false

Array

新增关联的频道ID列表，最多1000个

delChannelIds

false

Array

删除关联的频道ID列表，最多1000个, 直播中的频道不能删除关联

示例

https://api.polyv.net/live/v4/channel/anchor/update?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

请求体json参数：

{
    "anchorId":1,
    "nickname": "1号主播",
    "sex":"W",
    "avatar":"https://liveimages.videocc.net/uploaded/images/2024/04/gvh9eybcbb.png",
    "description":"主播简介，我是一名大主播",
    "addChannelIds":[10001],
    "delChannelIds":[10001]
}

响应参数描述

参数名
类型
说明

code

Integer

响应状态码，200为成功返回，非200为失败

status

String

响应结果，由业务决定，成功返回success，失败返回error

success

Boolean

响应结果，由业务决定，成功返回true，失败返回false

data

Object

标签数据 【[Data字段说明](#Data 参数描述)】

error

Object

requestId

String

请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

Data参数描述

参数名
类型
说明

Error参数描述

参数名
类型
说明

code

Integer

错误代码，用于确定具体的错误原因

desc

String

错误描述，与 error.code 对应

Java请求示例

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

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

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 修改主播
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateChannelAnchorTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/channel/anchor/update";
    Long anchorId = 1L;
    String nickname = "1号主播";
  	String sex = "w";
    String avatar = "https://liveimages.videocc.net/uploaded/images/2024/04/gvh9eybcbb.png";
    String description = "主播简介，我是一名大主播";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("anchorId", anchorId);
    jsonMap.put("nickname", nickname);
    jsonMap.put("sex", sex);
    jsonMap.put("avatar", avatar);
    jsonMap.put("description", description);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试修改主播结果：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "success": true,
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
Previous修改主播状态NextSM2加密说明

Last updated

Was this helpful?