检测验证码

最近更新时间:2020-07-13 08:25:35

1. 接口描述

接口请求域名: ds.tencentcloudapi.com 。

检测验证码接口。此接口用于企业电子合同平台通过给用户发送短信验证码,以短信授权方式签署合同。此接口配合发送验证码接口使用。

用户在企业电子合同平台输入收到的验证码后,由企业电子合同平台调用该接口向腾讯云提交确认受托签署合同验证码命令。验证码验证正确时,本次合同签署的授权成功。

默认接口请求频率限制:1000次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CheckVcode。
Version String 公共参数,本接口取值:2018-05-23。
Region String 公共参数,本接口不需要传递此参数。
Module String 模块名VerifyCode
Operation String 操作名CheckVcode
AccountResId String 帐号ID
ContractResId String 合同ID
VerifyCode String 验证码

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 检测验证码

检测验证码

输入示例

https://ds.tencentcloudapi.com/?Action=CheckVcode
&Module=VerifyCode
&Operation=CheckVcode
&AccountResId=dcu-c33uil4ap6
&ContractResId=dcc-79dlei3yb6
&VerifyCode=243545
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "92f683e1-45e4-47f0-bfa3-d1831b1c1342"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.AccountNotOwnContractError 该账号不具有该合同。
FailedOperation.BackendInterfaceResponseHeaderError 后端接口返回头异常,请检查请求参数。
FailedOperation.CheckVcodeError 验证签署验证码失败。
FailedOperation.ContractSignedError 该合同已被签署过。
FailedOperation.DescribeSubplatError 获取子平台信息失败。
FailedOperation.Other 其它。
FailedOperation.SMSCodeExpired 短信验证码已超时。
FailedOperation.SMSCodeLengthWrong 短信校验码长度错误。
FailedOperation.WrongSMSCode 短信验证码不正确。
InternalError.UnknownError 内部错误。
MissingParameter.MOError 找不到 module 或 operation。
ResourceNotFound.AccountNotFound 账户不存在或已删除。
ResourceNotFound.ContractProjectCodeNotFound 合同project_code不存在。
ResourceNotFound.SubplatIdNotFound 子平台ID不存在。
目录