提交观众报名信息

下载 PDF

下载 Word

供接入方在自有页面/App 内代观众提交报名，报名数据进入频道已有的报名统计，审核流程与保利威后台一致。配合查询频道报名观看配置、查询观众报名及审核状态使用。

接口描述

1、接入方指定频道，传入观众ID与报名账号，提交保利威后台报名表单对应的信息
2、频道未开启报名时不允许提交，返回错误码1175
3、按后台表单的必填要求及格式规则校验，校验失败返回明确错误原因，不保存本次提交
4、通过本接口提交报名时，不要求也不校验保利威短信验证码，手机号真实性由接入方自行负责（保利威观看页仍按后台配置执行短信验证）
5、同一观众（观众ID）重复提交时：已审核通过的报名幂等返回成功；其余情况更新原报名记录（表单内容、报名账号跟随本次提交更新），不会重复生成报名记录
6、开启审核的频道，新报名进入待审核状态（W），由保利威后台审核；审核结果通过[查询观众报名及审核状态](/live/api/v4/channel/enroll/record_get)获取，提交成功不代表审核通过
7、接口产生的报名记录纳入已有的报名提交及审核结果回调【详见[报名观看回调](/live/api/callback/enroll_callback)】，回调中的观众ID与报名记录一致
8、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/enroll/record/save

在线API调用

请求方式

POST

接口约束

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

2、请设置请求头contentType:application/json，签名仅使用URL参数（appId、timestamp、channelId等），请求体参数不参与签名【详见签名生成规则】

请求参数描述

请求体参数描述

示例

http://api.polyv.net/live/v4/channel/enroll/record/save?appId=frlr1zazn3&sign=16DC042339E27BAD00452D004C1FA9CA&timestamp=1731128494801

请求体JSON示例

{
    "channelId": 5588786,
    "code": "mobile",
    "mobile": "13100001111",
    "viewerId": "viewer001",
    "content": "{\"4085178\": \"13100001111\", \"4085180\": \"张三\"}"
}

响应参数描述

Error参数描述

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 testSaveEnrollRecord() 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/record/save";
    Integer channelId = 5588786;
    String viewerId = "viewer001";
    String code = "mobile";
    String mobile = "13100001111";
    // 字段id与「查询频道报名观看配置」返回的 fields.id 对应
    String content = "{\"4085178\": \"13100001111\", \"4085180\": \"张三\"}";

    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));

    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("channelId", channelId);
    jsonMap.put("code", code);
    jsonMap.put("mobile", mobile);
    jsonMap.put("viewerId", viewerId);
    jsonMap.put("content", content);
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);

    log.info("提交观众报名信息，返回值：{}", response);
    // do somethings
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "success": true,
    "data": null
}

异常示例（频道未开启报名）

{
    "code": 400,
    "status": "error",
    "success": false,
    "error": {
        "code": 1175,
        "desc": "频道未开启报名观看"
    }
}

异常示例（报名表单必填项缺失）

{
    "code": 400,
    "status": "error",
    "success": false,
    "error": {
        "code": 1176,
        "desc": "报名表单必填项缺失"
    }
}