调用CreateVerifyScheme创建认证方案_号码认证服务(PNVS)-阿里云帮助中心

调用CreateVerifyScheme创建认证方案。

接口说明

QPS 限制

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
SchemeName	string	是	方案名称。	一键登录认证方案
AppName	string	是	App 名称。	阿里云通信
OsType	string	是	终端操作系统类型，取值：iOS、Android 或 Web。	iOS
PackName	string	否	包名，osType 为 Android 时必选。由数字、字母、短划线（-）、下划线或点组成，长度限制为 1~128 个字符。	com.aliyun
PackSign	string	否	包签名，osType 为 Android 时必选。由数字和字母组成，长度为 32 个字符。	123aliyun
BundleId	string	否	BundleID，osType 为 iOS 时必选。由数字、字母、短划线（-）、下划线或点组成，长度限制为 1~128 个字符。	example.aliyundoc.com
Origin	string	否	H5 方案页面源地址（建议填写域名级别）。	https://h5.minexiot.com
Url	string	否	H5 方案使用的页面地址。	https://h5.minexiot.com/
IpWhiteList	string	否	IP 白名单，默认可不填。	139.9.xx.xx 122.112.xx.xx 139.9.xx.xx/24
CmApiCode	long	否	中国移动通道 Code，默认可不填。	1
CuApiCode	long	否	中国联通通道 Code，默认可不填。	2
CtApiCode	long	否	中国电信通道 Code，默认可不填。	3
SceneType	string	否	方案类型，默认可不填。	0
Email	string	否	密钥获取接收邮箱地址，默认可不填。	username@aliyundoc.com
AuthType	string	否	认证类型，默认不填，只有支持号码认证时可多选，以英文逗号间隔。 1：号码认证 2：短信认证	1,2
SmsSignName	string	否	绑定的短信签名，只有 AuthType 包含 2（短信认证）时才有效，且签名必须是号码认证产品下创建的已经审核通过的。	阿里云短信测试专用

返回参数

名称	类型	描述	示例值
	object
Message	string	状态码的描述。	请求成功
RequestId	string	请求 ID。	A1E75E69-3049-5FDB-A376-D745837CD2B1
GateVerifySchemeDTO	object	结构体。
SchemeCode	string	方案号。	FC10001287****
HttpStatusCode	long	HTTP 状态码。	200
Code	string	状态码。返回 OK 代表请求成功。其他错误码，请参见服务端 API 返回码。	OK
Success	boolean	请求是否成功。 true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "Message": "请求成功",
  "RequestId": "A1E75E69-3049-5FDB-A376-D745837CD2B1",
  "GateVerifySchemeDTO": {
    "SchemeCode": "FC10001287****"
  },
  "HttpStatusCode": 200,
  "Code": "OK",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	SchemeNumberOverLimit	The maximum number of scheme is exceeded.	号码认证方案数量超过限制
400	BundleIdConflict	The specified bundleId already exists.	bundleId已存在
400	InvalidParameters	The specified parameter is not valid.	参数无效
400	InvalidAccountStatus	Your account has been suspended.	您的账号已被停机。
400	RamPermissionDeny	The user is not authorized to operate on the specified resource.	没有访问权限
400	PackageSignedConflict	The specified package signed already exists.	包名签名已存在
400	Unsupported.Account	Your account has not activated the product.	你的账号没有开通本产品。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-06-07	OpenAPI 错误码发生变更	查看变更详情
2022-11-24	OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情