批量修改分分发地址
更新时间:2023-04-04 09:31:23
接口描述
1、修改分发地址
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/channel/distribute/update-batch
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、分发推流中不可修改推流地址
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
请求体参数描述
| 类型 | 必选 | 说明 |
|---|---|---|
| Array | true | 修改分发地址请求对象列表【详见contents字段说明】 |
contents参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| id | true | String | 云分发ID |
| name | false | String | 分发地址名称,长度不能超过20 |
| distributeUrl | false | String | 推流地址,例:rtmp://polyv.net,必须以 rtmp://、http://、https:// 开头 |
| distributeLiveCode | false | String | 直播码 |
示例
http://api.polyv.net/live/v4/channel/distribute/update-batch?appId=frlr1zazn3&sign=849D052FC630787418BC1645CA17E2A7&channelId=2272655×tamp=1639732654073
请求体json参数:
[
{
"distributeUrl": "rtmp://xxx.xxxx.xxx",
"distributeLiveCode": "testupdate",
"name": "测试修改云分发",
"id": "3159"
}
]
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Boolean | 成功返回true |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 批量修改分分发地址
* @throws IOException
*/
@Test
public void updateBatch() 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/v4/channel/distribute/update-batch";
String channelId = "2272655";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
List<Map<String, String>> bodyList = new ArrayList<>();
Map<String, String> bodyMap = new HashMap<>();
bodyMap.put("id", "3159");
bodyMap.put("name", "测试修改云分发");
bodyMap.put("distributeUrl", "rtmp://xxx.xxxx.xxx");
bodyMap.put("distributeLiveCode", "testupdate");
bodyList.add(bodyMap);
String body = JSON.toJSONString(bodyList);
String response = HttpUtil.postJsonBody(url, body, null);
log.info("测试批量修改分分发地址,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "e2e23029f14a46098842dde4d8f097b4.1943.16397326579270169",
"data": true,
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
