Get Audience List

Updated: 2024-04-22 19:18:32

API Description

1、分页获取观众列表
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/user/viewer-record/list

Request Method

GET

API Constraints

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

Request Parameters Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details in Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server and retrieve response data.` See details in Signature Generation Rules
source	false	String	Source (IMPORT: imported, WX: WeChat; MOBILE: mobile)
mobile	false	String	Phone number
email	false	String	Email
area	false	String	Address
pageSize	false	String	Page size (default 10, max 1000)
pageNumber	false	Integer	Page number (currently limited to a maximum of 1000 pages)

Request Example

https://api.polyv.net/v4/user/viewer-record/list?appId=frlr1zazn3&timestamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E&mobile=demoData

Response Parameters Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business logic: success returns "success", failure returns "error"
success	Boolean	Response result, determined by business logic: success returns true, failure returns false
data	Object	Paginated user information See details in Data Field Description
error	Object	Error information when status code is non-200 See details in Error Field Description
requestId	String	Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, not for business logic

Data Parameters Description

Parameter	Type	Description
pageSize	Integer	Page size
totalPages	String	Remaining pages
totalItems	Boolean	Remaining records
contents	Array	Audience information list See details in Contents Field Description
requestId	String	Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, not for business logic

Contents Parameters Description

Parameter	Required	Type	Description
viewerUnionId	true	String	Audience ID
wxOpenId	false	String	WeChat OpenId
wxUnionId	false	String	WeChat UnionId
wxNickName	false	String	WeChat nickname
wxAvatar	false	String	WeChat avatar
wxAppId	false	String	WeChat AppId
mobile	false	String	Phone number
source	true	String	User source (IMPORT: imported)
name	false	String	Collected name
lastCollectMobile	false	String	Last collected phone number
email	false	String	Email
area	false	String	Address
latestAccessIp	false	String	Last access IP
device	false	String	Device
watchDuration	false	Integer	Watch duration
watchChannelCount	false	Integer	Number of channels watched
latestAuthTime	true	timestamp	Last authorization time
createTime	true	timestamp	Creation time

Error Parameters Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of the base code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own project. The test cases include HttpUtil.java and LiveSignUtil.java 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.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 删除观众信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getViewerTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    String mobile = "demoData";
    //业务参数
    String url = "https://api.polyv.net/v4/user/viewer-record/list";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("viewerUnionId", viewerUnionId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试删除观众信息成功：{}", response);
    //do somethings
}

Response Example

For global system 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": [
            {
                "name": "demoData",
                "lastCollectMobile": "demoData",
                "email": "demoData",
                "area": "demoData",
                "latestAccessIp": "demoData",
                "device": "demoData",
                "watchDuration": 0,
                "watchChannelCount": 0,
                "viewerUnionId": "2_2v0u6u75hw013ja684ba9co7lnppq4j9",
                "mobile": "demoData9",
                "source": "IMPORT",
                "createTime": 1712114619000
            },
            {
                "name": "demoData",
                "lastCollectMobile": "demoData",
                "email": "demoData",
                "area": "demoData",
                "latestAccessIp": "demoData",
                "device": "demoData",
                "watchDuration": 0,
                "watchChannelCount": 0,
                "viewerUnionId": "2_x4r3er86b6h539o4clna3ss39xg3c169",
                "mobile": "demoData8",
                "source": "IMPORT",
                "createTime": 1712114608000
            },
            {
                "name": "demoData",
                "lastCollectMobile": "demoData",
                "email": "demoData",
                "area": "demoData",
                "latestAccessIp": "demoData",
                "device": "demoData",
                "watchDuration": 0,
                "watchChannelCount": 0,
                "viewerUnionId": "2_9965885141of3ec157yq69yf75xrt108",
                "mobile": "demoData7",
                "source": "IMPORT",
                "createTime": 1712114586000
            },
            {
                "name": "demoData",
                "lastCollectMobile": "demoData",
                "email": "demoData",
                "area": "demoData",
                "latestAccessIp": "demoData",
                "device": "demoData",
                "watchDuration": 0,
                "watchChannelCount": 0,
                "viewerUnionId": "2_2g0be0h9p6cd0777zq022yvze4a968bk",
                "mobile": "demoData6",
                "source": "IMPORT",
                "createTime": 1712114565000
            },
            {
                "name": "demoData",
                "lastCollectMobile": "demoData",
                "email": "demoData",
                "area": "demoData",
                "latestAccessIp": "demoData",
                "device": "demoData",
                "watchDuration": 0,
                "watchChannelCount": 0,
                "viewerUnionId": "2_y5t681288v0316n8z932el5d28w1ka2n",
                "mobile": "demoData5",
                "source": "IMPORT",
                "createTime": 1712114550000
            }
        ]
    },
    "success": true
}

Error Example

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

Live Streaming Server API