Send Popup Message at Stream Start

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

API Description

1、用于直播中，给开播讲师以弹窗形式发送特定消息的能力（当前仅支持给讲师触发）
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/chat/alert-to-special

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API 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
channelId	true	String	Channel ID
message	true	String	Message description Length must be >= 1 and <= 500
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 never be 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
timestamp	true	String	Current 13-digit millisecond timestamp, valid for 3 minutes
title	true	String	Title Length must be >= 1 and <= 100

Example

http://api.polyv.net/live/v4/chat/alert-to-special?appId=frlr1zazn3&sign=4F16189E140DEAB547A5105093037D6B&message=%E6%88%91%E5%8F%91%E4%B8%AA%E5%BC%B9%E7%AA%97%E6%B5%8B%E8%AF%95%E6%B6%88%E6%81%AF&title=%E8%AD%A6%E5%91%8A&channelId=4231598&timestamp=1693878611630

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 for a 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, used only 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 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, 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 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());
/**
* 提示特殊身份
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void chatAlertToSpecialTest() 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/alert-to-special";
    String channelId = "4231598";
    String message = "我发个弹窗测试消息";
    String title = "警告";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    requestMap.put("message", message);
    requestMap.put("timestamp", timestamp);
    requestMap.put("title", title);
    
    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

Success Example

{
  "code": 200,
  "status": "success",
  "requestId": "33fffbb646604f8a997724714b56ef1e.70.16938786176400585",
  "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