发送短信验证码。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dypns:SendSmsVerifyCode | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SchemeName | string | 否 | 方案名称，如果不填则为“默认方案”。最多不超过 20 个字符。 | 方案名称 |
| CountryCode | string | 否 | 号码国家编码，默认为 86，目前也仅支持国内号码发送。 | 国家码 |
| PhoneNumber | string | 是 | 手机号。 | 86130****0000 |
| SignName | string | 是 | 签名名称。 | 阿里云 |
| TemplateCode | string | 是 | 短信模板 CODE。 您可以登录短信服务控制台，选择国内消息或国际/港澳台消息，在模板管理页面查看模板 CODE。 说明
必须是已添加、并通过审核的短信模板；且发送国际/港澳台消息时，请使用国际/港澳台短信模板。
| azsq_***** |
| TemplateParam | string | 是 | 短信模板变量填写的参数值。验证码位置使用"##code##"替代。 示例：如模板内容为：“您的验证码是${authCode}，5 分钟内有效，请勿告诉他人。”。此时，该字段传入：{"authCode":"##code##"} 注意 上文中的 authCode 请替换成您实际申请的验证码模板中的参数名称 说明
| {"code":"##code##"} |
| SmsUpExtendCode | string | 否 | 上行短信扩展码。上行短信指发送给通信服务提供商的短信，用于定制某种服务、完成查询，或是办理某种业务等，需要收费，按运营商普通短信资费进行扣费。 说明
扩展码是生成签名时系统自动默认生成的，不支持自行传入。无特殊需要此字段的用户请忽略此字段。如需使用，请联系您的商务经理。
| 1213123 |
| OutId | string | 否 | 外部流水号。 | 外部流水号（透传） |
| CodeLength | long | 否 | 验证码长度支持 4～8 位长度，默认是 4 位。 | 4 |
| ValidTime | long | 否 | 验证码有效时长，单位秒，默认为 300 秒。 | 300 |
| DuplicatePolicy | long | 否 | 核验规则，当有效时间内对同场景内的同号码重复发送验证码时，旧验证码如何处理。
| 1 |
| Interval | long | 否 | 时间间隔，单位：秒。即多久间隔可以发送一次验证码，用于频控，默认 60 秒。 | 60 |
| CodeType | long | 否 | 生成的验证码类型，默认为 1。
| 1 |
| ReturnVerifyCode | boolean | 否 | 是否返回验证码。
| false |
返回参数
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "无",
"Message": "成功 ",
"Model": {
"VerifyCode": "42324",
"RequestId": "API-reqelekrqkllkkewrlwrjlsdfsdf",
"OutId": "1231231313",
"BizId": "112231421412414124123^4"
},
"Code": "OK",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史