Edit Information Collection

API Description

1、修改已有的信息采集配置（表单）
2、fields、privacyList 为整体覆盖，编辑已有字段须回传其 fieldKey
3、请求体参数不参与签名，签名仅使用URL参数（appId、timestamp）
4、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency limits. See details
   
2. Please set the request header contentType:application/json

Request Parameter Description

Request Body Parameter Description

The request body is a JSON object with the following fields:

fields Field Description

privacyList Field Description

Example

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

Request body parameters:

{
    "formId": 52,
    "formName": "问卷调研V2",
    "privacyForceCheckEnabled": "N",
    "fields": [
        {
            "fieldType": "name",
            "fieldKey": "name_a1b2c3",
            "fieldName": "姓名",
            "rank": 1,
            "required": "Y"
        }
    ],
    "privacyList": []
}

Response Parameter Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);
/**
 * 编辑信息采集
 * @throws IOException
 */
@Test
public void testUpdateInfoCollection() 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/update";

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

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

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

Response Example

For global error descriptions, see Global Error Description

Success Example

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

Error Example

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