Query Channel Remastered Courseware Settings

Updated: 2022-12-12 11:51:12

API Description

1、查询频道重制课件设置
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/pptRecord/get-setting

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: Get Secret Key
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 to generate the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See details: Signature Generation Rules
channelId	true	String	Channel ID

Example

http://api.polyv.net/live/v3/channel/pptRecord/get-setting?appId=fso8gzbxlr&timestamp=1628073087000&channelId=1947328&sign=1337F1DB74DC2E50ABF6F7A74E996769

Response Parameters

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See details: Global Error Description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Object	Returns the remastered courseware result set on success See details: Data Field Description

Data Parameter Description

Parameter	Type	Description
channelId	Integer	Channel ID
userId	String	User ID
type	Integer	Video layout mode, 0. Triple screen, 1. Document only
globalSettingEnabled	String	Apply global settings switch Y enabled, N disabled
videoRatio	Integer	Camera aspect ratio 0 for 16:9, 1 for 4:3
backgroundImg	String	Background image, used in legacy remastered 1.0
brandImg	String	Display image, used in new remastered 2.0

Java Request Example

For quick integration of the base code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source 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(ChannelOperateTest.class);
/**
 * 查询重制课件任务列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testPptRecordList() 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/pptRecord/get-setting";
    String channelId="1947328";

    //http 调用逻辑
    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 system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 2272655,
        "userId": "1b448be323",
        "type": 0,
        "globalSettingEnabled": "N",
        "backgroundImg": "http://liveimages.videocc.net/uploadimage/20201126/remakeCoursewareBg_1606386346554_8190198.jpg",
        "videoRatio": "0",
        "brandImg": "",
        "createdTime": 1619579289000,
        "lastModified": 1631519980000,
        "actionPosition": "right"
    }
}

Error Example

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

Live Streaming Server API