1. 接口描述
接口请求域名： smh.tencentcloudapi.com 。
验证短信验证码以换绑官方云盘实例的超级管理员账号
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：VerifySmsCode。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-12。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Purpose | 是 | String | 验证码目的，当前支持换绑超级管理员账号，BindSuperAdmin；体验版企业升级验证ChannelUpdateVerify，等 示例值：BindSuperAdmin |
| PhoneNumber | 是 | String | 将作为超级管理员账号的手机号码 示例值：18988888888 |
| Code | 是 | String | 短信验证码 示例值：1234 |
| InstanceId | 否 | String | 官方云盘实例 ID 示例值：tyc9msci |
| CountryCode | 否 | String | 将作为超级管理员账号的手机号码的国家代码。默认为 +86。 示例值：+86 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 验证短信验证码
输入示例
POST / HTTP/1.1
Host: smh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifySmsCode
<公共请求参数>
{
"Purpose": "BindSuperAdmin",
"InstanceId": "n0v9tdme",
"PhoneNumber": "18999999999",
"Code": "1234"
}输出示例
{
"Response": {
"RequestId": "98a878b5-8c16-4788-a7e7-4b1a19a461db"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.CountryCode | 指定的国家代码无效。 |
| InvalidParameterValue.PhoneNumber | 指定的手机号码无效。 |
| LimitExceeded.UserLimit | 已达到用户数量限制，请先升级产品规格。 |
| ResourceNotFound.OfficialInstance | 官方云盘实例不存在或不属于当前账号。 |
| UnauthorizedOperation.SmsCode | 短信验证码错误或已过期。 |
| UnauthorizedOperation.SmsCodeExceeded | 短信验证码验证次数超限，请重新发送短信验证码。 |
| UnsupportedOperation.Purpose | 指定的目的不受支持。 |
