Viewer Submit Task Reward Form

Updated: 2025-04-08 10:44:36

API Description

1、观众提交任务奖励表单
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/user/viewer-task-reward/submit-accept-info

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining the 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 and retrieve responses.` See signature generation rules

Request Body Parameter Description

Parameter	Required	Type	Description
id	true	Long	Record ID
viewerId	true	String	Viewer ID
formInfo	true	Array	Form information See formInfo field description

formInfo Parameter Description

Parameter	Type	Required	Description
type	String	true	Type: userName (name), userPhone (phone number), custom (custom)
field	String	true	Field name
value	String	true	Filled content

Example

https://api.polyv.net/live/v4/user/viewer-task-reward/submit-accept-info?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Request body JSON parameters:

{
    "id": 1693913,
    "viewerId": "2_844u9odbkqq8eum0rpotqbexwqlio6pq",
    "formInfo": [
        {
            "type": "userName",
            "field": "姓名",
            "value": "1e0zj"
        },
        {
            "type": "userPhone",
            "field": "手机",
            "value": "88888888888"
        }
    ]
}

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 logic: success returns "success", failure returns "error"
success	Boolean	Response result, determined by business logic: success returns true, failure returns false
data	Long	Task reward activity ID
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, used only for troubleshooting and debugging, not for business logic

Error Parameter Description

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

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained 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 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
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

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

Error Example

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