Query Channel Playback Settings

To query the playback switch individually, you can use the legacy API at Query Channel Playback Switch

API Description

1、查询频道回放设置
2、接口支持https协议

API URL

https://api.polyv.net/live/v3/channel/playback/get-setting

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

Example

http://api.polyv.net/live/v3/channel/playback/get-setting?appId=frlr1zazn3&sign=9DC1D9A3AAD34E0DD5C3B3154F1A6F5D&channelId=3187786&timestamp=1655964947987

Response Parameters

Data Parameter Description

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 encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 查询频道回放设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetPlaybackSetting() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/playback/get-setting";
    String channelId = "3187786";
    
    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",
    "message": "",
    "data": {
        "channelId": 3187786,
        "type": "single",
        "origin": "record",
        "videoId": null,
        "playbackEnabled": "Y",
        "videoName": null,
        "sectionEnabled": "Y",
        "globalSettingEnabled": "N",
        "chatPlaybackEnabled": "N",
        "crontabType":"period",
        "startTime": 1694102400000,
        "endTime": 1695398400000,
        "productPlaybackEnabled": null,
        "customOpenDuration": 18,
        "playbackMultiplierEnabled": "Y",
        "playbackProgressBarEnabled": "Y",
        "playbackProgressBarOperationType": "drag",
        "showPlayButtonEnabled": "Y",
        "questionnairePlaybackEnabled": "N",
        "qaPlaybackEnabled": "N",
        "cardPushPlaybackEnabled": "N",
        "checkInPlaybackEnabled": "N"
    }
}

Error Example

Parameter Error

{
    "code": 400,
    "status": "error",
    "message": "param validate error",
    "data": 400
}

Missing appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

Incorrect appId

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

Timestamp Error

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

Signature Error

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