删除单个白名单
接口描述
1、删除单个白名单
2、(channelId, timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
接口URL
https://api.polyv.net/meet/v1/channel/auth-whitelist/delete
请求方式
POST
接口约束
1、接口调用有频率限制,详细请查看
请求参数描述
请求体参数描述
参数名
必选
类型
说明
code
true
String
需要删除的白名单,长度不超过64位
示例
https://api.polyv.net/meet/v1/channel/auth-whitelist/delete?appId=fyirmfdak4×tamp=1657786379352&sign=CEA301164F9BA5076F156C1EB60F22F8&channelId=3220878
请求体参数
{
"code": "111"
}
响应参数描述
参数名
类型
说明
code
Integer
状态码,与 http 状态码相同,用于确定基本的响应状态
status
String
响应结果,由业务决定,成功返回success,失败返回error
success
Boolean
是否成功响应
requestId
String
请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
data
String
成功时为true,错误时为空
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(WhitelistDelete.class);
/**
* 删除单个白名单
* @throws IOException
*/
@Test
public void testWhitelistDelete() 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/meet/v1/channel/auth-whitelist/delete";
String channelId = "2191532";
String body = "{\n" +
" \"code\": \"111\"\n" +
"}";
//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);
String response = HttpUtil.postJsonBody(url, body, null);
log.info("测试删除单个白名单接口返回值:{}",response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": true
}
异常示例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
{
"code": 403,
"status": "error",
"error": {
"code": 10002,
"desc": "签名错误"
},
"success": false
}
{
"code": 400,
"status": "error",
"requestId": "20e774c2414447fe9d44801ff92a7d39.69.16655431425530263",
"error": {
"code": 30005,
"desc": "非法频道ID: 3344784"
},
"success": false
}
{
"code": 400,
"status": "error",
"requestId": "8640ff25366e4776a9b3ebf84bf8e302.61.16655432357454531",
"error": {
"code": 10001,
"desc": "会员码不能为空"
},
"data": null,
"success": false
}
Last updated
Was this helpful?