将指定号码添加到黑名单
请求方式：POST
接口地址：https://cloud-vms.volcengineapi.com
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| 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 | 指定请求消息体的结构化格式。语音服务的 Content-Type 为 |
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | AddBlackList | 接口名称。该接口固定值为AddBlackList。 |
| Version | String | 是 | 2022-01-01 | 接口版本。语音服务默认接口版本为2022-01-01。 |
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| CustomerNumber | String | 是 | 17192359307 | 需要冻结的号码 |
| ServiceType | Integer | 是 | 100 | 参考 枚举-服务类型 |
| SubServiceType | Integer | 是 | 101 | 参考 枚举-子服务类型 |
| Type | Integer | 是 | 1 | 限制类型。1-外呼限制，5-A号码绑定限制，6-B号码绑定限制，7-B号码呼叫限制（A->B），8-A号码呼叫限制（A->B），9-B号码呼叫限制（B->A），10-A号码呼叫限制（B->A） |
| FreezeTime | Integer | 是 | 12 | 冻结时长。12-黑名单冻结30天，13-黑名单冻结90天，14-黑名单冻结180天，15-黑名单冻结360天，29-黑名单永久冻结 |
| Remark | String | 是 | 黑名单冻结 | 备注 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| ResponseMetadata | ResponseMetadata | 响应公共参数。包含的参数说明请参见 ResponseMetadata。 |
| Result | String | 请求成功时，为success。 请求出现异常时，不设置该字段，可根据Error参数查看错误信息。 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| RequestId | String | 请求 ID。 |
| Action | String | 请求的接口名称。 |
| Version | String | 请求的版本号。 |
| Service | String | 请求的服务名称。 |
| Region | String | 请求的区域。 |
| Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| Code | String | 错误码。 |
| Message | String | 错误信息。 |
curl --location 'https://cloud-vms.volcengineapi.com' \ --header 'AccessKey: XXX' \ --header 'SecretKey: XXX' \ --header 'ServiceName: vms' \ --header 'Region: cn-north-1' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'Action=AddBlackList' \ --data-urlencode 'Version=2022-01-01' \ --data-urlencode 'CustomerNumber=17192359307' \ --data-urlencode 'ServiceType=100' \ --data-urlencode 'SubServiceType=101' \ --data-urlencode 'Type=1' \ --data-urlencode 'FreezeTime=13' \ --data-urlencode 'Remark=test'
{ "ResponseMetadata": { "RequestId": "2024120414353507E6E4801F522B0CCC48", "Action": "AddBlackList", "Version": "2022-01-01", "Service": "vms", "Region": "cn-north-1", "Error": null }, "Result": "success" }
{ { "ResponseMetadata": { "RequestId": "2024120414322154818220248E380DAFF1", "Action": "AddBlackList", "Version": "2022-01-01", "Service": "vms", "Region": "cn-north-1", "Error": { "Code": "-1", "Message": "error message" } }, "Result": null } }