非同步下載聊天記錄介面

更新時間：2022-09-02 18:08:07

介面URL

http://api.polyv.net/live/v3/channel/chat/content/create-task

介面說明

1、异步下载聊天室聊天记录接口
2、如果异步下载成功，返回下载地址，下载地址有效期一天
2、接口支持https

支援格式

JSON

請求方式

POST

請求數限制

TRUE

請求參數

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

回應成功JSON範例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
       "status": "done",
       "url": "https://doc-oss.polyv.net/chat/export/xls/130760/130760_1597804097778.xls",
       "lastExportTime": 1597804097778
    }
}

回應失敗JSON範例：

未輸入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

簽名錯誤

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

欄位說明

參數名	類型	說明
code	int	回應代碼，成功為200，失敗為400，簽名錯誤為401，異常錯誤500
status	string	成功為success，失敗為error
message	string	錯誤時為錯誤提示訊息
data	object	回應結果集
status	string	非同步下載狀態 todo:待下載 done:已完成 doing:下載中
url	string	下載位址
lastExportTime	long	最後一次下載的時間，單位：毫秒

Java請求範例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/chat/content/create-task";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", "0000000");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, params);
        System.out.println(content);
    }