Add Viewer to Blacklist

Updated: 2024-09-05 17:26:45

API Description

1、黑名单添加观众
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/lottery-viewer-list/blacklist/create

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have rate limits. See details
Incorrect parameters will result in a 400 error response.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret 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]
channelId	true	Integer	Channel ID

Request Body Parameter Description

Parameter	Required	Type	Description
viewerIds	true	Array	Array of viewer IDs

Example

http://api.polyv.net/live/v4/channel/lottery-viewer-list/blacklist/create?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=4619012

Request body JSON parameters:

{
    "viewerIds": [
        "16",
        "17",
        "18"
    ]
}

Response Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic. Returns "success" on success, "error" on failure
success	Boolean	Whether the request was successful
requestId	String	Request ID, a unique UUID generated for each request. Used only for troubleshooting and debugging, not for business logic
error	Object	Error information when status code is not 200 [See Error Field Description]
data	Array	Detailed response data [See Data Field Description]

Error Response Description

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

Data Response Description

Parameter	Type	Description
id	Long	Primary key ID
viewerId	String	Viewer ID

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 blacklistAdd() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
        
    String url = "http://api.polyv.net/live/v4/channel/lottery-viewer-list/blacklist/create";
    //业务参数
    Integer channelId = 5004544;
    List<String> viewerIds = Arrays.asList("16", "17", "18");
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
        
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("viewerIds", viewerIds);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试黑名单添加观众结果：{}", response);
    //do somethings
    
}

Response Example

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

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "10b563c9-ce1f-4e5b-a959-64665af484bb",
    "data": [
        {
            "id": 439714,
            "groupId": 677,
            "viewerId": "16",
            "createTime": 1725518428600
        },
        {
            "id": 439715,
            "groupId": 677,
            "viewerId": "17",
            "createTime": 1725518428600
        },
        {
            "id": 439716,
            "groupId": 677,
            "viewerId": "18",
            "createTime": 1725518428600
        }
    ],
    "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