Stop Task Reward Activity

Updated: 2024-07-18 09:28:45

Interface Description

1、提前结束正在进行中的任务奖励活动
2、接口支持https协议

Interface URL

https://api.polyv.net/live/v4/channel/task-reward-activity/stop

Request Method

GET

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` [See Signature Generation Rules]
activityId	true	Long	Activity ID

Example

https://api.polyv.net/live/v4/channel/task-reward-activity/stop?activityId=1134&appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Response body JSON:

{
    "code": 200,
    "status": "success",
    "requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
    "data": null,
    "success": true
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result determined by business, returns success on success, error on failure
success	Boolean	Response result determined by business, returns true on success, false on failure
error	Object	Error information when status code is non-200 [See Error Field Description]
requestId	String	Request ID, a unique UUID generated for each request, only for debugging and troubleshooting, not for business logic

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error cause
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
    "data": true,
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}