Get Tag List

Updated: 2025-01-10 13:31:38

API Description

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

API URL

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

Request Method

GET

API Constraints

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

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
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 used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server and retrieve responses.` See signature generation rules
keyword	false	String	Tag
pageSize	false	String	Page size (default 10, max 1000)
pageNumber	false	Integer	Page number (currently limited to a max of 1000 pages)

Request Example

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

Response Parameters

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result determined by business logic, returns success on success, error on failure
success	Boolean	Response result determined by business logic, returns true on success, false on failure
data	Object	Paginated user information See Data field description
error	Object	Error information when status code is non-200 See 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 Parameter Description

Parameter	Type	Description
pageSize	Integer	Page size
totalPages	String	Remaining pages
totalItems	Boolean	Remaining record count
contents	Array	Audience information list See contents field description

Contents Parameter Description

Parameter	Required	Type	Description
id	true	String	Tag ID
label	true	String	Tag

Error Parameter 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, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download 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 getLabelTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    String label = "demoData";
    //业务参数
    String url = "https://api.polyv.net/live/v4/user/viewer-label/list";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("keyword", label);
    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": [
            {
                "id": 1,
                "label": "demoData"
            },
            {
                "id": 2,
                "label": "demoData2"
            }
        ]
    },
    "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