查詢主播已關聯的頻道

更新時間：2024-11-18 17:57:00

接口描述

1、查询主播频道关联关系
2、接口支持https协议

接口URL

https://api.polyv.net/live/v4/channel/anchor/list-relation

線上API呼叫

請求方式

GET

接口約束

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名生成規則】
pageNumber	false	Integer	頁數預設為1
pageSize	false	Integer	每頁顯示的資料筆數，預設每頁顯示10筆資料，最大值不能超過1000
anchorId	true	Long	主播ID

請求體參數描述

參數名	必選	類型	說明

範例

https://api.polyv.net/live/v4/channel/anchor/list-relation?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318&pageNumber=1&pageSize=10&anchorId=1

請求體json參數：

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗
status	String	回應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	回應結果，由業務決定，成功返回true，失敗返回false
data	Object	標籤資料【[Data欄位說明](#Data 參數描述)】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求生成的唯一的 UUID，僅可用於排查、除錯，不應該和業務掛上鉤

Data參數描述

參數名	類型	說明
pageNumber	Integer	當前頁碼
pageSize	Integer	每頁資料量
totalPages	Long	頁面總數
totalItems	Long	總資料量
contents	Array	當前頁內容【詳見contents欄位說明】

Contents參數描述

參數名	類型	說明
channelId	Long	頻道號
name	String	直播名稱

Error參數描述

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

Java請求範例

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

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

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询主播频道关联关系
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void listChannelAnchorRelationTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/channel/anchor/list-relation";
    Integer pageNumber = 1;
    Integer pageSize = 10;
    Long anchorId = 1L;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);    
    requestMap.put("anchorId", anchorId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.get(url, null);
    
    log.info("测试查询主播频道关联关系结果：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "data":{
        "contents": [
            {
                "channelId": 1000,
                "name": "频道名称"
            }
        ],
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 1,
        "totalPages": 1
}, 
    "success": true,
}

異常範例

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