保利威文档中心

幫助中心

查詢頻道圖文直播內容

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

介面描述

1、查询频道图文直播内容
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/watch/tuwen/list

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名生成規則
channelId true String 頻道號
id false Integer 圖文內容的序號:為空表示取得第一頁資料,且同時會回傳置頂資料。非空表示取得 id 比該值小的記錄(也就是更早發布的內容),此時不回傳置頂列表。
imageMode false String 是否為圖片模式,預設為N
Y:圖片模式
N:文字加圖片的模式

範例

https://api.polyv.net/live/v3/channel/watch/tuwen/list?appId=frlr1zazn3&sign=9E82CCD014CBBBE72EC6306D05A331E3&imageMode=N&channelId=2149710&timestamp=1621842666131

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功回傳,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 成功回應時為回放詳情分頁資料 【詳見data欄位說明

data欄位說明

參數名 類型 說明
total Integer 總的回傳結果筆數
contents Array 回傳的圖文列表內容 【詳見contents欄位說明
topContents Array 置頂的圖文資訊 【詳見topContents欄位說明
setting Object 圖文直播相關設定資訊 【詳見setting欄位說明

contents欄位說明

參數名 類型 說明
id Integer 圖文內容序號,可用於查詢條件參數id
channelId String 頻道號
text String 文字內容
images Array 圖片地址,格式:["http://liveimages.net//chat.jpeg","http://liveimages.net//chat2.jpeg"]
top String 是否置頂
Y:是
N:否
createdTime Integer 內容發送的時間,13位的時間戳

topContents欄位說明

參數名 類型 說明
id Integer 圖文內容序號,可用於查詢條件參數id
channelId String 頻道號
text String 文字內容
images Array 圖片地址,格式:["http://liveimages.net//chat.jpeg","http://liveimages.net//chat2.jpeg"]
top String 是否置頂
Y:是
N:否
createdTime Long 內容發送的時間,13位的時間戳

setting欄位說明

參數名 類型 說明
nickname String 操作人的暱稱
actor String 操作人的頭銜
avatar String 操作人的頭像

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(MenuTest.class);
/**
 * 查询频道图文直播内容
 * @throws IOException
 */
@Test
public void testTuwenList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/watch/tuwen/list";
    String channelId = "2149710";
    String imageMode = "N";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("imageMode",imageMode);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试查询频道图文直播内容接口返回值:{}",response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "total": 4,
        "contents": [{
            "id": 114225,
            "channelId": 2149710,
            "text": "<p>图片测试2</p>",
            "images": ["http://liveimages.videocc.net/uploadimage/20210309/chat_img_2149710_16152571693814.jpeg"],
            "top": "N",
            "createdTime": 1615257175000
        }, {
            "id": 114223,
            "channelId": 2149710,
            "text": "<p>加图片测试</p>",
            "images": ["http://liveimages.videocc.net/uploadimage/20210309/chat_img_2149710_16152570796353.jpeg"],
            "top": "N",
            "createdTime": 1615257089000
        }],
        "topContents": [],
        "setting": {
            "id": 109036,
            "nickname": "请问123",
            "actor": "主持人",
            "avatar": "//liveimages.videocc.net/assets/wimages/pc_images/logo.png"
        }
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询