Clear Channel Announcement

Updated: 2023-11-13 10:28:42

Interface Description

1、清空频道公告信息

2、接口支持https协议

Interface URL

http://api.polyv.net/live/v4/chat/notice/clean

Online API Call

Request Method

POST

Interface Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	String	Current 13-digit millisecond timestamp, valid for 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 saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	String	Channel ID

Example

http://api.polyv.net/live/v4/chat/notice/clean?appId=frlr1zazn3&sign=3B091ECFAEDF00CE09D26F1591799D47&channelId=4146015&timestamp=1691718460028

Response Parameter Description

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

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponding 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 code project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the download file.

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 清空频道公告信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void noticeCleanTest() 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/chat/notice/clean";
    String channelId = "4146015";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    requestMap.put("timestamp", timestamp);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);

    log.info("测试清空频道公告信息成功：{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Successful Example

{
    "code": 200,
    "status": "success",
    "requestId": "6d6cec17186b4b61825f2170b882746a.2468.16917184638912553",
    "data": true,
    "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