分页查询邀请海报邀请数据
更新时间：2022-09-02 18:08:07
接口描述
1、分页查询邀请海报邀请数据
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/statistics/inviter-poster/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳，3分钟内有效 |
| sign | true | String | 签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
| pageNumber | false | Integer | 页数默认为1 |
| pageSize | false | Integer | 每页显示的数据条数，默认每页显示10条数据 |
| startTime | false | Long | 受邀开始时间，支持到时分秒，13位毫秒级时间戳 |
| endTime | false | Long | 受邀结束时间，支持到时分秒，13位毫秒级时间戳 |
示例
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| 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参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| openId | String | 邀请人微信openId |
| viewerId | String | 邀请人Id |
| nickname | String | 邀请人昵称 |
| createdTime | Long | 邀请海报生成时间，13位毫秒级时间戳 |
| receiverOpenId | String | 受邀人微信openId |
| receiverViewerId | String | 受邀人Id |
| receiverNickname | String | 受邀人昵称 |
| receiverTime | Long | 受邀时间，13位毫秒级时间戳 |
| param4 | String | 用户自定义参数param4 |
| param5 | String | 用户自定义参数param5 |
Java请求示例
快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
响应示例
系统全局错误说明详见全局错误说明
成功示例
异常示例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
