停止任务奖励活动
接口描述
1、提前结束正在进行中的任务奖励活动
2、接口支持https协议
接口URL
https://api.polyv.net/live/v4/channel/task-reward-activity/stop
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
示例
https://api.polyv.net/live/v4/channel/task-reward-activity/stop?activityId=1134&appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB×tamp=1670550787318
响应体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
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 stopTaskRewardTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
Long activityId = 1134;
//业务参数
String url = "https://api.polyv.net/live/v4/channel/task-reward-activity/stop";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("activityId", activityId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试删除任务奖励活动成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
"data": true,
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
Last updated
Was this helpful?