保利威文档中心

幫助中心

修改頻道主持人姓名

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

介面描述

1、设置单个或者所有频道的主持人姓名
2、接口URL中的{userId}为直播账号ID
3、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channelSetting/{userId}/setPublisher

線上API呼叫

請求方式

POST

介面限制

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

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
publisher true String 主持人姓名,不超過50個字元
channelId false String 頻道號,不提交或者傳-1則修改該用戶的所有頻道號的主持人姓名

範例

http://api.polyv.net/live/v2/channelSetting/1b448be323/setPublisher

表單參數:

appId=frlr1zazn3&sign=5DC30EEA5783A34C39EAED2BEE96FE6D&publisher=%E4%B8%BB%E8%AE%B2%E4%BA%BAsadboy_%E6%B5%8B%E8%AF%95&channelId=1965681&timestamp=1621840557193

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或者500的時候,輔助描述錯誤原因
data String 請求成功時,回傳值是設定的頻道號,請求失敗時,回傳值是空

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WebInfoTest.class);
/**
 * 修改频道主持人姓名
 * @throws IOException
 */
@Test
public void testSetPublisher() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/setPublisher",userId);
    String publisher = "主讲人sadboy_测试";
    String channelId = "1965681";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("publisher",publisher);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试修改频道主持人姓名:{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":1965681
}

異常範例

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