调用GetSmsAuthTokens接口获取短信验证码授权Token。
接口说明
准备工作
请先完成阿里云账号注册、获取阿里云访问密钥、创建认证方案等操作，更多信息，请参见短信认证使用流程。
QPS 限制
本接口的单用户 QPS 限制为 5000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dypns:GetSmsAuthTokens | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PackageName | string | 否 | 包名。OsType 为 Android 时必传。 | com.aliqin.mytel.test |
| SignName | string | 否 | 签名。OsType 为 Android 时必传。 | 47fcc6615485e83b4100433**** |
| SceneCode | string | 是 | 方案号。 | FC100000134840112 |
| OsType | string | 是 | 系统类型。取值：Android 或 iOS。 | Android |
| BundleId | string | 否 | iOS 应用 ID。OsType 为 iOS 时必传。 | 12345**** |
| Expire | long | 是 | Token 有效期（单位：秒），最小 900，最大 43200。 | 900 |
| SmsTemplateCode | string | 是 | 短信模板 Code。 | SMS_13987**** |
| SmsCodeExpire | integer | 否 | 短信验证码有效期（单位：秒），默认 180。 | 60 |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "请求成功",
"RequestId": "8906582E-6722",
"Data": {
"BizToken": "FZSMeRbLCiapIBo65NXNHvGbkGDmhs23XWTZDOtZN0g5n/kqSc2FU27Gc9YhGb6dNn9/L9ZXSYiIB6C6LMLQJjyXjRzt5v6pzZXqnjO4cSuPWYUxJvdc8l8OpucEYe8Mx17HxsHDzj0VC4D5+atcrTpJE6jQ7e2QVNjZIPMwsfxELjQS7c****",
"StsAccessKeySecret": "VboZ4xbZ****",
"StsAccessKeyId": "STS.NSqC****",
"ExpireTime": 1631526326000,
"StsToken": "CAISiQJ1q6Ft5B2yfSjIr5DEDP/BurtW9PemMEfBrEpsOr5K17XjuDz2IHtLfXFsBusYt/U2nWpX5v4clrxIToR7SFbFY9pb6ZhazBisebDGv8HtR3TcFEjiSwapEBfe8JL4QYeQFaHwGJqEb1TDiVUAo9/TfimjWFqIKICAjYUdAP0cQgi/a0gtZr4UXHwAzvUXLnzML/2gHwf3i27LdipStxF7lHl05NbUoKTeyGKH3AGqlLVF9tite8f9NpczBvolDYfpht4RX7HazStd5yJN8KpLl6Fe8V/FxIrGXAAJv0rdbbOFq4Q1c18hOLJHAKtfsvXmlPNpsevfmpnsx****"
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | SmsSignNameNotExist | The specified sms signName is invalid. | 短信签名不存在 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史
Java SDK
您可以通过添加 Maven 依赖安装阿里云 Java SDK。SDK 版本会持续更新，具体版本请以 OpenAPI 页面为准。
JAVA SDK MAVEN 坐标
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>dypnsapi20170525</artifactId>
<version>1.0.6</version>
</dependency>