Query Channel Registration Viewing Configuration

For integrators to render a registration form consistent with the Polyv backend on their own pages/Apps, used together with Submit Viewer Registration Information and Query Viewer Registration and Audit Status.

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are rate-limited; see details.

2. When the channel has not enabled the registration viewing feature, enabled returns N, which is not considered an API call failure.

Request Parameter Description

Example

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

Response Parameter Description

Error Parameter Description

data Parameter Description

fields Parameter Description

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code, click to download the source code, and add it to your own source project after downloading. HttpUtil.java and LiveSignUtil.java in the test cases are both included in the downloaded files.

It is strongly recommended that you use the Live Java SDK to complete API integration. The Live Java SDK uniformly encapsulates and optimizes API call logic, exception handling, data signing, and HTTP request thread pools.

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
}

Response Example

For system global error descriptions, see Global Error Description

Success example

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

Exception example

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