CreateVerifyScheme
认证方案用于标识App下的认证场景,一般一个认证方案对应一个App名称、App包名、包签名等信息(接入端不同对应所需参数也不同),调用本接口创建认证方案
服务地址:
华东1 金融云
输入参数
只看必填
SchemeName方案名称
AppNameApp名称
OsType终端操作系统类型
PackName包名
PackSign包签名
BundleIdBundleID
OriginH5方案页面源地址(建议填写域名级别)
UrlH5方案使用的页面地址
IpWhiteListIP白名单
CmApiCode中国移动通道Code
CuApiCode中国联通通道Code
CtApiCode中国电信通道Code
SceneType方案类型
Email密钥获取接收邮箱地址
AuthType认证类型
SmsSignName绑定的短信签名
HmPackageName
HmSignName
HmAppIdentifier
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

QPS 限制

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

请求参数

字段名称字段详情
SchemeNamestring

方案名称。

示例值:一键登录认证方案参考取值来源:
    CreateSchemeConfig
AppNamestring

App 名称。

示例值:阿里云通信
OsTypestring

终端操作系统类型,取值:iOS、Android 或 Web。

示例值:iOS
PackNamestring

包名,osType 为 Android 时必选。由数字、字母、短划线(-)、下划线或点组成,长度限制为 1~128 个字符。

示例值:com.aliyun
PackSignstring

包签名,osType 为 Android 时必选。由数字和字母组成,长度为 32 个字符。

示例值:123aliyun
BundleIdstring

BundleID,osType 为 iOS 时必选。由数字、字母、短划线(-)、下划线或点组成,长度限制为 1~128 个字符。

示例值:example.aliyundoc.com
Originstring

H5 方案页面源地址(建议填写域名级别)。

示例值:https://h5.minexiot.com
Urlstring

H5 方案使用的页面地址。

示例值:https://h5.minexiot.com/
IpWhiteListstring

IP 白名单,默认可不填。

示例值:139.9.xx.xx 122.112.xx.xx 139.9.xx.xx/24
CmApiCodeinteger<int64>

中国移动通道 Code,默认可不填。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
CuApiCodeinteger<int64>

中国联通通道 Code,默认可不填。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:2
CtApiCodeinteger<int64>

中国电信通道 Code,默认可不填。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:3
SceneTypestring

方案类型,默认可不填。

示例值:0
Emailstring

密钥获取接收邮箱地址,默认可不填。

示例值:username@aliyundoc.com
AuthTypestring

认证类型,默认不填,只有支持号码认证时可多选,以英文逗号间隔。展开详情

示例值:1,2
SmsSignNamestring

绑定的短信签名,只有 AuthType 包含 2(短信认证)时才有效,且签名必须是号码认证产品下创建的已经审核通过的。

示例值:阿里云短信测试专用
HmPackageNamestring
HmSignNamestring
HmAppIdentifierstring

返回参数

字段名称字段详情
Messagestring

状态码的描述。

示例值:请求成功
RequestIdstring

请求 ID。

示例值:A1E75E69-3049-5FDB-A376-D745837CD2B1
GateVerifySchemeDTOobject

结构体。

HttpStatusCodeinteger<int64>

HTTP 状态码。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:200
Codestring

状态码。展开详情

示例值:OK
Successboolean

请求是否成功。展开详情

示例值:true
变更历史
变更时间变更内容概要操作
2024-10-18
新增请求参数HmPackageName
新增请求参数HmSignName
新增请求参数HmAppIdentifier
2022-11-24
新增请求参数Origin
新增请求参数Url
新增请求参数IpWhiteList
新增请求参数CmApiCode
新增请求参数CuApiCode
新增请求参数CtApiCode
新增请求参数SceneType
新增请求参数Email
新增请求参数SmsSignName
变更返回参数
2021-12-24
新增错误码400