Modify Client Real-Time Caption Feature Display Configuration
Updated: 2026-07-27 17:07:42
Interface Description
设置指定频道客户端主讲端的实时字幕功能入口展示状态。
该配置只控制客户端入口展示,不会开通实时字幕服务、授予账号实时字幕权限,也不会修改字幕语言、翻译、用量或回调配置。
Interface URL
https://api.polyv.net/live/v4/channel/subtitle/config/update-client-enabled
Request Method
POST
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId, see Get Secret Key |
| timestamp | true | Long | Current 13-digit millisecond timestamp, valid within 3 minutes |
| sign | true | String | 32-digit uppercase MD5 signature, see Signature Generation Rules |
| channelId | true | Integer | Channel ID (Live Room ID) |
Request Body Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| enabled | true | String | Client real-time caption feature entry display status: Y display, N hide |
Example
https://api.polyv.net/live/v4/channel/subtitle/config/update-client-enabled?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB×tamp=1670550787318&channelId=4854808
Request Body JSON:
{
"enabled": "Y"
}
Response Example
Success Example:
{
"code": 200,
"status": "success",
"data": null,
"success": true
}
