查询指定号码是否黑名单冻结状态
请求地址：https://cloud-vms.volcengineapi.com
请求方式：POST
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| X-Date | String | 是 | 20201103T104027Z | 鉴权字段。请参考文档中心-火山引擎。 |
Authorization | String | 是 | HMAC-SHA256 Credential*** | 鉴权字段。请参考文档中心-火山引擎。 |
| ServiceName | String | 是 | vms | 服务名称。该接口是vms。 |
| Region | String | 是 | cn-north-1 | 区域名称，固定值cn-north-1。 |
| Content-Type | String | 是 | application/x-www-form-urlencoded |
签名相关header字段参考火山引擎公共参数
| 参数 | 参数类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | QueryCanCall | 接口名称 |
| Version | String | 是 | 2022-01-01 | 接口版本 |
| 参数 | 类型 | 释义 | 描述 |
|---|---|---|---|
| CustomerNumberList | List<String> | 必选 | 号码列表 |
| BusinessLineId | String | 必选 | 账户/业务线唯一标识 |
| CallType | Integer | 必选 | 呼叫类型 1-外呼；2-呼入；3-短信； |
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'
| 参数 | 数据类型 | 描述 |
|---|---|---|
| ResponseMetadata | ResponseMetadata | 响应公共参数。 |
| Result | Result | 响应业务参数。 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| RequestId | string | 请求 ID。 |
| Action | string | 请求的接口名称。 |
| Version | string | 请求的版本号。 |
| Service | string | 请求的服务名称。 |
| Region | string | 请求的区域。 |
| Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。 |
| 参数 | 数据类型 | 实例值 | 描述 |
|---|---|---|---|
customerNumber | String | 138xxxx1234 | 查询号码 |
| businessLineId | Integer | 2000000001 | 查询账户 |
| status | Integer | -1 | 风控状态，0为正常状态，-1为冻结状态 |
| reason | String | 号码正常 | 风控状态说明 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| Code | string | 错误码。 |
| Message | string | 错误信息。 |
火山引擎网关的公共错误码，请参见火山引擎网关公共错误码。
| Code | Message | 说明 | 处理建议 |
|---|---|---|---|
| RequestParametersError | Unexpected Parameters | 参数异常 | 检查请求通话id是否为空 |
| SystemError | The system meets an error while executing your request, contact us please | 服务异常，可能是遇到了网络抖动 | 可重试请求 |
{ "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": "高危号码，禁止呼出" } ] }