Release Announcement

Updated: 2026-02-27 09:50:47

API Description

1、发布频道公告

2、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API 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 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 stored or 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	String	Channel ID
content	true	String	Announcement content
isTop	false	String	Whether to pin, values: Y/N, default N
isPop	false	String	Whether to pop up, values: Y/N, default N

Example

http://api.polyv.net/live/v4/chat/add-bullentin?channelId=${channelId}&content=${content}&isTop=Y&isPop=Y&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	Boolean	Data on 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 for troubleshooting and debugging, not to be tied to business logic
status	String	Response result, determined by business logic: returns success on success, error on failure
success	Boolean	Whether the response was successful

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error cause
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 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 functionality integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 发布公告
 */
@Test
public void noticeAddTest() 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/add-bullentin";
    String channelId = "xxx"; //频道号，必填
    String content = "测试发布公告";
    String isTop = "Y";
    String isPop = "Y";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    requestMap.put("content", content);
    requestMap.put("isTop", isTop);
    requestMap.put("isPop", isPop);
    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 something
}

Response Example

For global system error descriptions, see Global Error Description

Successful Example

{
    "code": 200,
    "status": "success",
    "requestId": "2d865261-f86a-4bba-8d26-3a1a1751fbf7",
    "data": true,
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "2d865261-f86a-4bba-8d26-3a1a1751fbf7",
    "error": {
        "code": 10001,
        "desc": "isTop值不正确"
    },
    "data": null,
    "success": false
}

Live Streaming Server API