QueryAuth - 查询号码报备状态--语音服务-火山引擎

文档中心

立即注册

导航

QueryAuth - 查询号码报备状态

最近更新时间：2025.04.28 16:22:05首次发布时间：2025.04.27 19:36:56

查询已报备号码的审核状态

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QueryAuth	要执行的操作，取值：QueryAuth。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
phone	String	是	abcdef	号码，AES加密，密钥为配置在火山控制台-业务设置-回调设置-回调鉴权的鉴权token，加密逻辑参考https://www.volcengine.com/docs/6358/1545464 如果是固话，并且0开头，需要用去0后的号码查询

返回参数

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

参数	类型	示例值	描述
status	Integer	1	报备状态，0 成功，1 失败，2 审核中，9999 查询异常成功：该手机号所有报备的运营商/供应商都是成功状态，前提是都收到了回调结果失败：收到任意一家回调失败则告知下游失败状态审核中：除以上两种情况外都是审核中
failReason	String	success	失败原因

请求示例

POST /?Action=QueryAuth&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: 20250424T072715Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250424/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

phone=abcdef

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202504241527202521970280257DBC28",
    "Action": "QueryAuth",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "status": 1,
    "failReason": "success"
  }
}

错误码

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

状态码	错误码	错误信息	说明
200	SystemError	系统错误