Query Channel Subtitle Configuration

Updated: 2025-12-25 16:11:34

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See details
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used for signature generation is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server and obtain responses.` See signature generation rules
channelId	true	Integer	Channel ID

Example

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

Response Parameters

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Object	Empty on failure, subtitle configuration on success See data field description

data Field Description

Parameter	Type	Description
realTimeSubtitleEnabled	String	Real-time subtitle toggle, Y: Enabled, N: Disabled
realTimeSubtitleDisplayEnabled	String	Real-time subtitle display toggle (controls viewer side), Y: Enabled, N: Disabled
sourceLanguage	String	Original subtitle language, Chinese: Chinese; English: English
subtitleTranslationEnabled	String	Subtitle translation toggle, Y: Enabled, N: Disabled
translationLanguage	String	Subtitle translation language, Chinese: Chinese; English: English, etc.
translationLanguages	Array	Translation language array
subtitleCallbackEnabled	String	Subtitle callback toggle, Y: Enabled, N: Disabled
subtitleCallbackUrl	String	Subtitle callback URL
realTimeSubtitleDisplayNumberLimitEnabled	String	Real-time subtitle display number limit toggle, Y: Enabled, N: Disabled
realTimeSubtitleDisplayNumber	Integer	Maximum number of real-time subtitles displayed

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询频道字幕配置信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetSubtitleSetting() 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/get";
    String channelId = "2779045";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道字幕配置信息，返回值：{}", response);
    //do somethings
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "9bedc2b44dcc4fdb8db8352905a17993.71.17270604205500043",
    "data": {
      "channelId": 73392405,
      "realTimeSubtitleDisplayNumber": 2,
      "realTimeSubtitleDisplayNumberLimitEnabled": "Y",
      "realTimeSubtitleEnabled": "Y",
      "sourceLanguage": "Chinese",
      "subtitleTranslationEnabled": "N",
      "translationLanguage": "English",
      "translationLanguages": []
  },
    "success": true
}

Error Example

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