查询邀请海报明细数据

接口描述

1、分页查询邀请海报明细数据统计
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/invite/list

在线API调用

请求方式

GET

接口约束

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

2、开始时间、结束时间的时间跨度最多12个月，默认查询最近12个月数据

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	String	频道号
startTime	false	Long	受邀开始时间，13位毫秒级时间戳
endTime	false	Long	受邀结束时间，13位毫秒级时间戳
pageNumber	false	Integer	当前页数
pageSize	false	Integer	每页数据大小，默认10条数据，最大1000条

示例

http://api.polyv.net/live/v4/channel/invite/list?appId=frlr1zazn3&sign=4C1BD42EA7269623987B3AD78184C5F5&channelId=2272655&timestamp=1652412966735

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	【详见data字段说明】

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

data参数描述

参数名	类型	说明
pageNumber	Integer	当前页码
pageSize	Integer	每页数据量
totalPages	Long	页面总数
totalItems	Long	总数据量
contents	Array	当前页内容【详见contents字段说明】

contents参数描述

参数名	类型	说明
invitee	String	自定义邀请Id（默认为空，需要配置才有值）
openId	String	邀请人微信openId
viewerId	String	邀请人ViewerID
nickname	String	邀请人昵称
avatar	String	邀请人头像url
createdTime	Long	海报生成时间，13位毫秒级时间戳
receiverNickname	String	受邀人昵称
receiverOpenId	String	受邀人微信openId
receiverViewerId	String	受邀人ViewerId
receiverTime	Long	受邀时间，13位毫秒级时间戳
receiverAvatar	String	受邀人头像url

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询邀请海报明细数据统计
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getInviteStatsTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/invite/list";
    String channelId = "2272655";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询邀请海报明细数据统计成功：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "7e1dbcafd52042dba58123f11b82a3be.63.16566368534184845",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 2,
        "contents": [
            {
                "invitee": null,
                "openId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "viewerId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "nickname": "sadboy",
                "createdTime": 1651219412000,
                "receiverNickname": "阿白",
                "receiverOpenId": "ovtl9t71yTtyEsGESz3N4kdp01Hw",
                "receiverViewerId": "ovtl9t71yTtyEsGESz3N4kdp01Hw",
                "receiverTime": 1651219575000,
                "receiverAvatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM7tL1eMbJXrbg64nibHqqJUCde9EzoPXQZhFyf7konCRvdGfpH8vD46pMiaLibStiboJVKbszGoKXhEhA/132",
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM6n3d8AYtzyMiaE1U4fYNAJ7rXJExuB4a2dMweEsPJS4qLcBYK22bXibfa4mJGKSULBKBCMicKJaKtqw/132",
                "TBname": null,
                "TBnumber": null
            },
            {
                "invitee": null,
                "openId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "viewerId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "nickname": "sadboy",
                "createdTime": 1651219412000,
                "receiverNickname": "神经蛙",
                "receiverOpenId": "ovtl9twa7JHyHBBA8QUNVjjM4WIs",
                "receiverViewerId": "ovtl9twa7JHyHBBA8QUNVjjM4WIs",
                "receiverTime": 1651219476000,
                "receiverAvatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM48yCrkV6bNEauNqC60hZJ38eZkVt5YBiasWbq4MA9I5kgs6Oodicc5vpXSICosTibybCT5mgibhIwCNA/132",
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM6n3d8AYtzyMiaE1U4fYNAJ7rXJExuB4a2dMweEsPJS4qLcBYK22bXibfa4mJGKSULBKBCMicKJaKtqw/132",
                "TBname": null,
                "TBnumber": null
            }
        ]
    },
    "success": true
}

异常示例

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