获取邀请员的绑定观众列表
更新时间:2025-06-05 18:34:19
接口描述
1、支持按特定的条件去过滤、获取账号下的邀请员的绑定观众列表
2、接口支持https协议
接口URL
https://api.polyv.net/live/v4/user/invite-sales/follow-viewer/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| inviteCustomerId | false | String | 邀请员用户ID,精准匹配 |
| inviteCustomerNickname | false | String | 邀请员昵称关键字,支持模糊匹配 |
| viewerId | false | String | 观众用户ID,精准匹配 |
| username | false | String | 观众昵称关键字,支持模糊匹配 |
| telephone | false | String | 观众手机号码,精准匹配 |
| followStatusList | false | String | 观众绑定状态列表,多个以英文逗号分隔。0-待跟进;1-已绑定;2-已解绑。 |
| pageSize | false | Integer | 每页记录数(默认10,最大1000) |
| pageNumber | false | Integer | 页码(最大1000页) |
请求示例
https://api.polyv.net/v4/user/invite-sales/follow-viewer/list?appId=xxx×tamp=1670471250000&sign=xxx&telephone=18112345678
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Object | 具体的响应数据【详见data对象说明】 |
| error | Object | 状态码非200时的错误信息【详见error对象说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
data对象说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| pageSize | Integer | 每页记录数 |
| totalPages | Integer | 总页数 |
| totalItems | Integer | 总记录数 |
| contents | Array | 绑定观众信息列表【详见contents对象说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
contents对象说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| inviteCustomerId | String | 邀请员用户ID |
| inviteCustomerNickname | String | 邀请员用户昵称 |
| viewerId | String | 观众用户ID |
| nickname | String | 观众用户昵称 |
| telephone | String | 观众手机号码 |
| followStatus | Integer | 观众绑定状态列表。0-待跟进;1-已绑定;2-已解绑。 |
| followTime | timestamp | 绑定时间,格式为13位时间戳 |
error对象说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
public void test() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String telephone = "18112345678";
String url = "https://api.polyv.net/v4/user/invite-sales/follow-viewer/list";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("telephone", telephone);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("response: {}", response);
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "5b33d00b-d284-4a3d-adcd-38210f8681c8",
"data": {
"pageSize": 5,
"totalPages": 2,
"totalItems": 10,
"contents": [
{
"inviteCustomerId": "6_xxxabc",
"inviteCustomerNickname": "xxxabc",
"viewerId": "6_xxxdef",
"nickname": "xxxdef",
"telephone": "18112345678",
"followStatus": 1,
"followTime": 1746699185000
}
]
},
"success": true
}
失败示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
