查询全局回调设置

接口描述

1、查询全局回调设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/global-setting/callback/get

在线API调用

请求方式

GET

接口约束

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

请求参数描述

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

示例

http://api.polyv.net/live/v4/user/global-setting/callback/get?appId=frlr1zazn3&sign=4A5B12ECA5142FB85E12A8DE9BF7DE71&timestamp=1657851977367

响应参数描述

参数名	类型	说明
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参数描述

参数名	类型	说明
recordCallbackUrl	String	录制生成回调URL
recordFileCallBackType	String	回调录制文件类型 all：全部回放视频 last：最终回放视频
recordCallbackVideoType	String	回调文件类型 m3u8：m3u8文件 mp4：mp4文件 m3u8,mp4：m3u8和mp4文件
playbackCallbackUrl	String	转存成功回调URL
rebirthVodCallbackEnabled	String	重制课件转存点播回调开关 Y：开启 N：关闭
pptRecordCallbackUrl	String	课件重制成功回调URL
streamCallbackUrl	String	直播状态改变回调URL
channelBasicUpdateCallbackUrl	String	频道直播间信息修改回调URL
liveScanCallbackUrl	String	直播内容审核不通过回调URL
chatUserStatusCallbackUrl	String	直播间人员状态回调URL
interactionCallbackUrl	String	互动功能回调URL
playbackCacheCallbackUrl	String	直播回放缓存生成回调通知URL
playbackSettingCallbackUrl	String	回放设置回调URL

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(UserTest.class);
/**
 * 查询全局回调设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getCallbackTest() 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/user/global-setting/callback/get";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询全局回调设置成功：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "8acd0194a7b6459a8ab168fcf2b63153.64.16578519813679255",
    "data": {
        "recordCallbackUrl": "http://www.abc.com/callback",
        "recordFileCallBackType": "all",
        "recordCallbackVideoType": "m3u8,mp4",
        "playbackCallbackUrl": "http://www.abc.com/callback",
        "rebirthVodCallbackEnabled": "Y",
        "pptRecordCallbackUrl": "",
        "streamCallbackUrl": "http://www.abc.com/callback",
        "channelBasicUpdateCallbackUrl": "",
        "liveScanCallbackUrl": "",
        "chatUserStatusCallbackUrl": "",
        "interactionCallbackUrl": "",
        "playbackCacheEnabled": "N",
        "chatUserStatusCallbackEnabled": "Y",
        "playbackCacheCallbackUrl": "",
        "playbackSettingCallbackUrl": null
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}