1. 接口描述
接口请求域名： ccc.tencentcloudapi.com 。
停用号码
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DisableCCCPhoneNumber。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-10。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| PhoneNumbers.N | 是 | Array of String | 号码列表，0086开头 示例值：['00860755XXXX','0086021XXXX'] |
| Disabled | 是 | Integer | 停用开关，0启用 1停用 示例值：1 |
| SdkAppId | 否 | Integer | TCCC 实例应用 ID 示例值：1400000000 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 停用号码示例
停用号码。
输入示例
POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DisableCCCPhoneNumber
<公共请求参数>
{
"SdkAppId": 1,
"PhoneNumbers": [
"008602112345678"
],
"Disabled": 0
}输出示例
{
"Response": {
"RequestId": "3651cda6-6501-4482-9f4e-8d0c9548a4db"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CurStateNotAllowModify | 当前号码状态不能被修改。 |
| InternalError.DBError | 内部数据库访问失败。 |
| InvalidParameter.DuplicateAddress | 重复的地址 |
| InvalidParameter.DuplicatePhoneNumber | 重复的号码 |
| InvalidParameter.DuplicateSipAccount | 重复的SIP账号 |
| InvalidParameter.IllegalAddress | 非法的地址 |
| InvalidParameter.IllegalPhoneNumber | 非法的号码 |
| InvalidParameter.InvalidAddress | 无效的地址 |
| InvalidParameter.InvalidIP | 无效的IP信息 |
| InvalidParameter.InvalidPhoneNumber | 无效的号码 |
| InvalidParameter.InvalidPort | 无效的端口信息 |
| InvalidParameter.SipAccountPasswordFormat | 密码不合法(长度大于等于八位，必须包含大小写字母以及数字) |
| InvalidParameter.SipAccountUserFormat | 用户名不合法(只能包含A-Z、a-z、以及数字) |
| InvalidParameter.SipTrunkInUsed | SIP通道仍在使用中 |
| InvalidParameter.SipTrunkNotFound | 未找到SIP通道信息 |
| InvalidParameterValue | 参数取值错误。 |