資訊收集列表
更新時間:2026-07-16 23:19:19
介面描述
1、分页查询账号下的信息采集配置列表
2、支持按名称模糊搜索
3、接口支持https协议
介面URL
http://api.polyv.net/live/v4/user/info-collection/form/list
請求方式
GET
介面限制
1、介面同時支援HTTP及HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| pageNumber | false | Integer | 查詢的頁數,預設為1 |
| pageSize | false | Integer | 查詢的每頁大小,預設為10 |
| keyword | false | String | 依資訊收集名稱模糊搜尋 |
範例
http://api.polyv.net/live/v4/user/info-collection/form/list?appId=xxx&sign=xxx×tamp=xxx&pageNumber=1&pageSize=10
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 分頁物件 【詳見data欄位說明】 |
data欄位說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageNumber | Integer | 目前頁碼 |
| pageSize | Integer | 每頁筆數 |
| totalItems | Long | 總筆數 |
| totalPages | Integer | 總頁數 |
| contents | Array | 資訊收集列表 【詳見contents欄位說明】 |
contents欄位說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| formId | Long | 表單ID |
| formName | String | 資訊收集名稱 |
| isDefault | String | 是否系統預設「收貨資訊」表單 Y:是(列表置頂) N:否 |
| creatorId | String | 建立者帳號ID(子帳號或主帳號;系統預設表單為空) |
| creatorName | String | 建立者名稱:主帳號→「主帳號」,子帳號→子帳號使用者名稱;系統預設表單為空 |
| bindingCount | Integer | 生效中的業務關聯數 |
| totalSubmitter | Integer | 已提交人數 |
| createdTime | String | 建立時間 |
| lastModified | String | 最後修改時間 |
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 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
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"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"
}
]
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
