观众提交任务奖励表单
更新时间:2025-04-08 10:44:36
接口描述
1、观众提交任务奖励表单
2、接口支持https协议
接口URL
https://api.polyv.net/live/v4/user/viewer-task-reward/submit-accept-info
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
请求体参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| id | true | Long | 记录ID |
| viewerId | true | String | 观众ID |
| formInfo | true | Array | 表单信息 【详见formInfo字段说明】 |
formInfo参数描述
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| type | String | true | 类型, userName:姓名、userPhone:手机号、custom:自定义 |
| field | String | true | 字段名 |
| value | String | true | 填写内容 |
示例
https://api.polyv.net/live/v4/user/viewer-task-reward/submit-accept-info?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB×tamp=1670550787318
请求体json参数:
{
"id": 1693913,
"viewerId": "2_844u9odbkqq8eum0rpotqbexwqlio6pq",
"formInfo": [
{
"type": "userName",
"field": "姓名",
"value": "1e0zj"
},
{
"type": "userPhone",
"field": "手机",
"value": "88888888888"
}
]
}
响应体json:
{
"code": 200,
"status": "success",
"requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
"data": null,
"success": true
}
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Long | 任务奖励活动id |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
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 submitAcceptInfoTest() 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/viewer-task-reward/submit-accept-info";
//业务参数
String postJson = "{"id":1693913,"viewerId":"2_844u9odbkqq8eum0rpotqbexwqlio6pq","formInfo":[{"type":"userName","field":"姓名","tips":"请输入您的名称","required":true,"value":"1e0zj"}]}";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, postJson, null);
log.info("测试提交任务奖励领取表单结果:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
"data": 10465,
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
