資訊收集詳情

介面描述

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": ""
}