查询邀请海报排行
更新时间：2022-09-08 17:08:27
接口描述
1、查询邀请海报排行
2、接口支持https协议
接口URL
请求方式
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 | 频道号 |
示例
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码，与 http 状态码相同，用于确定基本的响应状态 |
| status | String | 响应结果，由业务决定，成功返回success，失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |
| error | Object | 状态码非200时的错误信息【详见Error字段描述】 |
| data | Array | 【详见data字段说明】 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码，用于确定具体的错误原因 |
| desc | String | 错误描述，与 error.code 对应 |
data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| openId | String | 微信openId |
| nickname | String | 昵称 |
| avatar | String | 头像url |
| inviteNum | Integer | 邀请人数 |
| rank | Integer | 邀请排名 |
Java请求示例
快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "7e1dbcafd52042dba58123f11b82a3be.63.16566368534184845",
"data": [
{
"inviteNum": 3,
"openId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
"nickname": "sadboy",
"avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM6n3d8AYtzyMiaE1U4fYNAJ7rXJExuB4a2dMweEsPJS4qLcBYK22bXibfa4mJGKSULBKBCMicKJaKtqw/132",
"rank": 1
},
{
"inviteNum": 1,
"openId": "YWmwEacgMPEuG39HKZEK1Ao3IZHw",
"nickname": "sadman",
"avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM6n3d8AYtzyMiaE1U4fYNAJ7rXJExuB4a2dMweEsPJS4qLcBYK22bXibfa4mJGKSULBKBCMicKJaKtqw/132",
"rank": 2
}
],
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
