發送開播端彈窗訊息

更新時間：2023-11-13 10:28:42

介面描述

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

介面URL

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

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
channelId	true	String	頻道號
message	true	String	訊息說明長度大於等於1，長度小於等於500
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
timestamp	true	String	當前13位毫秒級時間戳，3分鐘內有效
title	true	String	標題長度大於等於1，長度小於等於100

範例

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

回應參數描述

參數名	類型	說明
code	Integer	狀態碼，與 http 狀態碼相同，用於確定基本的回應狀態
data	Boolean	成功回應的資料
error	Object	狀態碼非200時的錯誤資訊【詳見Error參數描述】
requestId	String	請求ID，每次請求產生的唯一 UUID，僅可用於排查、除錯，不應該和業務掛鉤
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

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
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "33fffbb646604f8a997724714b56ef1e.70.16938786176400585",
  "data": true,
  "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}