查询A号码报备信息 - QueryPvCallerNumber

接口功能

企业用户通过该接口查询租户A号码报备信息。

使用说明

仅使用隐私号业务的用户可调用此接口。

授权信息

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

URI

POST /v1.0/privatenumber/a-number/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。
number	否	String[]	A号码列表，最多100个。号码格式：填写为全局号码格式（国内号码），如：+86138**0021或+8675528**01。
reportStatus	否	Integer	0：报备成功 1：报备失败 2：报备中

响应参数

表3 响应参数说明
参数名称	是否必选	参数类型	说明
total	否	Integer	A号码数量，响应码为200时携带。
numbers	否	Number[]	A号码，最多100个，响应码为200时携带。
error_code	否	String	错误码，响应码不为200时携带。
error_msg	否	String	错误描述，响应码不为200时携带。

表4 Number定义
参数名称	是否必选	参数类型	说明
number	是	String(20)	A号码。号码格式：填写为全局号码格式（国内号码），如：+86138**0021或+8675528**01。
reportStatus	是	Integer	0：报备成功 1：报备失败 2：报备中
failReason	否	String	当reportStatus=1(报备失败)时携带，描述报备失败具体原因，典型失败场景如下：号码报备流程中，禁止重复提交。说明：【说明】已经在核验流程中，运营商对于处于报备核验流程中的A号码，禁止重复提交报备，且核验失败后，24小时内禁止提交，连续2次核验失败后会禁止报备。没有查询到该身份证信息或者身份证编码和姓名验证不一致。身份证编码和姓名验证不一致。姓名不一致曾用名一致。调用服务处理异常。一致但证件失效。一致但证件作废。没有查询到该身份证号码。姓名核查不一致。无此用户照片信息。请求报文照片大小超出上限（32K）。核验失败:(核查平台返回的具体原因)。号码信息有误，请核实后重新上传核验材料。 A 路号码必须非隐私号。超出身份证核验上限。当前 A 号码核验失败次数过多，已不具备报备条件。
handleDesc	否	String	当reportStatus=2(报备中)时携带，报备中的典型场景描述如下：待报备到运营商。运营商初审登记完成，待复核。

结果码

表5 结果码说明
响应码	结果码	英文描述	说明
200	-	Success.	成功。
400	PPT.0001	Internal server error.	系统内部错误。
	PPT.0002	Invalid Parameter.	无效参数。
	PPT.00039	Operation failed.	操作失败。
403	PPT.0007	Request unauthorized.	请求鉴权未通过。

接口示例

请求示例

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

响应示例

成功：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
   "numbers":[{"number":"+86xxx","reportStatus":0},{"number":"+86xxx","reportStatus":1}]
   "total": 2
}
失败：
HTTP/1.1 400
Content-Type: application/json;charset=UTF-8
{
   "error_code": "PPT.0007",
   "error_msg": "Request unauthorized"
}

父主题： A号码报备接口

上一篇：新增A号码报备-CreatePvCallerNumber

下一篇：删除A号码报备信息-DeletePvCallerNumber