提交中奖信息
接口描述
1、提交中奖者填写的信息
2、只能成功保存一次观众中奖信息
3、中奖信息需在7天内提交保存,否则会失效
4、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/chat/add-receive-info
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据
【详见签名生成规则】
channelId
true
String
频道号
winnerCode
true
String
中奖码
viewerId
true
String
中奖者ID
name
false
String
中奖者姓名,如果传姓名,必须传中奖者手机号码,receiveInfo字段不需要传(无效)
telephone
false
String
中奖者手机号码,如果传手机号,必须传中奖者姓名,receiveInfo字段不需要传(无效)
receiveInfo
false
Array
自定义字段数据,数据类型为JSON数组
[{"field":"姓名","value":"测试"},{"field":"手机","value":"13412345678"}]
field:字段名称
value:字段值,如果传这个参数,name和telephone字段不需要传(无效)
示例
http://api.polyv.net/live/v3/channel/chat/add-receive-info
表单参数:
viewerId=1615539698424&appId=frlr1zazn3&name=%E8%82%96&sign=32109698B5CBDF3C833147510533AF6B&telephone=18569550173&channelId=2191532×tamp=1621843931950&lotteryId=fwnsn85wp7&winnerCode=XQaWEeJS
响应参数描述
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(LiveInteractionTest.class);
/**
* 提交中奖信息
* @throws IOException
*/
@Test
public void testAddReceiveInfo() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId=super.appId;
String appSecret=super.appSecret;
String userId = super.userId;
String timestamp=String.valueOf(System.currentTimeMillis());
//业务参数
String channelId = "2191532";
String lotteryId = "fwnsn85wp7";
String viewerId = "1615539698424";
String winnerCode = "XQaWEeJS";
String name = "xiao123";
String telephone = "18569550173";
String url = "http://api.polyv.net/live/v3/channel/chat/add-receive-info";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
requestMap.put("viewerId",viewerId);
requestMap.put("lotteryId",lotteryId);
requestMap.put("name",name);
requestMap.put("telephone",telephone);
requestMap.put("winnerCode",winnerCode);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url,requestMap);
log.info("测试提交中奖信息接口返回值:{}",response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": "保存成功"
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Last updated
Was this helpful?