信息采集详情

接口描述

1、查询单个信息采集的基础配置，含采集字段定义与隐私声明
2、关联记录、用户提交记录另见对应查询接口
3、接口支持https协议

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

示例

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

响应参数描述

data字段说明

fields字段说明

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 testGetInfoCollection() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String formId = "52";
    String url = "http://api.polyv.net/live/v4/user/info-collection/form/get";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("formId",formId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url,requestMap);

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

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "formId": 52,
        "formName": "问卷调研",
        "privacyForceCheckEnabled": "N",
        "bindingCount": 1,
        "fields": [
            {
                "id": 301,
                "fieldType": "name",
                "fieldKey": "name_a1b2c3",
                "fieldName": "姓名",
                "rank": 1,
                "required": "Y",
                "options": null,
                "placeholder": "请输入姓名",
                "smsCheckEnabled": "N",
                "areaCodeEnabled": "N",
                "chatNicknameEnabled": "N",
                "uploadMaxCount": null
            }
        ],
        "privacyList": []
    }
}

异常示例

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