查询频道重制课件配置信息

接口描述

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

接口URL

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

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，

请求参数描述

参数名

必选

类型

说明

appId

true

String

timestamp

true

Long

当前13位毫秒级时间戳，3分钟内有效

sign

true

String

channelId

true

String

频道号

示例

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

响应参数描述

参数名

类型

说明

code

Integer

status

String

响应状态文本信息

message

String

响应描述信息，当code为400或者500的时候，辅助描述错误原因

data

Object

data字段描述

参数名

类型

说明

channelId

String

频道号

userId

String

POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）

type

Integer

视频布局方式 0：三分屏 1：纯文档 2：画中画

globalSettingEnabled

String

是否使用通用设置 Y：是 N：否

videoRatio

String

摄像头画面比例 0：画面比例16:9 1：画面比例4:3

brandImgFile

String

展示图片

backgroundImgFile

String

背景图片

actionPosition

String

重制课件摄像头位置 left：左侧 right：右侧

Java请求示例

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

}

响应示例

成功示例

{
    "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"
    }
}

异常示例

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

Previous获取频道关注公众号设置信息 Next设置频道重制课件配置信息

Last updated 5 months ago

Was this helpful?

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 }

{ "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" } }