修改录制生成回调设置

接口描述

1、设置账号下录制视频通知回调地址的接口
2、接口URL中的{userId}为 直播账号ID
3、接口支持https协议

接口URL

http://api.polyv.net/live/v2/user/{userId}/set-record-callback

在线API调用

请求方式

POST

接口约束

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

2、不提交地址参数url,则回调地址为空,表示关闭回调功能,如果要提交的地址参数url,必须以 http:// 或者 https:// 开头

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

url

false

String

回调地址url,不提交表示关闭回调功能,如果提交,必须以 http:// 或者 https:// 开头

示例

http://api.polyv.net/live/v2/user/1b448be323/set-record-callback

表单参数:

appId=frlr1zazn3&sign=C053105ED7B70B302EA05C4DC0C3C364&callback=http%3A%2F%2Fwww.baidu.com&timestamp=1636447896021

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

String

响应成功或失败都返回空字符串

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 设置录制回调通知url
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetRecordCallback() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/user/%s/set-record-callback", userId);
    String callBack = "http://www.baidu.com";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("url", callBack);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置录制回调通知url,返回值:{}", response);
    //do somethings

}

响应示例

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

成功示例

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

异常示例

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

Last updated