QueryCanCall - 号码风控状态查询--语音服务-火山引擎

文档中心

导航

QueryCanCall - 号码风控状态查询

最近更新时间：2025.03.25 20:48:59首次发布时间：2021.11.30 17:27:57

查询指定号码是否黑名单冻结状态

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QueryCanCall	要执行的操作，取值：QueryCanCall。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
CustomerNumberList	Array of String	是	138xxxx1234	号码列表
BusinessLineId	String	是	20000xxxxx	账户id
CallType	Integer	是	1	呼叫类型 1-外呼；2-呼入；3-短信；

返回参数

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

参数	类型	示例值	描述
customerNumber	String	138xxxx1234	查询号码
businessLineId	Integer	20000xxxxx	账户id
status	Integer	-1	风控状态，0为正常状态，-1为冻结状态
reason	String	黑名单	风控状态说明

请求示例

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

BusinessLineId=xxrraT73&CallType=1&CustomerNumberList=ozRlwYTtN

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202503152113241852510701370E4A41",
        "Action": "QueryCanCall",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-beijing"
    },
    "Result": [
        {
            "customerNumber": "138xxxx1234",
            "businessLineId": 589,
            "status": 356,
            "reason": "4n66rgm4B"
        }
    ]
}

错误码

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

状态码	错误码	错误信息	说明
200	SystemError	系统错误
200	IllegalArgument	非法的参数