发送短信验证码。
接口说明
- 由于运营商近期加强对短信签名的管控。您自定义的签名面临下发失败问题,推荐您使用号码认证控制台赠送的短信签名和模板进行短信认证。系统赠送签名必须搭配系统赠送模板使用。
- 请确保在使用该接口前,已充分了解号码认证服务产品的收费方式和价格,短信认证服务仅收取短信发送费用(按运营商回执状态计费,短信提交成功但运营商回执失败时不计费),核验服务免费。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dypns:SendSmsVerifyCode | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SchemeName | string | 否 | 方案名称,如果不填则为“默认方案”。最多不超过 20 个字符。 | 测试方案 |
CountryCode | string | 否 | 号码国家编码。默认为 86,目前也仅支持国内号码发送。 | 86 |
PhoneNumber | string | 是 | 短信接收方手机号。 | 130****0000 |
SignName | string | 是 | 签名名称。暂不支持使用自定义签名,请使用系统赠送的签名,您可在赠送签名配置页面选择需要下发的签名。 | 速通互联验证码 |
TemplateCode | string | 是 | 短信模板 CODE。参数 | 100001 |
TemplateParam | string | 是 | 短信模板参数。验证码位置有两种传值方式:
示例:如模板内容为:“您的验证码是${authCode},有效期${min}分钟,请勿告诉他人。”。该字段可传入 注意 上文中的 authCode 请替换成您实际申请的验证码模板中的参数名称 说明
| {"authCode":"##code##","min":"5"} 或 {"authCode":"123456","min":"5"} |
SmsUpExtendCode | string | 否 | 上行短信扩展码。上行短信指发送给通信服务提供商的短信,用于定制某种服务、完成查询,或是办理某种业务等,需要收费,按运营商普通短信资费进行扣费。 说明
扩展码是生成签名时系统自动默认生成的,不支持自行传入。无特殊需要此字段的用户请忽略此字段。如需使用,请联系您的商务经理。
| 1213123 |
OutId | string | 否 | 外部流水号。 | 外部流水号(透传) |
CodeLength | long | 否 | 验证码长度支持 4~8 位长度,默认是 4 位。 | 4 |
ValidTime | long | 否 | 验证码有效时长,单位秒,默认为 300 秒。 | 300 |
DuplicatePolicy | long | 否 | 核验规则,当有效时间内对同场景内的同号码重复发送验证码时,旧验证码如何处理。
| 1 |
Interval | long | 否 | 时间间隔,单位:秒。即多久间隔可以发送一次验证码,用于频控,默认 60 秒。 | 60 |
CodeType | long | 否 | 生成的验证码类型。当参数 TemplateParam 传入占位符时,此参数必填,将由系统根据指定的规则生成验证码。取值:
| 1 |
ReturnVerifyCode | boolean | 否 | 是否返回验证码。取值:
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"AccessDeniedDetail": "无",
"Message": "成功 ",
"Model": {
"VerifyCode": 4232,
"RequestId": "a3671ccf-0102-4c8e-8797-a3678e091d09",
"OutId": 1231231313,
"BizId": "112231421412414124123^4"
},
"Code": "OK",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MOBILE_NUMBER_ILLEGAL | The mobile number is illegal. | 手机号码格式错误 |
400 | BUSINESS_LIMIT_CONTROL | The number has exceeded the limit for the day. | 触发号码天级流控 |
400 | FREQUENCY_FAIL | Check frequency fail. | 频控校验未通过 |
400 | INVALID_PARAMETERS | parameter is not valid. | 非法参数 |
400 | FUNCTION_NOT_OPENED | You have not opened this function. | 没有开通融合认证功能 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|