首页 号码认证服务 API参考 API目录 短信认证 GetSmsAuthTokens - 获取短信验证码授权Token

GetSmsAuthTokens - 获取短信验证码授权Token

调用GetSmsAuthTokens接口获取短信验证码授权Token。

接口说明

准备工作

请先完成阿里云账号注册、获取阿里云访问密钥、创建认证方案等操作,更多信息,请参见短信认证使用流程

QPS限制

本接口的单用户QPS限制为5000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

包名。OsType为Android时必传。

com.aliqin.mytel.test
SignNamestring

签名。OsType为Android时必传。

47fcc6615485e83b4100433****
SceneCodestring

方案号。

FC100000134840112
OsTypestring

系统类型。取值:AndroidiOS

Android
BundleIdstring

iOS应用ID。OsType为iOS时必传。

12345****
Expirelong

Token有效期(单位:秒),最小900,最大43200。

900
SmsTemplateCodestring

短信模板Code。

SMS_13987****
SmsCodeExpireinteger

短信验证码有效期(单位:秒),默认180。

60

返回参数

名称类型描述示例值
object
Codestring

请求状态码。

OK
Messagestring

状态码的描述。

请求成功
RequestIdstring

请求ID。

8906582E-6722
Dataobject

结构体。

BizTokenstring

业务Token。

FZSMeRbLCiapIBo65NXNHvGbkGDmhs23XWTZDOtZN0g5n/kqSc2FU27Gc9YhGb6dNn9/L9ZXSYiIB6C6LMLQJjyXjRzt5v6pzZXqnjO4cSuPWYUxJvdc8l8OpucEYe8Mx17HxsHDzj0VC4D5+atcrTpJE6jQ7e2QVNjZIPMwsfxELjQS7c****
StsAccessKeySecretstring

访问密钥。

VboZ4xbZ****
StsAccessKeyIdstring

访问密钥ID。

STS.NSqC****
ExpireTimelong

过期时间。时间戳表示。

1631526326000
StsTokenstring

安全令牌。

CAISiQJ1q6Ft5B2yfSjIr5DEDP/BurtW9PemMEfBrEpsOr5K17XjuDz2IHtLfXFsBusYt/U2nWpX5v4clrxIToR7SFbFY9pb6ZhazBisebDGv8HtR3TcFEjiSwapEBfe8JL4QYeQFaHwGJqEb1TDiVUAo9/TfimjWFqIKICAjYUdAP0cQgi/a0gtZr4UXHwAzvUXLnzML/2gHwf3i27LdipStxF7lHl05NbUoKTeyGKH3AGqlLVF9tite8f9NpczBvolDYfpht4RX7HazStd5yJN8KpLl6Fe8V/FxIrGXAAJv0rdbbOFq4Q1c18hOLJHAKtfsvXmlPNpsevfmpnsx****

示例

正常返回示例

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错误码错误信息描述
400SmsSignNameNotExistThe 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>
阿里云首页 号码认证服务 相关技术圈