当然可以,我已经成功获取到你当前查看的阿里云 SendSmsVerifyCode(发送短信验证码)API 文档页面内容。下面我为你整理成结构清晰、可直接用于开发的 API 接口说明。
(阿里云云通信号码认证服务 · 2017-05-25)
用于向指定手机号发送短信验证码。短信认证服务仅收取短信发送费用,核验服务免费。
调用该 API 需要以下权限:
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dypns:SendSmsVerifyCode | Create | 全部资源 | 无 | 无 |
(来自页面授权信息)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| SchemeName | string | 否 | 方案名称,不填为“默认方案”,≤20字符 |
| CountryCode | string | 否 | 国家码,默认 86,仅支持国内号码 |
| PhoneNumber | string | 是 | 接收短信的手机号 |
| SignName | string | 是 | 签名名称,仅支持系统赠送签名 |
| TemplateCode | string | 是 | 模板 CODE,必须与赠送签名匹配 |
| TemplateParam | string | 否 | 模板参数,如 {"code":"##code##","min":"5"} |
| SmsUpExtendCode | string | 否 | 上行扩展码 |
| OutId | string | 否 | 外部流水号(透传) |
| CodeLength | integer | 否 | 验证码长度 4–8,默认 4 |
| ValidTime | integer | 否 | 有效期(秒),默认 300 |
| DuplicatePolicy | integer | 否 | 重复发送策略(1/2) |
| Interval | integer | 否 | 发送间隔(秒),默认 60 |
| CodeType | integer | 否 | 验证码类型(1–7) |
| ReturnVerifyCode | boolean | 否 | 是否返回验证码 |
| AutoRetry | integer | 否 | 是否自动替换签名重试(默认开启) |
(所有字段均来自页面内容)
| 字段名 | 类型 | 说明 |
|---|---|---|
| AccessDeniedDetail | string | 拒绝详情 |
| Message | string | 状态描述,如“成功” |
| RequestId | string | 请求 ID |
| Model | object | 结果数据(含 VerifyCode、BizId 等) |
| Code | string | 状态码,OK 表示成功 |
| Success | boolean | 是否成功 |
示例返回(来自页面):
{
"AccessDeniedDetail": "无",
"Message": "成功",
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"Model": {
"VerifyCode": "4232",
"RequestId": "a3671ccf-0102-4c8e-8797-a3678e091d09",
"OutId": "1231231313",
"BizId": "112231421412414124123^4"
},
"Code": "OK",
"Success": true
}
| HTTP 状态码 | 错误码 | 描述 |
|---|---|---|
| 400 | MOBILE_NUMBER_ILLEGAL | 手机号非法 |
| 400 | BUSINESS_LIMIT_CONTROL | 当天发送次数超限 |
| 400 | FREQUENCY_FAIL | 频控失败 |
| 400 | INVALID_PARAMETERS | 参数非法 |
| 400 | FUNCTION_NOT_OPENED | 未开通该功能 |
(来自页面错误码列表)
最近一次变更: