文档

CheckSmsVerifyCode - 核验验证码

更新时间:

核验短信验证码。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dypns:CheckSmsVerifyCodeWrite
  • acs:dypns:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
SchemeNamestring

方案名称,如果不填则为“默认方案”。最多不超过 20 个字符。

测试方案
CountryCodestring

号码国家编码,默认为 86。

86
PhoneNumberstring

手机号。

186****0000
OutIdstring

外部流水号。

12123231
VerifyCodestring

验证码。

1231
CaseAuthPolicylong

验证码大小写字母核验策略。

  • 1:不区分大小写。
  • 2:区分大小写。
1

返回参数

名称类型描述示例值
object
AccessDeniedDetailstring

访问被拒绝详细信息。

Messagestring

状态码的描述。

成功
Modelobject

请求结果数据。

OutIdstring

外部流水号。

1212312
VerifyResultstring

认证结果。

  • PASS:认证成功

  • UNKNOWN:认证失败

PASS
Codestring

状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见返回码

OK
Successboolean

是否调用成功。

  • true:成功

  • false:失败

false

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "无",
  "Message": "成功",
  "Model": {
    "OutId": "1212312",
    "VerifyResult": "PASS"
  },
  "Code": "OK",
  "Success": false
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-03API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈