Delete Tag Information

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

API Description

1、删除标签信息
2、接口支持https协议

API URL

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

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls are subject to rate limits. See details

Request Parameter Description

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 not be used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See signature generation rules
id	true	String	Tag ID

Example

https://api.polyv.net/live/v4/user/viewer-label/delete?appId=frlr1zazn3&timestamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E&id=1

Response Parameter Description

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
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, only for troubleshooting and debugging, should not be tied to business logic

Error Parameter Description

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

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 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 deleteLabelTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    Long id = 1L;
    //业务参数
    String url = "https://api.polyv.net/live/v4/user/viewer-label/delete";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("id", id);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试删除观众信息成功：{}", response);
    //do somethings
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "7bd56e99-3705-4bb0-9834-a0201eebcc4a",
    "data": null,
    "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