You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /
  • 语音服务

查询风控数据接口

最近更新时间：2023.08.17 21:04:11

首次发布时间：2021.11.30 17:27:57

我的收藏

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

  • 请求地址：https://cloud-vms.volcengineapi.com

  • 请求方式：POST

1. 请求参数
参数数据类型是否必填示例值描述
X-DateString是20201103T104027Z鉴权字段。请参考文档中心-火山引擎。

Authorization

String

是

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎。

ServiceNameString是vms服务名称。该接口是vms。
RegionString是cn-north-1区域名称，固定值cn-north-1。
Content-TypeString是application/x-www-form-urlencoded

签名相关header字段参考火山引擎公共参数

Query

参数参数类型是否必选示例值描述
ActionString是QueryCanCall接口名称
VersionString是2022-01-01接口版本

Body

参数类型释义描述
CustomerNumberListList<String>必选号码列表
BusinessLineIdString必选账户/业务线唯一标识
CallTypeInteger必选呼叫类型
1-外呼；2-呼入；3-短信；
2. 请求示例
curl --location --request POST 'https://cloud-vms.volcengineapi.com?Action=QueryCanCall&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--data-urlencode 'CustomerNumberList=138xxxx1234'
--data-urlencode 'BusinessLineId=210000xxxx'
--data-urlencode 'CallType=1'
3. 响应消息
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。
ResultResult响应业务参数。

ResponseMetadata

参数数据类型描述
RequestIdstring请求 ID。
Actionstring请求的接口名称。
Versionstring请求的版本号。
Servicestring请求的服务名称。
Regionstring请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。

Result

参数数据类型实例值描述

customerNumber

String

138xxxx1234

查询号码

businessLineIdInteger2000000001查询账户
statusInteger-1风控状态，0为正常状态，-1为冻结状态
reasonString号码正常风控状态说明

Error

参数数据类型描述
Codestring错误码。
Messagestring错误信息。

错误码

火山引擎网关的公共错误码，请参见火山引擎网关公共错误码。

CodeMessage说明处理建议
RequestParametersErrorUnexpected Parameters参数异常检查请求通话id是否为空
SystemErrorThe system meets an error while executing your request, contact us please服务异常，可能是遇到了网络抖动可重试请求
4. 响应实例
{
    "ResponseMetadata": {
        "RequestId": "202102201115180102251070341C01406F",
        "Action": "QueryCanCall",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": null
    },
    "Result": [
        {
            "customerNumber": "138xxxx1234",
            "businessLineId": 2000001,
            "status": 0,
            "reason": "号码正常"
        }
    ]
}


{
    "ResponseMetadata": {
        "RequestId": "2021022213083801022510709309025AEC",
        "Action": "QueryCanCall",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": null
    },
    "Result": [
        {
            "customerNumber": "138xxxx1234",
            "businessLineId": 2000001,
            "status": -1,
            "reason": "高危号码，禁止呼出"
        }
    ]
}