查询频道登记观看设置的字段信息

接口描述

1、获取频道或全局的登记观看字段
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/auth/get-record-field

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名
必选
类型
说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

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

rank

true

Integer

主要观看条件为1,次要观看条件为2

channelId

false

String

频道号,不传为全局获取

示例

http://api.polyv.net/live/v3/channel/auth/get-record-field?appId=frlr1zazn3&sign=A9BFED5A4CD52C57BD0384827628C73C&rank=1&channelId=1965681&timestamp=1621844135149

响应参数描述

参数名
类型
说明

code

Integer

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

status

String

响应状态文本信息

message

String

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

data

Array

请求成功为数据内容,错误为空串 【详见data字段说明

data字段说明

参数名
类型
说明

type

String

登记观看类型 name:姓名 mobile:手机号码 number:数字 option:下拉选择 text:文本

name

String

登记观看信息标题

placeholder

String

登记观看信息描述

options

String

登记观看为下拉选择时的选项,选项值以英文逗号分隔

sms

String

短信验证开关 Y:开 N:关

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(WatchConditionTest.class);
/**
 * 查询频道登记观看设置的字段信息
 * @throws IOException
 */
@Test
public void testGetRecordField() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "1965681";
    String url = "http://api.polyv.net/live/v3/channel/auth/get-record-field";
    String rank = "1";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("rank", rank);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道登记观看设置的字段信息接口返回值:{}",response);
    //do somethings

}

响应示例

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

成功示例

{
	"code": 200,
	"status": "success",
	"message": "",
	"data": [{
		"type": "name",
		"name": "姓名",
		"options": null,
		"placeholder": "请输入姓名",
		"sms": null
	}, {
		"type": "number",
		"name": "年龄",
		"options": null,
		"placeholder": "请输入您的年龄",
		"sms": null
	}, {
		"type": "option",
		"name": "来自何方",
		"options": "大唐,东方",
		"placeholder": "来自哪里呢?",
		"sms": null
	}]
}

异常示例

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

Last updated

Was this helpful?