分页查询自定义字段
接口描述
1、分页查询自定义字段
2、接口支持https协议
接口URL
https://api.polyv.net/live/v4/user/custom-field/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
示例
https://api.polyv.net/live/v4/user/custom-field/list?appId=frlr1zazn3×tamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E
响应参数描述
Error参数描述
参数名
类型
说明
code
Integer
错误代码,用于确定具体的错误原因
desc
String
错误描述,与 error.code 对应
data 数组参数描述
参数名
类型
说明
customFieldId
String
自定义字段ID
customFieldName
String
自定义字段名称
customFieldType
String
自定义字段类型
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 getLabelPageTest() 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/user/custom-field/list";
//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": "e4faf1183b2c4ff493e6aeb192209b25.72.16994949189217641",
"data": [
{
"customFieldId": "PAY_STATUS",
"customFieldName": "支付状态",
"customFieldType": "text"
}
],
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
Last updated
Was this helpful?