保利威文档中心

幫助中心

查詢子帳號頻道列表

更新時間:2026-07-13 11:57:31

介面描述

1、查询子账号频道列表

2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/channel-user-children/get-channels

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true String 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
childUserId true String 子帳號使用者ID
startTime false Long 頻道建立時間-起始範圍
endTime false Long 頻道建立時間-結束範圍
pageNumber true Integer 當前頁碼
pageSize true Integer 分頁大小

範例

http://api.polyv.net/live/v4/channel/channel-user-children/get-channels?childUserId=${childUserId}&pageNumber=1&pageSize=10&appId=${your_appId}&sign=${your_sign}

回應參數描述

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

Data參數描述

參數名 類型 說明
pageSize Integer 每頁資料大小
pageNumber Integer 當前頁數
totalItems Integer 總筆數
totalPages Integer 總頁數
contents List 查詢的結果列表【詳見Contents參數描述

Contents參數描述

參數名 類型 說明
channelId Integer 頻道ID
organizationId String 組織架構ID
createdTime Integer 建立時間

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 noticeCleanTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    Integer pageNumber = 1;
    Integer pageSize = 10;
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/channel-user-children/get-channels";
    String childUserId = "xx";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("childUserId", channelId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    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": "b85a17e1-a894-432c-a086-12ba3a6ee320",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 2,
        "contents": [
            {
                "channelId": 3729186,
                "organizationId": "1886",
                "createdTime": 1675062332000
            },
            {
                "channelId": 5052255,
                "organizationId": "1894",
                "createdTime": 1722828648000
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询