本产品(
云通信号码认证服务/2017-05-25
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
融合认证(基于原子能力)
API | 标题 | API概述 |
---|---|---|
短信认证服务 | 短信认证服务 | |
SendSmsVerifyCode | 发送短信验证码 | 发送短信验证码。 |
CheckSmsVerifyCode | 核验验证码 | 核验短信验证码并返回核验是否成功的结果。 |
融合认证(基于场景)
API | 标题 | API概述 |
---|---|---|
GetFusionAuthToken | 融合认证获取鉴权token | 融合认证客户端完成初始化操作后,由开发者服务器发起调用此接口,获取鉴权Token。获取到的鉴权Token用于传入SDK进行鉴权。 |
VerifyWithFusionAuthToken | 融合认证获取认证结果 | 融合认证客户端发起认证时,由开发者服务器通过鉴权Token换取的认证Token向阿里云发起本次调用,获取认证结果。 |
号码认证
API | 标题 | API概述 |
---|---|---|
客户端一键登录和本机号码校验 | 客户端一键登录和本机号码校验 | |
VerifyMobile | 本机号码校验认证 | 调用本接口进行本机号码校验认证,认证完成后返回认证结果。 |
GetMobile | 一键登录取号 | 本接口用于号码认证服务端一键登录取号,成功取得号码后会将号码返回。 |
H5一键登录和本机号码校验 | H5一键登录和本机号码校验 | |
GetAuthToken | 获取 H5 认证授权 Token | 获取授权Token用于H5本机号码校验的鉴权,返回结果包括AccessToken和JwtToken。 |
GetPhoneWithToken | 一键登录取号(H5能力专用) | 本接口用于号码认证服务端(H5能力专用)一键登录取号,成功取得号码后会将号码返回。 |
VerifyPhoneWithToken | 本机号码校验(H5能力专用) | 调用本接口进行H5页面本机号码校验认证,认证完成后返回认证结果。 |
短信认证
API | 标题 | API概述 |
---|---|---|
GetSmsAuthTokens | 获取短信验证码授权Token | 调用GetSmsAuthTokens接口获取短信验证码授权Token。 |
VerifySmsCode | 完成短信验证码校验 | 调用VerifySmsCode接口完成短信验证码校验,校验完成后返回认证结果。 |
通信授权服务
API | 标题 | API概述 |
---|---|---|
GetAuthorizationUrl | 获取授权链接 | 获取支付宝授权链接。 |
认证方案管理
API | 标题 | API概述 |
---|---|---|
CreateSchemeConfig | 创建融合认证方案号 | 融合认证方案用于标识App下的认证场景,一般一个认证方案对应一个App包名、包签名。调用本接口创建融合认证方案并获取方案Code。 |
CreateVerifyScheme | 创建认证方案 | 认证方案用于标识App下的认证场景,一般一个认证方案对应一个App名称、App包名、包签名等信息(接入端不同对应所需参数也不同),调用本接口创建认证方案。 |
DeleteVerifyScheme | 删除认证方案 | 如果您不再使用某个认证方案,需要删除方案时,调用此接口或在号码认证服务控制台删除认证方案。 |
DescribeVerifyScheme | 获取认证方案密钥 | 调用其他API接口时会用到认证方案密钥等参数信息,本接口用于获取认证方案密钥信息。 |
用量及费用统计
API | 标题 | API概述 |
---|---|---|
QueryGateVerifyStatisticPublic | 查询用量情况 | 调用此接口查看统计日期范围内,某个认证方式的总调用量、调用成功量、调用失败量、调用未知量,及每一天的用量统计。 |
QueryGateVerifyBillingPublic | 查询费用情况 | 调用此接口查询某种认证方式下的月份费用账单。 |