文档首页/ 隐私保护通话 PrivateNumber/ API参考/ API/ A号码报备接口/ 新增A号码报备-CreatePvCallerNumber
更新时间:2026-07-29 GMT+08:00
分享

新增A号码报备 - CreatePvCallerNumber

接口功能

企业用户通过该接口新增租户A号码报备。

使用说明

仅使用隐私号业务的用户可调用此接口,只要调用此接口新增A号码后,此租户下所有有效应用的A号码都会生效。A号码需要一次性配全,未配置的A号码可能无法呼叫。

授权信息

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

URI

POST /v1.0/privatenumber/a-number

请求参数

表1 请求Headers参数说明

参数名称

是否必选

参数类型

说明

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及。

取值范围:

固定填写为application/json;charset=UTF-8。

默认取值:

不涉及。

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

说明:
  • Token的有效期为24小时,到期后请重新获取。
  • 使用AKSK鉴权不需要携带此参数。
表2 请求URL参数说明

参数名称

是否必选

参数类型

说明

agree_authorization_statement

Boolean

是否同意个人数据授权声明。

  • true:同意。
说明:
  • “A号码报备文件上传”操作会收集您的现场照片信息,该信息属于敏感个人信息,仅用于隐私号业务向运营商报备号码,如果非本人操作,请确定已获得相应授权。
  • 如果不同意个人数据授权声明,上传文件会失败。
  • 点击查看隐私政策声明服务使用声明
表3 请求Body参数说明

参数名称

是否必选

参数类型

说明

numbers

Number[]

A号码,一次最多可新增10个号码。

表4 Number定义

参数名称

是否必选

参数类型

说明

number

String(20)

A号码。

号码格式:填写为全局号码格式(国内号码),如:+86138****0021或+8675528****01。

numberType

Integer

号码类型

1:手机号

2:固话号码

name

String(50)

号码类型是手机号(numberType=1),号码所属人姓名

号码类型是固话号码(numberType=2),经办人姓名

identityCard

String(20)

号码类型是手机号(numberType=1),号码所属人身份证号码

号码类型是固话号码(numberType=2),经办人身份证号码

liveFaceImage

String

号码类型是手机号(numberType=1),号码所属人现场照片文件名(半身或者寸照的头像)

号码类型是固话号码(numberType=2),经办人现场照片文件名(半身或者寸照的头像)

文件名支持jpg或png格式,文件名长度不超过64字符

operatorNumber

String(20)

经办人手机号码,号码类型是固话号码(numberType=2)时携带本参数

号码格式:填写为全局号码格式(国内号码),如:+86138****0021

响应参数

表5 响应结果参数

参数名称

是否必选

参数类型

说明

result

String

值为"Add Successful.",响应码为200时携带。

error_code

String

错误码,响应码不为200时携带。

error_msg

String

错误描述,响应码不为200时携带。

failedNumbers

FailedNumber[]

报备失败的A号码列表。

表6 FailedNumber定义

参数名称

是否必选

参数类型

说明

number

String(20)

A号码。

号码格式:填写为全局号码格式(国内号码),如:+86138****0021或+8675528****01。

failReason

String

失败原因描述。

结果码说明

表7 响应结果码

响应码

返回值

英文描述

说明

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
    {
        "numbers":[{"number":"+86185****6002", "numberType":1, "name":"XXX", "identityCard":"XXXXXX",  "liveFaceImage":"XXX.png"}]
    }
  • 响应示例
    成功:
    HTTP/1.1 200
    Content-Type: application/json;charset=UTF-8
    {
       "result": "Add Successful."  
    }
    失败:
    HTTP/1.1 400
    Content-Type: application/json;charset=UTF-8
    { 
      "error_code":"PPT.0007", 
      "error_msg":"Request unauthorized."
    }

相关文档