修改頻道字幕設定資訊

更新時間：2025-12-25 16:11:34

介面描述

1、修改频道字幕配置信息
2、接口支持https协议

介面URL

https://api.polyv.net/live/v4/channel/subtitle/config/update

線上API呼叫

請求方式

POST

介面限制

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

請求參數描述

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

請求體參數描述

參數名	必選	類型	說明
channelId	true	Integer	頻道 ID
realTimeSubtitleEnabled	false	String	即時字幕開關，Y：開啟，N：關閉
realTimeSubtitleDisplayEnabled	false	String	即時字幕顯示開關（控制觀看端），Y：開啟，N：關閉
realTimeSubtitleDisplayNumberLimitEnabled	false	String	即時字幕顯示數量限制開關，Y：開啟，N：關閉
realTimeSubtitleDisplayNumber	false	Integer	即時字幕最多顯示數量
sourceLanguage	false	String	原聲字幕語種，Chinese：中文；English：英文
subtitleTranslationEnabled	false	String	字幕翻譯開關，Y：開啟，N：關閉
translationLanguage	false	String	字幕翻譯語種，Chinese：中文；English：英文等
translationLanguages	false	Array	翻譯語言陣列
subtitleCallbackEnabled	false	String	字幕回呼開關，Y：開啟，N：關閉
subtitleCallbackUrl	false	String	字幕回呼地址

範例

https://api.polyv.net/live/v4/channel/subtitle/config/update?appId=frlr1zazn3&sign=4049473DAEBBEFF778DABD1A25E3409B&timestamp=1642732753732

請求體json參數：

{
  "channelId":100033333,
  "realTimeSubtitleEnabled":"Y",
  "realTimeSubtitleDisplayNumberLimitEnabled":"Y",
  "subtitleTranslationEnabled":"Y",
  "sourceLanguage":"English",
  "translationLanguage":"Chinese",
  "realTimeSubtitleDisplayNumber": 5
}

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	請求失敗時為空，請求成功時為字幕設定資訊【詳見data欄位說明】

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询频道字幕配置信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateSubtitleSetting() 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/v4/channel/subtitle/config/update";

    String jsonStr = "{\"channelId\":2779045,\"realTimeSubtitleDisplayNumberLimitEnabled\":\"N\"," +
        "\"realTimeSubtitleEnabled\":\"N\"," +
        "\"subtitleTranslationEnabled\":\"Y\",\"translationLanguage\":\"Chinese\",\"sourceLanguage\":\"English\"}";
        url = HttpUtil.appendUrl(url, requestMap);
        String response = HttpUtil.postJsonBody(url, jsonStr, null);
    log.info("测试更新频道字幕配置信息，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "14138a5004b1412fbe109f854fec0b52.59.16538790171742883",
  "data": "",
  "success": true
}

異常範例

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