Information Collection Details

Updated: 2026-07-16 23:19:19

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See signature generation rules
formId	true	Long	Form ID

Example

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Object	Form details See data field description

data Field Description

Parameter	Type	Description
formId	Long	Form ID
formName	String	Information collection name
privacyForceCheckEnabled	String	Whether privacy agreement is mandatory Y: Yes N: No
bindingCount	Integer	Number of active business associations (status=Y). Used to determine if deletion is allowed: >0 deletion prohibited, =0 deletion allowed
fields	Array	List of collection field definitions See fields field description
privacyList	Array	List of privacy statements See privacyList field description

fields Field Description

Parameter	Type	Description
id	Long	Field ID
fieldType	String	Field type mobile: Phone number name: Name radio: Single choice checkbox: Multiple choice textarea: Q&A email: Email text: Text box number: Numeric text box area: Region upload: Image upload tips: Hint privacy: Privacy statement
fieldKey	String	Unique field identifier, used as the key when submitting collection data
fieldName	String	Field name
rank	Integer	Sort order
required	String	Whether required Y: Required N: Optional
options	String	Option values, used for single/multiple choice types
placeholder	String	Placeholder prompt text
smsCheckEnabled	String	Whether SMS verification is enabled (for phone number type) Y: Enabled N: Disabled
areaCodeEnabled	String	Whether area code is enabled (for phone number type) Y: Enabled N: Disabled
chatNicknameEnabled	String	Whether to sync as chat room nickname Y: Enabled N: Disabled
uploadMaxCount	Integer	Maximum number of images to upload, used only for upload type, values 1/2/3

privacyList Field Description

Parameter	Type	Description
id	Long	Privacy statement ID
rank	Integer	Sort order
title	String	Title
content	String	Content
linkUrl	String	Link URL

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the 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 encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "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": []
    }
}

Error Example

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

Live Streaming Server API