新增信息采集

接口描述

1、创建一个新的信息采集配置（表单），可用于报名、登记、福袋领奖等场景收集观众信息
2、字段与管理后台信息采集配置保持一致
3、请求体参数不参与签名，签名仅使用URL参数（appId、timestamp）
4、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/info-collection/form/create

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看
2、请设置请求头 contentType:application/json

请求参数描述

请求体参数描述

请求体为JSON对象，字段如下：

fields字段说明

fieldKey 新建时无需传入，由服务端自动生成；编辑时须原样回传。

privacyList字段说明

示例

http://api.polyv.net/live/v4/user/info-collection/form/create?appId=xxx&sign=xxx&timestamp=xxx

请求体参数：

{
    "formName": "问卷调研",
    "privacyForceCheckEnabled": "N",
    "fields": [
        {
            "fieldType": "name",
            "fieldName": "姓名",
            "rank": 1,
            "required": "Y",
            "placeholder": "请输入姓名"
        },
        {
            "fieldType": "mobile",
            "fieldName": "手机号",
            "rank": 2,
            "required": "Y",
            "smsCheckEnabled": "N",
            "areaCodeEnabled": "N"
        }
    ],
    "privacyList": []
}

响应参数描述

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);
/**
 * 新增信息采集
 * @throws IOException
 */
@Test
public void testCreateInfoCollection() 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/user/info-collection/form/create";

    //签名仅使用URL参数,请求体不参与签名
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));

    String json = "{\"formName\":\"问卷调研\",\"privacyForceCheckEnabled\":\"N\",\"fields\":[{\"fieldType\":\"name\",\"fieldName\":\"姓名\",\"rank\":1,\"required\":\"Y\"},{\"fieldType\":\"mobile\",\"fieldName\":\"手机号\",\"rank\":2,\"required\":\"Y\"}],\"privacyList\":[]}";
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, json, null);

    log.info("测试新增信息采集接口返回值：{}",response);
    //do somethings
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": 52
}

异常示例

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