查询频道报名观看配置

下载 PDF

下载 Word

供接入方在自有页面/App 渲染与保利威后台一致的报名表单，配合提交观众报名信息、查询观众报名及审核状态使用。

接口描述

1、查询频道报名观看的开关、审核开关及报名表单字段配置（字段、展示顺序、必填、选项、提示信息）
2、查询结果与保利威后台当前生效配置一致，后台修改配置后再次查询即可获取最新配置（接口有短暂缓存，最长延迟约1分钟）
3、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/enroll/setting/get

在线API调用

请求方式

GET

接口约束

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

2、频道未开启报名观看功能时，enabled 返回 N，不作为接口调用失败

请求参数描述

示例

http://api.polyv.net/live/v4/channel/enroll/setting/get?appId=frlr1zazn3&sign=16DC042339E27BAD00452D004C1FA9CA&channelId=5588786&timestamp=1731128494801

响应参数描述

Error参数描述

data参数描述

fields参数描述

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelEnrollControllerTest.class);
/**
 * 查询频道报名观看配置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetEnrollSetting() 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/channel/enroll/setting/get";
    Integer channelId = 5588786;

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", String.valueOf(channelId));
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

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

    log.info("查询频道报名观看配置，返回值：{}", response);
    // do somethings
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "success": true,
    "requestId": "e1e1870c-89a0-4791-b04e-83fb8ddbe16e",
    "data": {
        "enabled": "Y",
        "auditEnabled": "N",
        "title": "填表报名",
        "entranceText": "报名观看",
        "banner": null,
        "fillTime": "beforeEnter",
        "fields": [
            {
                "id": 4085187,
                "name": "性别",
                "rank": 2,
                "tips": "",
                "required": "N",
                "type": "radio",
                "options": "[\"男\", \"女\"]",
                "smsCheck": "N",
                "chatNicknameEnabled": "N",
                "authType": null,
                "showAreaCodeEnabled": "Y"
            },
            {
                "id": 4085178,
                "name": "手机号码",
                "rank": 0,
                "tips": "请填写手机号码",
                "required": "Y",
                "type": "mobile",
                "options": "[]",
                "smsCheck": "N",
                "chatNicknameEnabled": "N",
                "authType": "mobile",
                "showAreaCodeEnabled": "Y"
            }
        ]
    }
}

异常示例

{
    "code": 400,
    "status": "error",
    "success": false,
    "error": {
        "code": 400,
        "desc": "找不到频道"
    }
}