RouteAAuth - A路号码报备--语音服务-火山引擎

文档中心

立即注册

导航

RouteAAuth - A路号码报备

最近更新时间：2025.04.27 16:42:02首次发布时间：2025.04.27 16:42:02

隐私号A路号码报备接口

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	RouteAAuth	要执行的操作，取值：RouteAAuth。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
requestId	String	是	abcdef	唯一id，用于区分每次请求
idType	Integer	是	0	证件类型 0居民身份证（优先） 1港澳通行证 2护照
name	String	是	abcdef	姓名，AES加密，密钥为配置在火山控制台-业务设置-回调设置-回调鉴权的鉴权token，加密逻辑参考https://www.volcengine.com/docs/6358/1545464，下同
phoneNumber	String	是	abcdef	号码，AES加密
idNumber	String	是	abcdef	证件号，AES加密
photo	String	是	abcdef	现场人脸检测照片（不大于32KB），文件二进制AES加密后用base64编码

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
code	String	0	0表示成功
message	String	success	成功是""，失败包含失败原因

请求示例

POST /?Action=RouteAAuth&Version=2022-01-01 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Date: 20250416T084701Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250416/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

idNumber=uCJKWOfFR&idType=1&name=6KRTDyML&phoneNumber=crM9MxCN2m&photo=RJ55Zvhx926&requestId=p5rTn

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025041616471603723900105645AB48",
    "Action": "RouteAAuth",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "code": "0",
    "message": ""
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OverQpsLimit	QPS超过上限
500	InternalError	The request has failed due to an unknown error.