查询A号码报备文件 - QueryReportFiles

接口功能

企业租户通过该接口查询号码所属人现场照片报备文件。

使用说明

前提条件：

已获取用户Token或已获取AK（Access Key ID）/SK（Secret Access Key）。
已开通隐私号业务。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限管理。

URI

POST /v1/privatenumber/a-number/files/query

请求参数

表1 请求Headers参数说明
参数名称	是否必选	参数类型	说明
Content-Type	否	String	参数解释：消息体的类型（格式）。约束限制：不涉及。取值范围：固定填写为application/json;charset=UTF-8。默认取值：不涉及。
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。说明： Token的有效期为24小时，到期后请重新获取。使用AKSK鉴权不需要携带此参数。

表2 请求Body参数说明
参数名称	是否必选	参数类型	说明
page	是	Integer 从1开始	分页列表的起始页，从1开始。
size	是	Integer(1-100)	每页显示的最大条数，取值1~100。
startTime	否	String	按时间段查询的开始时间。该参数为UTC时间（+8小时为北京时间），时间格式为“YYYY-MM-DD HH:MM:SS”，如：2025-01-01 00:00:00。注：按时间段查询时，以A号码报备文件的创建时间为准。
stopTime	否	String	按时间段查询的结束时间。该参数为UTC时间（+8小时为北京时间），时间格式为“YYYY-MM-DD HH:MM:SS”，如：2025-01-01 23:59:59。说明：按时间段查询时，以A号码报备文件的创建时间为准。
fileName	否	String	A号码报备文件名称，不支持模糊匹配。

响应参数

表3 响应结果参数
参数名称	是否必须	参数类型	说明
total	否	Integer	报备文件数量，响应码为200时携带。
files	否	File[]	报备文件列表，最多10个，响应码为200时携带。
error_code	否	String	错误码，响应码不为200时携带。
error_msg	否	String	错误描述，响应码不为200时携带。

表4 File定义
参数名称	是否必选	参数类型	说明
createTime	是	String	报备文件的创建时间。该参数为UTC时间（+8小时为北京时间），时间格式为“YYYY-MM-DD HH:MM:SS”，如：2025-01-01 23:59:59。
fileName	是	String(64)	报备文件名称。

结果码说明

表5 响应结果码
响应码	返回值	英文描述	中文描述	处理方法
400	PPT.0002	Invalid Parameter.	参数错误。	请检查请求参数填写是否正确。
	PPT.0009	Order does not exist.	服务未开通完成。	点击开通隐私号业务。
	PPT.00032	The operation is forbidden because tenant has been frozen.	租户已被冻结，不能进行该操作。	请联系管理员处理。
	PPT.00033	The operation is forbidden because tenant has been restricted.	租户受限，不允许操作。	请联系管理员处理。
	PPT.00039	Operation failed.	操作失败。	请联系管理员处理。
403	PPT.0007	Request unauthorized.	请求鉴权未通过。	请检查请求携带的X-Auth-Token填写是否正确。

接口示例

请求示例

POST /v1/privatenumber/a-number/files/query
{
"page": 1,
"size":10
}

响应示例

成功：
{ 
    "files": [{
        "createTime": "2025-04-02 10:00:00",
         "fileName": "test.jpg"
     }],
    "total": 1
}
失败：
{ 
    "error_code": "PPT.0002",
    "error_msg": "Invalid Parameter."
}

父主题： A号码报备接口

上一篇：上传A号码报备文件-CreateReportFiles

下一篇：删除A号码报备文件-DeleteReportFiles