保利威文档中心

幫助中心

資訊蒐集使用者提交記錄

更新時間:2026-07-16 23:19:19

介面描述

1、分页查询某个信息采集的观众提交记录
2、属于信息采集详情的一部分
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/info-collection/submission/list

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
formId true Long 表單ID,須歸屬當前帳號
keyword false String 依提交內容搜尋
pageNumber false Integer 查詢的頁數,預設為1
pageSize false Integer 查詢的每頁大小,預設為10

範例

http://api.polyv.net/live/v4/user/info-collection/submission/list?appId=xxx&sign=xxx&timestamp=xxx&formId=52&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欄位說明

參數名 類型 說明
submissionId Long 提交記錄ID
formId Long 表單ID
bindingId Long 關聯記錄ID
viewerId String 觀眾ID
name String 姓名(表單含姓名字段時)
mobile String 手機號碼(表單含手機號碼字段時)
email String 電子郵件(表單含電子郵件字段時)
viewerNickName String 提交者暱稱快照
viewerAvatar String 提交者頭像快照
fieldData String 全部欄位值JSON,形如 {fieldKey:值},key對應表單詳情fields的fieldKey
privacyChecked String 已勾選隱私聲明ID的JSON陣列
createTime String 提交時間

編輯表單新增欄位後,歷史提交記錄的 fieldData 中缺少該欄位的 key,取值時可顯示「-」。

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 testListInfoCollectionSubmission() 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/submission/list";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("formId",formId);
    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": 1,
        "totalPages": 1,
        "contents": [
            {
                "submissionId": 9001,
                "formId": 52,
                "bindingId": 88,
                "viewerId": "2_x3x8740mh7zo5i5w0or9z737s1a3g7my",
                "name": "张三",
                "mobile": "13800000000",
                "email": "",
                "viewerNickName": "小张",
                "viewerAvatar": "https://example.com/avatar.png",
                "fieldData": "{\"name_a1b2c3\":\"张三\",\"mobile_d4e5f6\":\"13800000000\"}",
                "privacyChecked": "[]",
                "createTime": "2026-07-01 13:00:00"
            }
        ]
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询