Polyv Help Center

Help Center

Query Default Template Playback Settings

Updated: 2026-03-05 17:25:45

API Description

1、查询回放默认模板设置
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/user/template/playback-setting/get

Online API Call

Request Method

GET

API Constraints

  1. 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: Get Secret Key
sign true String Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must never be stored or used directly on the client side. All API calls must be relayed through your own server to the POLYV server. See details: Signature Generation Rules
timestamp true String Current 13-digit millisecond timestamp, valid for 3 minutes

Example

http://api.polyv.net/live/v4/user/template/playback-setting/get?appId=frlr1zazn3&sign=82ADECF49C78E5F6399D99A6EDE4EEAD&timestamp=1677167039930

Response Parameters

Parameter Type Description
code Integer Status code, same as HTTP status code, used to determine basic response status
data Object Template playback settings object See details: Data Parameter Description
error Object Error information when status code is not 200 See details: Error Parameter Description
requestId String Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging, should not be tied to business logic
status String Response result, determined by business logic. Returns success on success, error on failure
success Boolean Whether the response was successful

Data Parameter Description

Parameter Type Description
playbackEnabled String Playback toggle
Y: Enabled
N: Disabled
type String Playback method on the viewing page
single: Single video
list: List playback
origin String Playback video source
record: Temporary storage
playback: Playback list
vod: VOD list
sectionEnabled String Chapter toggle
Y: Enabled
N: Disabled
chatPlaybackEnabled String Chat replay toggle
Y: Enabled
N: Disabled
playbackMultiplierEnabled String Speed playback toggle
Y: Enabled
N: Disabled
playbackProgressBarEnabled String Progress bar toggle
Y: Enabled
N: Disabled
playbackProgressBarOperationType String Progress bar operation mode
drag: Drag, prohibitDrag: Drag prohibited, dragHistoryOnly: Only drag watched content
showPlayButtonEnabled String Show play button toggle
Y: Enabled
N: Disabled
chatPlaybackEnabled String Chat interaction replay toggle
Y: Enabled
N: Disabled
productPlaybackEnabled String Product library interaction replay toggle
Y: Enabled
N: Disabled
questionnairePlaybackEnabled String Questionnaire interaction replay toggle
Y: Enabled
N: Disabled
qaPlaybackEnabled String Quiz card interaction replay toggle
Y: Enabled
N: Disabled
cardPushPlaybackEnabled String Card push interaction replay toggle
Y: Enabled
N: Disabled
checkInPlaybackEnabled String Check-in interaction replay toggle
Y: Enabled
N: Disabled

Error Parameter Description

Parameter Type Description
code Integer Error code, used to determine the specific error reason
desc String Error description, corresponding to error.code

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 HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询回放默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getPlaybackSettingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/user/template/playback-setting/get";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试查询回放默认模板设置成功:{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "62420aef40254ac2b8b13a9a0895d285.75.16771670417921429",
    "data": {
        "playbackEnabled": "Y",
        "sectionEnabled": "N",
        "type": "single",
        "origin": "record",
        "chatPlaybackEnabled": "Y",
        "playbackMultiplierEnabled": "Y",
        "playbackProgressBarEnabled": "N",
        "playbackProgressBarOperationType": "drag",
        "showPlayButtonEnabled": "N",
        "chatPlaybackEnabled": "Y",
        "productPlaybackEnabled": "Y",
        "questionnairePlaybackEnabled": "Y",
        "qaPlaybackEnabled": "Y",
        "cardPushPlaybackEnabled": "Y",
        "checkInPlaybackEnabled": "Y"
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询
在线咨询