获取邀请员列表

更新时间：2025-06-05 18:34:19

接口描述

1、支持按特定的条件去过滤、获取账号下的邀请员列表
2、接口支持https协议

接口URL

https://api.polyv.net/live/v4/user/invite-sales/list

请求方式

GET

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
viewerUnionId	false	String	邀请员用户ID，精准匹配
mobile	false	String	邀请员手机号码，精准匹配
keyword	false	String	邀请员用户昵称关键字，支持模糊匹配
organizationId	false	Integer	邀请员所属组织ID
pageSize	false	Integer	每页记录数（默认10，最大1000）
pageNumber	false	Integer	页码（最大1000页）

请求示例

https://api.polyv.net/v4/user/invite-sales/list?appId=xxx&timestamp=1670471250000&sign=xxx&mobile=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对象说明

留意：

如果所查询的组织中有邀请员管理员，则会将该管理员置顶在第一页数据的开头。此时，第一页的记录数会比常规的“每页记录数”多出一条记录。
如果未指定、传递“邀请员所属组织”参数，则默认置顶“总部”的管理员（如果有的话）。

字段名	类型	说明
viewerUnionId	String	用户ID
nickname	String	用户昵称
wxNickName	String	微信昵称
wxAvatar	String	微信头像
mobile	String	手机号码
inviteSalesSource	String	来源。console-后台添加；apply-招募；api-外部导入。
inviteSalesGrantedTime	timestamp	加入时间，格式为13位时间戳
organizationId	Integer	所属组织ID
organizationName	String	所属组织名称
inviteSalesAdmin	String	是否为邀请员管理员，Y/N
customerNum	Integer	绑定观众数

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 mobile = "18112345678";
    
    String url = "https://api.polyv.net/v4/user/invite-sales/list";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("mobile", mobile);
    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": [
            {
                "viewerUnionId": "6_xxx",
                "nickname": "广州观众",
                "wxNickName": null,
                "wxAvatar": null,
                "mobile": "18112345678",
                "inviteSalesSource": "apply",
                "inviteSalesGrantedTime": 1744795084000,
                "organizationId": 123,
                "organizationName": "总部",
                "inviteSalesAdmin": "Y",
                "customerNum": 10,
            }
        ]
    },
    "success": true
}

失败示例

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

直播服务端 API