Get the Inviter's Bound Viewer List

Interface Description

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

Interface URL

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

Request Method

GET

Interface Constraints

1. The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details

Request Parameter Description

Request Example

https://api.polyv.net/v4/user/invite-sales/follow-viewer/list?appId=xxx&timestamp=1670471250000&sign=xxx&telephone=18112345678

Response Parameter Description

data Object Description

contents Object Description

error Object Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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);
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "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
}

Failure Example

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