Query Coupon Claim List

Updated: 2025-06-10 11:15:38

API Description

1、查询优惠券领取列表
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/user/coupon/search-viewer

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API 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 for 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 the customer's own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
pageNumber	false	Integer	Page number, defaults to 1
pageSize	false	Integer	Number of data items per page, defaults to 10, maximum cannot exceed 1000
couponId	true	String	Coupon ID
keyword	false	String	Search keyword, exact match for viewer ID, fuzzy match for viewer nickname
receiveSource	false	String	Claim channel: CHANNEL - Channel, AGGREGATE_PAGE - Aggregate Page

Request Body Parameter Description

Parameter	Required	Type	Description

Example

https://api.polyv.net/live/v4/user/coupon/search-viewer?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318&pageNumber=1&pageSize=10&couponId=caqfi6rqutunvofor5jrqbinswh14p2g

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, returns success for success, error for failure
success	Boolean	Response result, determined by business logic, returns true for success, false for failure
data	Object	Tag data [See Data Field Description](#Data Parameter Description)
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 troubleshooting and debugging, should not be tied to business logic

Data Parameter Description

Parameter	Type	Description
pageNumber	Integer	Current page number
pageSize	Integer	Number of items per page
totalPages	Long	Total number of pages
totalItems	Long	Total number of items
contents	Array	Current page content See contents field description

Contents Parameter Description

Parameter	Type	Description
viewerId	String	Viewer ID
nickname	String	Viewer nickname
mobile	String	Phone number
avatar	String	Avatar
receiveSource	String	Claim channel: CHANNEL - Channel, AGGREGATE_PAGE - Aggregate Page
receiveTime	Long	Claim time

Error Parameter Description

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

Java Request Example

For quick integration of the base code, please download the related dependency source code. Click to download 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 to implement API functionality. The Live Java SDK provides unified packaging 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 listCouponTest() 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/coupon/search-viewer";
    Integer pageNumber = 1;
    Integer pageSize = 10;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.get(url, null);
    
    log.info("测试查询优惠券领取列表结果：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "data": {
        "contents": [
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783281000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783276000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783249000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783245000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783186000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783185000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            }
        ],
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 6,
        "totalPages": 1
    },
    "requestId": "bbcbf92c-e5ca-487a-adc3-eb184f1b3b6c",
    "status": "success",
    "success": true
}

Error Example

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

Live Streaming Server API