查询优惠券领取列表

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

请求体参数描述

示例

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

响应参数描述

Data参数描述

Contents参数描述

Error参数描述

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 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
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "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
}

异常示例

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