Query Channel Remastered Courseware Configuration

Updated: 2023-06-09 09:08:29

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 are subject to rate limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See 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 not be used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
channelId	true	String	Channel ID

Example

http://api.polyv.net/live/v3/channel/pptRecord/get-setting?appId=frlr1zazn3&sign=737C622B50A424E007E2CFF0BA68D416&channelId=1965681&timestamp=1629708273547

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	Returns the remastered courseware result set on success See data field description

data Field Description

Parameter	Type	Description
channelId	String	Channel ID
userId	String	POLYV user ID, consistent with the POLYV official website. Path: Official Website -> Login -> Live Streaming (Development Settings)
type	Integer	Video layout mode 0: Triple split screen 1: Document only 2: Picture-in-picture
globalSettingEnabled	String	Use global settings Y: Yes N: No
videoRatio	String	Camera aspect ratio 0: 16:9 1: 4:3
brandImgFile	String	Display image
backgroundImgFile	String	Background image
actionPosition	String	Remastered courseware camera position left: Left side right: Right side

Java Request Example

For quick integration, download the relevant dependency source code. Click to download source code. After downloading, add it to your 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 pptGetSettingTest() 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 = "1965681";

    //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

See Global Error Description for system-wide error descriptions.

Success Example

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

Error Example

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

Live Streaming Server API