發送審核通過的聊天訊息

更新時間：2023-04-04 09:31:23

介面說明

1、发送审核通过的聊天消息
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/chat/message/audit

請求方式

POST

介面限制

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

請求參數說明

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

請求體參數說明

參數名	必選	類型	說明
msgId	true	String	自訂的msgId，不超過32個字元
viewerId	true	String	觀眾id，不超過64個字元
nickName	true	String	觀眾暱稱，不超過128個字元
content	true	String	訊息內容content，不超過2000個字元
avatar	false	String	觀眾頭像連結，不超過200個字元；若不傳入該欄位，viewerId對應觀眾線上時使用用戶頭像，否則使用預設頭像
sessionId	false	String	場次id
viewerType	false	String	觀眾類型， viewer：觀眾，student：學生，slice：雲課堂學員

範例

http://api.polyv.net/live/v4/chat/message/audit?appId=fxlwyesvqd&sign=942AC99EACD1D11FF35E480414403EB0&timestamp=1680162971000&channelId=3808479

請求體json參數：

[
    {
        "msgId":"msg-1",
        "content":"我发送了一条消息",
        "viewerId":"sadboy",
        "nickName":"polyv"
    }
]

回應參數說明

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

Data參數說明

參數名	類型	說明
id	String	保利威聊天室訊息id
msg	String	錯誤或正常的提示，如：發送成功
msgId	String	外部訊息Id，即請求參數中的msgId
status	Boolean	發言是否成功，true：成功，false：失敗

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 messageAuditTest() 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/message/audit";
    String channelId = "1965681";
    
    //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);
    
    Map<String, String> jsonMap = new HashMap<>();
    jsonMap.put("msgId","msg-1");
    jsonMap.put("content","我发送了一条消息");
    jsonMap.put("viewerId","sadboy");
    jsonMap.put("nickName","polyv");
    List<Map<String, String>> list = new ArrayList<>();
    list.add(jsonMap);
    
    String response = HttpUtil.postJsonBody(url,JSON.toJSONString(list),null);
    
    log.info("测试审核通过聊天信息成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "807edf69deb540cd8b1f7a8b0e2dc883.64.16801629319610385",
    "data": [
        {
            "msgId": "123",
            "id": "3ec969a0-ced0-11ed-87bd-6de896f75816",
            "status": true,
            "msg": "发送成功"
        }
    ],
    "success": true
}

異常範例

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