Query Channel Announcement List

Updated: 2026-07-13 11:57:31

API Description

1、查询频道公告列表

2、接口支持https协议

API URL

http://api.polyv.net/live/v4/chat/list-bullentin

Online API Call

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 Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: Get Secret Key
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 stored or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See details: Signature Generation Rules
channelId	true	String	Channel ID
pageNumber	true	Integer	Current page number
pageSize	true	Integer	Page size
sort	false	String	Sort by creation time: createTime:asc (ascending), createTime:desc (descending)

Example

http://api.polyv.net/live/v4/chat/list-bullentin?channelId=${channelId}&pageNumber=1&pageSize=10&appId=${your_appId}&sign=${your_sign}

Response Parameter Description

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

Data Parameter Description

Parameter	Type	Description
pageSize	Integer	Number of items per page
pageNumber	Integer	Current page number
totalItems	Integer	Total number of items
totalPages	Integer	Total number of pages
contents	Array	Query result list See details: Contents Parameter Description

Contents Parameter Description

Parameter	Type	Description
id	Long	Announcement ID
content	String	Announcement content
isTop	Integer	Whether pinned: 0-No, 1-Yes
isPop	Integer	Whether popup: 0-No, 1-Yes
canClose	Integer	Whether closable: 0-No, 1-Yes
createTime	Long	Creation time
nick	String	User nickname
pic	String	User avatar

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. 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 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());
    Integer pageNumber = 1;
    Integer pageSize = 10;
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/chat/list-bullentin";
    String channelId = "4146015";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    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 error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "07fbdd94-75a2-46db-9cb1-8c4de3b05403",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 2,
        "contents": [
            {
                "id": 11005,
                "content": "<p>2222</p>",
                "isTop": 1,
                "isPop": 1,
                "canClose": 1,
                "createTime": 1722846090778
            },
            {
                "id": 11006,
                "content": "<p>22222</p>",
                "isTop": 0,
                "isPop": 1,
                "canClose": 1,
                "createTime": 1722852910187
            }
        ]
    },
    "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