Information Collection List

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/list

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency 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 within 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 the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
pageNumber	false	Integer	Page number to query, default is 1
pageSize	false	Integer	Number of items per page, default is 10
keyword	false	String	Fuzzy search by information collection name

Example

http://api.polyv.net/live/v4/user/info-collection/form/list?appId=xxx&sign=xxx&timestamp=xxx&pageNumber=1&pageSize=10

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	Pagination object See data field description

data Field Description

Parameter	Type	Description
pageNumber	Integer	Current page number
pageSize	Integer	Items per page
totalItems	Long	Total number of items
totalPages	Integer	Total number of pages
contents	Array	Information collection list See contents field description

contents Field Description

Parameter	Type	Description
formId	Long	Form ID
formName	String	Information collection name
isDefault	String	Whether it is the system default "Shipping Information" form Y: Yes (pinned to top of list) N: No
creatorId	String	Creator account ID (sub-account or main account; empty for system default forms)
creatorName	String	Creator name: main account → "Main Account", sub-account → sub-account username; empty for system default forms
bindingCount	Integer	Number of active business associations
totalSubmitter	Integer	Number of submitted users
createdTime	String	Creation time
lastModified	String	Last modification time

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 packaging 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 testListInfoCollection() 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/list";

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

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

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 2,
        "totalPages": 1,
        "contents": [
            {
                "formId": 48,
                "formName": "收货信息",
                "isDefault": "Y",
                "creatorId": "",
                "creatorName": "",
                "bindingCount": 0,
                "totalSubmitter": 0,
                "createdTime": "2026-07-01 10:00:00",
                "lastModified": "2026-07-01 10:00:00"
            },
            {
                "formId": 52,
                "formName": "问卷调研",
                "isDefault": "N",
                "creatorId": "e0f1a2b3c4",
                "creatorName": "主账号",
                "bindingCount": 1,
                "totalSubmitter": 5,
                "createdTime": "2026-07-01 11:00:00",
                "lastModified": "2026-07-01 12:00:00"
            }
        ]
    }
}

Error Example

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

Live Streaming Server API