保利威文档中心

帮助中心

信息采集列表

更新时间:2026-07-16 23:19:19

接口描述

1、分页查询账号下的信息采集配置列表
2、支持按名称模糊搜索
3、接口支持https协议

接口URL

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

在线API调用

请求方式

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&timestamp=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": ""
}
联系客服,在线咨询