Submit Winning Information

Updated: 2022-09-02 18:08:07

Interface Description

1、提交中奖者填写的信息
2、只能成功保存一次观众中奖信息
3、中奖信息需在7天内提交保存，否则会失效
4、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/chat/add-receive-info

Online API Call

Request Method

POST

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 details in 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 not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` [See details in Signature Generation Rules]
channelId	true	String	Channel ID
lotteryId	true	String	Lottery session ID. This parameter is obtained from Query Channel Winning Records
winnerCode	true	String	Winning code
viewerId	true	String	Winner ID
name	false	String	Winner's name. If name is provided, the winner's phone number must also be provided. The receiveInfo field should not be passed (invalid).
telephone	false	String	Winner's phone number. If phone number is provided, the winner's name must also be provided. The receiveInfo field should not be passed (invalid).
receiveInfo	false	Array	Custom field data, data type is JSON array. `[{"field":"姓名","value":"测试"},{"field":"手机","value":"13412345678"}]` field: Field name value: Field value. If this parameter is passed, the name and telephone fields should not be passed (invalid).

Example

http://api.polyv.net/live/v3/channel/chat/add-receive-info

Form parameters:

viewerId=1615539698424&appId=frlr1zazn3&name=%E8%82%96&sign=32109698B5CBDF3C833147510533AF6B&telephone=18569550173&channelId=2191532&timestamp=1621843931950&lotteryId=fwnsn85wp7&winnerCode=XQaWEeJS

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. [See details in Global Error Description]
status	String	Response status text information
message	String	Response description message. When code is 400 or 500, it provides auxiliary error reason description.
data	String	Returns "Save successful" on success, returns empty on failure

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. 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 function integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "保存成功"
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

Live Streaming Server API