ai_v/venv/Lib/site-packages/alibabacloud_dypnsapi20170525/client.py

2647 lines
128 KiB
Python
Raw Normal View History

feat(api): 实现图像生成及后台同步功能 - 新增图像生成接口,支持试用、积分和自定义API Key模式 - 实现生成图片结果异步上传至MinIO存储,带重试机制 - 优化积分预扣除和异常退还逻辑,保障用户积分准确 - 添加获取生成历史记录接口,支持时间范围和分页 - 提供本地字典配置接口,支持模型、比例、提示模板和尺寸 - 实现图片批量上传接口,支持S3兼容对象存储 feat(admin): 增加管理员角色管理与权限分配接口 - 实现角色列表查询、角色创建、更新及删除功能 - 增加权限列表查询接口 - 实现用户角色分配接口,便于统一管理用户权限 - 增加系统字典增删查改接口,支持分类过滤和排序 - 权限控制全面覆盖管理接口,保证安全访问 feat(auth): 完善用户登录注册及权限相关接口与页面 - 实现手机号验证码发送及校验功能,保障注册安全 - 支持手机号注册、登录及退出接口,集成日志记录 - 增加修改密码功能,验证原密码后更新 - 提供动态导航菜单接口,基于权限展示不同菜单 - 实现管理界面路由及日志、角色、字典管理页面访问权限控制 - 添加系统日志查询接口,支持关键词和等级筛选 feat(app): 初始化Flask应用并配置蓝图与数据库 - 创建应用程序工厂,加载配置,初始化数据库和Redis客户端 - 注册认证、API及管理员蓝图,整合路由 - 根路由渲染主页模板 - 应用上下文中自动创建数据库表,保证运行环境准备完毕 feat(database): 提供数据库创建与迁移支持脚本 - 新增数据库创建脚本,支持自动检测是否已存在 - 添加数据库表初始化脚本,支持创建和删除所有表 - 实现RBAC权限初始化,包含基础权限和角色创建 - 新增字段手动修复脚本,添加用户API Key和积分字段 - 强制迁移脚本支持清理连接和修复表结构,初始化默认数据及角色分配 feat(config): 新增系统配置参数 - 配置数据库、Redis、Session和MinIO相关参数 - 添加AI接口地址及试用Key配置 - 集成阿里云短信服务配置及开发模式相关参数 feat(extensions): 初始化数据库、Redis和MinIO客户端 - 创建全局SQLAlchemy数据库实例和Redis客户端 - 配置基于boto3的MinIO兼容S3客户端 chore(logs): 添加示例系统日志文件 - 记录用户请求、验证码发送成功与失败的日志信息
2026-01-12 00:53:31 +08:00
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
from typing import Dict
from Tea.core import TeaCore
from alibabacloud_tea_openapi.client import Client as OpenApiClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_util.client import Client as UtilClient
from alibabacloud_endpoint_util.client import Client as EndpointUtilClient
from alibabacloud_dypnsapi20170525 import models as dypnsapi_20170525_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_openapi_util.client import Client as OpenApiUtilClient
class Client(OpenApiClient):
"""
*\
"""
def __init__(
self,
config: open_api_models.Config,
):
super().__init__(config)
self._endpoint_rule = 'central'
self.check_config(config)
self._endpoint = self.get_endpoint('dypnsapi', self._region_id, self._endpoint_rule, self._network, self._suffix, self._endpoint_map, self._endpoint)
def get_endpoint(
self,
product_id: str,
region_id: str,
endpoint_rule: str,
network: str,
suffix: str,
endpoint_map: Dict[str, str],
endpoint: str,
) -> str:
if not UtilClient.empty(endpoint):
return endpoint
if not UtilClient.is_unset(endpoint_map) and not UtilClient.empty(endpoint_map.get(region_id)):
return endpoint_map.get(region_id)
return EndpointUtilClient.get_endpoint_rules(product_id, region_id, endpoint_rule, network, suffix)
def check_sms_verify_code_with_options(
self,
request: dypnsapi_20170525_models.CheckSmsVerifyCodeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.CheckSmsVerifyCodeResponse:
"""
@summary Verifies SMS verification codes.
@param request: CheckSmsVerifyCodeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: CheckSmsVerifyCodeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.case_auth_policy):
query['CaseAuthPolicy'] = request.case_auth_policy
if not UtilClient.is_unset(request.country_code):
query['CountryCode'] = request.country_code
if not UtilClient.is_unset(request.out_id):
query['OutId'] = request.out_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_name):
query['SchemeName'] = request.scheme_name
if not UtilClient.is_unset(request.verify_code):
query['VerifyCode'] = request.verify_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='CheckSmsVerifyCode',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.CheckSmsVerifyCodeResponse(),
self.call_api(params, req, runtime)
)
async def check_sms_verify_code_with_options_async(
self,
request: dypnsapi_20170525_models.CheckSmsVerifyCodeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.CheckSmsVerifyCodeResponse:
"""
@summary Verifies SMS verification codes.
@param request: CheckSmsVerifyCodeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: CheckSmsVerifyCodeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.case_auth_policy):
query['CaseAuthPolicy'] = request.case_auth_policy
if not UtilClient.is_unset(request.country_code):
query['CountryCode'] = request.country_code
if not UtilClient.is_unset(request.out_id):
query['OutId'] = request.out_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_name):
query['SchemeName'] = request.scheme_name
if not UtilClient.is_unset(request.verify_code):
query['VerifyCode'] = request.verify_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='CheckSmsVerifyCode',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.CheckSmsVerifyCodeResponse(),
await self.call_api_async(params, req, runtime)
)
def check_sms_verify_code(
self,
request: dypnsapi_20170525_models.CheckSmsVerifyCodeRequest,
) -> dypnsapi_20170525_models.CheckSmsVerifyCodeResponse:
"""
@summary Verifies SMS verification codes.
@param request: CheckSmsVerifyCodeRequest
@return: CheckSmsVerifyCodeResponse
"""
runtime = util_models.RuntimeOptions()
return self.check_sms_verify_code_with_options(request, runtime)
async def check_sms_verify_code_async(
self,
request: dypnsapi_20170525_models.CheckSmsVerifyCodeRequest,
) -> dypnsapi_20170525_models.CheckSmsVerifyCodeResponse:
"""
@summary Verifies SMS verification codes.
@param request: CheckSmsVerifyCodeRequest
@return: CheckSmsVerifyCodeResponse
"""
runtime = util_models.RuntimeOptions()
return await self.check_sms_verify_code_with_options_async(request, runtime)
def create_scheme_config_with_options(
self,
request: dypnsapi_20170525_models.CreateSchemeConfigRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.CreateSchemeConfigResponse:
"""
@summary Creates a code for a converged communication authentication service.
@param request: CreateSchemeConfigRequest
@param runtime: runtime options for this request RuntimeOptions
@return: CreateSchemeConfigResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.android_package_name):
query['AndroidPackageName'] = request.android_package_name
if not UtilClient.is_unset(request.android_package_sign):
query['AndroidPackageSign'] = request.android_package_sign
if not UtilClient.is_unset(request.app_name):
query['AppName'] = request.app_name
if not UtilClient.is_unset(request.h_5origin):
query['H5Origin'] = request.h_5origin
if not UtilClient.is_unset(request.h_5url):
query['H5Url'] = request.h_5url
if not UtilClient.is_unset(request.ios_bundle_id):
query['IosBundleId'] = request.ios_bundle_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.platform):
query['Platform'] = request.platform
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_name):
query['SchemeName'] = request.scheme_name
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='CreateSchemeConfig',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.CreateSchemeConfigResponse(),
self.call_api(params, req, runtime)
)
async def create_scheme_config_with_options_async(
self,
request: dypnsapi_20170525_models.CreateSchemeConfigRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.CreateSchemeConfigResponse:
"""
@summary Creates a code for a converged communication authentication service.
@param request: CreateSchemeConfigRequest
@param runtime: runtime options for this request RuntimeOptions
@return: CreateSchemeConfigResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.android_package_name):
query['AndroidPackageName'] = request.android_package_name
if not UtilClient.is_unset(request.android_package_sign):
query['AndroidPackageSign'] = request.android_package_sign
if not UtilClient.is_unset(request.app_name):
query['AppName'] = request.app_name
if not UtilClient.is_unset(request.h_5origin):
query['H5Origin'] = request.h_5origin
if not UtilClient.is_unset(request.h_5url):
query['H5Url'] = request.h_5url
if not UtilClient.is_unset(request.ios_bundle_id):
query['IosBundleId'] = request.ios_bundle_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.platform):
query['Platform'] = request.platform
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_name):
query['SchemeName'] = request.scheme_name
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='CreateSchemeConfig',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.CreateSchemeConfigResponse(),
await self.call_api_async(params, req, runtime)
)
def create_scheme_config(
self,
request: dypnsapi_20170525_models.CreateSchemeConfigRequest,
) -> dypnsapi_20170525_models.CreateSchemeConfigResponse:
"""
@summary Creates a code for a converged communication authentication service.
@param request: CreateSchemeConfigRequest
@return: CreateSchemeConfigResponse
"""
runtime = util_models.RuntimeOptions()
return self.create_scheme_config_with_options(request, runtime)
async def create_scheme_config_async(
self,
request: dypnsapi_20170525_models.CreateSchemeConfigRequest,
) -> dypnsapi_20170525_models.CreateSchemeConfigResponse:
"""
@summary Creates a code for a converged communication authentication service.
@param request: CreateSchemeConfigRequest
@return: CreateSchemeConfigResponse
"""
runtime = util_models.RuntimeOptions()
return await self.create_scheme_config_with_options_async(request, runtime)
def create_verify_scheme_with_options(
self,
request: dypnsapi_20170525_models.CreateVerifySchemeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.CreateVerifySchemeResponse:
"""
@summary Creates a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: CreateVerifySchemeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: CreateVerifySchemeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.app_name):
query['AppName'] = request.app_name
if not UtilClient.is_unset(request.auth_type):
query['AuthType'] = request.auth_type
if not UtilClient.is_unset(request.bundle_id):
query['BundleId'] = request.bundle_id
if not UtilClient.is_unset(request.cm_api_code):
query['CmApiCode'] = request.cm_api_code
if not UtilClient.is_unset(request.ct_api_code):
query['CtApiCode'] = request.ct_api_code
if not UtilClient.is_unset(request.cu_api_code):
query['CuApiCode'] = request.cu_api_code
if not UtilClient.is_unset(request.email):
query['Email'] = request.email
if not UtilClient.is_unset(request.hm_app_identifier):
query['HmAppIdentifier'] = request.hm_app_identifier
if not UtilClient.is_unset(request.hm_package_name):
query['HmPackageName'] = request.hm_package_name
if not UtilClient.is_unset(request.hm_sign_name):
query['HmSignName'] = request.hm_sign_name
if not UtilClient.is_unset(request.ip_white_list):
query['IpWhiteList'] = request.ip_white_list
if not UtilClient.is_unset(request.origin):
query['Origin'] = request.origin
if not UtilClient.is_unset(request.os_type):
query['OsType'] = request.os_type
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.pack_name):
query['PackName'] = request.pack_name
if not UtilClient.is_unset(request.pack_sign):
query['PackSign'] = request.pack_sign
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scene_type):
query['SceneType'] = request.scene_type
if not UtilClient.is_unset(request.scheme_name):
query['SchemeName'] = request.scheme_name
if not UtilClient.is_unset(request.sms_sign_name):
query['SmsSignName'] = request.sms_sign_name
if not UtilClient.is_unset(request.url):
query['Url'] = request.url
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='CreateVerifyScheme',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.CreateVerifySchemeResponse(),
self.call_api(params, req, runtime)
)
async def create_verify_scheme_with_options_async(
self,
request: dypnsapi_20170525_models.CreateVerifySchemeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.CreateVerifySchemeResponse:
"""
@summary Creates a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: CreateVerifySchemeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: CreateVerifySchemeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.app_name):
query['AppName'] = request.app_name
if not UtilClient.is_unset(request.auth_type):
query['AuthType'] = request.auth_type
if not UtilClient.is_unset(request.bundle_id):
query['BundleId'] = request.bundle_id
if not UtilClient.is_unset(request.cm_api_code):
query['CmApiCode'] = request.cm_api_code
if not UtilClient.is_unset(request.ct_api_code):
query['CtApiCode'] = request.ct_api_code
if not UtilClient.is_unset(request.cu_api_code):
query['CuApiCode'] = request.cu_api_code
if not UtilClient.is_unset(request.email):
query['Email'] = request.email
if not UtilClient.is_unset(request.hm_app_identifier):
query['HmAppIdentifier'] = request.hm_app_identifier
if not UtilClient.is_unset(request.hm_package_name):
query['HmPackageName'] = request.hm_package_name
if not UtilClient.is_unset(request.hm_sign_name):
query['HmSignName'] = request.hm_sign_name
if not UtilClient.is_unset(request.ip_white_list):
query['IpWhiteList'] = request.ip_white_list
if not UtilClient.is_unset(request.origin):
query['Origin'] = request.origin
if not UtilClient.is_unset(request.os_type):
query['OsType'] = request.os_type
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.pack_name):
query['PackName'] = request.pack_name
if not UtilClient.is_unset(request.pack_sign):
query['PackSign'] = request.pack_sign
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scene_type):
query['SceneType'] = request.scene_type
if not UtilClient.is_unset(request.scheme_name):
query['SchemeName'] = request.scheme_name
if not UtilClient.is_unset(request.sms_sign_name):
query['SmsSignName'] = request.sms_sign_name
if not UtilClient.is_unset(request.url):
query['Url'] = request.url
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='CreateVerifyScheme',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.CreateVerifySchemeResponse(),
await self.call_api_async(params, req, runtime)
)
def create_verify_scheme(
self,
request: dypnsapi_20170525_models.CreateVerifySchemeRequest,
) -> dypnsapi_20170525_models.CreateVerifySchemeResponse:
"""
@summary Creates a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: CreateVerifySchemeRequest
@return: CreateVerifySchemeResponse
"""
runtime = util_models.RuntimeOptions()
return self.create_verify_scheme_with_options(request, runtime)
async def create_verify_scheme_async(
self,
request: dypnsapi_20170525_models.CreateVerifySchemeRequest,
) -> dypnsapi_20170525_models.CreateVerifySchemeResponse:
"""
@summary Creates a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: CreateVerifySchemeRequest
@return: CreateVerifySchemeResponse
"""
runtime = util_models.RuntimeOptions()
return await self.create_verify_scheme_with_options_async(request, runtime)
def delete_verify_scheme_with_options(
self,
request: dypnsapi_20170525_models.DeleteVerifySchemeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.DeleteVerifySchemeResponse:
"""
@summary Deletes a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: DeleteVerifySchemeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: DeleteVerifySchemeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.customer_id):
query['CustomerId'] = request.customer_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_code):
query['SchemeCode'] = request.scheme_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='DeleteVerifyScheme',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.DeleteVerifySchemeResponse(),
self.call_api(params, req, runtime)
)
async def delete_verify_scheme_with_options_async(
self,
request: dypnsapi_20170525_models.DeleteVerifySchemeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.DeleteVerifySchemeResponse:
"""
@summary Deletes a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: DeleteVerifySchemeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: DeleteVerifySchemeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.customer_id):
query['CustomerId'] = request.customer_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_code):
query['SchemeCode'] = request.scheme_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='DeleteVerifyScheme',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.DeleteVerifySchemeResponse(),
await self.call_api_async(params, req, runtime)
)
def delete_verify_scheme(
self,
request: dypnsapi_20170525_models.DeleteVerifySchemeRequest,
) -> dypnsapi_20170525_models.DeleteVerifySchemeResponse:
"""
@summary Deletes a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: DeleteVerifySchemeRequest
@return: DeleteVerifySchemeResponse
"""
runtime = util_models.RuntimeOptions()
return self.delete_verify_scheme_with_options(request, runtime)
async def delete_verify_scheme_async(
self,
request: dypnsapi_20170525_models.DeleteVerifySchemeRequest,
) -> dypnsapi_20170525_models.DeleteVerifySchemeResponse:
"""
@summary Deletes a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: DeleteVerifySchemeRequest
@return: DeleteVerifySchemeResponse
"""
runtime = util_models.RuntimeOptions()
return await self.delete_verify_scheme_with_options_async(request, runtime)
def describe_verify_scheme_with_options(
self,
request: dypnsapi_20170525_models.DescribeVerifySchemeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.DescribeVerifySchemeResponse:
"""
@summary Queries the details of a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: DescribeVerifySchemeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: DescribeVerifySchemeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.customer_id):
query['CustomerId'] = request.customer_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_code):
query['SchemeCode'] = request.scheme_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='DescribeVerifyScheme',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.DescribeVerifySchemeResponse(),
self.call_api(params, req, runtime)
)
async def describe_verify_scheme_with_options_async(
self,
request: dypnsapi_20170525_models.DescribeVerifySchemeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.DescribeVerifySchemeResponse:
"""
@summary Queries the details of a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: DescribeVerifySchemeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: DescribeVerifySchemeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.customer_id):
query['CustomerId'] = request.customer_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_code):
query['SchemeCode'] = request.scheme_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='DescribeVerifyScheme',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.DescribeVerifySchemeResponse(),
await self.call_api_async(params, req, runtime)
)
def describe_verify_scheme(
self,
request: dypnsapi_20170525_models.DescribeVerifySchemeRequest,
) -> dypnsapi_20170525_models.DescribeVerifySchemeResponse:
"""
@summary Queries the details of a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: DescribeVerifySchemeRequest
@return: DescribeVerifySchemeResponse
"""
runtime = util_models.RuntimeOptions()
return self.describe_verify_scheme_with_options(request, runtime)
async def describe_verify_scheme_async(
self,
request: dypnsapi_20170525_models.DescribeVerifySchemeRequest,
) -> dypnsapi_20170525_models.DescribeVerifySchemeResponse:
"""
@summary Queries the details of a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: DescribeVerifySchemeRequest
@return: DescribeVerifySchemeResponse
"""
runtime = util_models.RuntimeOptions()
return await self.describe_verify_scheme_with_options_async(request, runtime)
def get_auth_token_with_options(
self,
request: dypnsapi_20170525_models.GetAuthTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetAuthTokenResponse:
"""
@summary Obtains the authorization token used for the authentication of the phone number verification for HTML5 pages. You can obtain AccessToken and JwtToken after a successful call.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the phone number verification feature for HTML5 pages](https://help.aliyun.com/document_detail/169786.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetAuthTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetAuthTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.biz_type):
query['BizType'] = request.biz_type
if not UtilClient.is_unset(request.cm_api_code):
query['CmApiCode'] = request.cm_api_code
if not UtilClient.is_unset(request.ct_api_code):
query['CtApiCode'] = request.ct_api_code
if not UtilClient.is_unset(request.cu_api_code):
query['CuApiCode'] = request.cu_api_code
if not UtilClient.is_unset(request.origin):
query['Origin'] = request.origin
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scene_code):
query['SceneCode'] = request.scene_code
if not UtilClient.is_unset(request.url):
query['Url'] = request.url
if not UtilClient.is_unset(request.version):
query['Version'] = request.version
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetAuthToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetAuthTokenResponse(),
self.call_api(params, req, runtime)
)
async def get_auth_token_with_options_async(
self,
request: dypnsapi_20170525_models.GetAuthTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetAuthTokenResponse:
"""
@summary Obtains the authorization token used for the authentication of the phone number verification for HTML5 pages. You can obtain AccessToken and JwtToken after a successful call.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the phone number verification feature for HTML5 pages](https://help.aliyun.com/document_detail/169786.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetAuthTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetAuthTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.biz_type):
query['BizType'] = request.biz_type
if not UtilClient.is_unset(request.cm_api_code):
query['CmApiCode'] = request.cm_api_code
if not UtilClient.is_unset(request.ct_api_code):
query['CtApiCode'] = request.ct_api_code
if not UtilClient.is_unset(request.cu_api_code):
query['CuApiCode'] = request.cu_api_code
if not UtilClient.is_unset(request.origin):
query['Origin'] = request.origin
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scene_code):
query['SceneCode'] = request.scene_code
if not UtilClient.is_unset(request.url):
query['Url'] = request.url
if not UtilClient.is_unset(request.version):
query['Version'] = request.version
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetAuthToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetAuthTokenResponse(),
await self.call_api_async(params, req, runtime)
)
def get_auth_token(
self,
request: dypnsapi_20170525_models.GetAuthTokenRequest,
) -> dypnsapi_20170525_models.GetAuthTokenResponse:
"""
@summary Obtains the authorization token used for the authentication of the phone number verification for HTML5 pages. You can obtain AccessToken and JwtToken after a successful call.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the phone number verification feature for HTML5 pages](https://help.aliyun.com/document_detail/169786.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetAuthTokenRequest
@return: GetAuthTokenResponse
"""
runtime = util_models.RuntimeOptions()
return self.get_auth_token_with_options(request, runtime)
async def get_auth_token_async(
self,
request: dypnsapi_20170525_models.GetAuthTokenRequest,
) -> dypnsapi_20170525_models.GetAuthTokenResponse:
"""
@summary Obtains the authorization token used for the authentication of the phone number verification for HTML5 pages. You can obtain AccessToken and JwtToken after a successful call.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the phone number verification feature for HTML5 pages](https://help.aliyun.com/document_detail/169786.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetAuthTokenRequest
@return: GetAuthTokenResponse
"""
runtime = util_models.RuntimeOptions()
return await self.get_auth_token_with_options_async(request, runtime)
def get_authorization_url_with_options(
self,
request: dypnsapi_20170525_models.GetAuthorizationUrlRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetAuthorizationUrlResponse:
"""
@summary Obtains the URL for the Alipay account authorization.
@description ### [](#)Preparations
You must register an Alibaba Cloud account and obtain an Alibaba Cloud AccessKey pair. For more information, see [Process of communication authorization](https://help.aliyun.com/document_detail/196922.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetAuthorizationUrlRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetAuthorizationUrlResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.end_date):
query['EndDate'] = request.end_date
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_no):
query['PhoneNo'] = request.phone_no
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_id):
query['SchemeId'] = request.scheme_id
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetAuthorizationUrl',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetAuthorizationUrlResponse(),
self.call_api(params, req, runtime)
)
async def get_authorization_url_with_options_async(
self,
request: dypnsapi_20170525_models.GetAuthorizationUrlRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetAuthorizationUrlResponse:
"""
@summary Obtains the URL for the Alipay account authorization.
@description ### [](#)Preparations
You must register an Alibaba Cloud account and obtain an Alibaba Cloud AccessKey pair. For more information, see [Process of communication authorization](https://help.aliyun.com/document_detail/196922.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetAuthorizationUrlRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetAuthorizationUrlResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.end_date):
query['EndDate'] = request.end_date
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_no):
query['PhoneNo'] = request.phone_no
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_id):
query['SchemeId'] = request.scheme_id
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetAuthorizationUrl',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetAuthorizationUrlResponse(),
await self.call_api_async(params, req, runtime)
)
def get_authorization_url(
self,
request: dypnsapi_20170525_models.GetAuthorizationUrlRequest,
) -> dypnsapi_20170525_models.GetAuthorizationUrlResponse:
"""
@summary Obtains the URL for the Alipay account authorization.
@description ### [](#)Preparations
You must register an Alibaba Cloud account and obtain an Alibaba Cloud AccessKey pair. For more information, see [Process of communication authorization](https://help.aliyun.com/document_detail/196922.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetAuthorizationUrlRequest
@return: GetAuthorizationUrlResponse
"""
runtime = util_models.RuntimeOptions()
return self.get_authorization_url_with_options(request, runtime)
async def get_authorization_url_async(
self,
request: dypnsapi_20170525_models.GetAuthorizationUrlRequest,
) -> dypnsapi_20170525_models.GetAuthorizationUrlResponse:
"""
@summary Obtains the URL for the Alipay account authorization.
@description ### [](#)Preparations
You must register an Alibaba Cloud account and obtain an Alibaba Cloud AccessKey pair. For more information, see [Process of communication authorization](https://help.aliyun.com/document_detail/196922.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetAuthorizationUrlRequest
@return: GetAuthorizationUrlResponse
"""
runtime = util_models.RuntimeOptions()
return await self.get_authorization_url_with_options_async(request, runtime)
def get_fusion_auth_token_with_options(
self,
request: dypnsapi_20170525_models.GetFusionAuthTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetFusionAuthTokenResponse:
"""
@summary Obtains the verification results by using the token that is obtained from the client SDKs.
@param request: GetFusionAuthTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetFusionAuthTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.bundle_id):
query['BundleId'] = request.bundle_id
if not UtilClient.is_unset(request.duration_seconds):
query['DurationSeconds'] = request.duration_seconds
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.package_name):
query['PackageName'] = request.package_name
if not UtilClient.is_unset(request.package_sign):
query['PackageSign'] = request.package_sign
if not UtilClient.is_unset(request.platform):
query['Platform'] = request.platform
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_code):
query['SchemeCode'] = request.scheme_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetFusionAuthToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetFusionAuthTokenResponse(),
self.call_api(params, req, runtime)
)
async def get_fusion_auth_token_with_options_async(
self,
request: dypnsapi_20170525_models.GetFusionAuthTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetFusionAuthTokenResponse:
"""
@summary Obtains the verification results by using the token that is obtained from the client SDKs.
@param request: GetFusionAuthTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetFusionAuthTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.bundle_id):
query['BundleId'] = request.bundle_id
if not UtilClient.is_unset(request.duration_seconds):
query['DurationSeconds'] = request.duration_seconds
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.package_name):
query['PackageName'] = request.package_name
if not UtilClient.is_unset(request.package_sign):
query['PackageSign'] = request.package_sign
if not UtilClient.is_unset(request.platform):
query['Platform'] = request.platform
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scheme_code):
query['SchemeCode'] = request.scheme_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetFusionAuthToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetFusionAuthTokenResponse(),
await self.call_api_async(params, req, runtime)
)
def get_fusion_auth_token(
self,
request: dypnsapi_20170525_models.GetFusionAuthTokenRequest,
) -> dypnsapi_20170525_models.GetFusionAuthTokenResponse:
"""
@summary Obtains the verification results by using the token that is obtained from the client SDKs.
@param request: GetFusionAuthTokenRequest
@return: GetFusionAuthTokenResponse
"""
runtime = util_models.RuntimeOptions()
return self.get_fusion_auth_token_with_options(request, runtime)
async def get_fusion_auth_token_async(
self,
request: dypnsapi_20170525_models.GetFusionAuthTokenRequest,
) -> dypnsapi_20170525_models.GetFusionAuthTokenResponse:
"""
@summary Obtains the verification results by using the token that is obtained from the client SDKs.
@param request: GetFusionAuthTokenRequest
@return: GetFusionAuthTokenResponse
"""
runtime = util_models.RuntimeOptions()
return await self.get_fusion_auth_token_with_options_async(request, runtime)
def get_mobile_with_options(
self,
request: dypnsapi_20170525_models.GetMobileRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetMobileResponse:
"""
@summary Obtains a phone number for one-click logon.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable only to one-click logon or registration. You can call this operation only after you confirm the authorization on the authorization page provided by the SDK for one-click logon. You are prohibited from simulating or bypassing the authorization process. Alibaba Cloud reserves the right to terminate our services and take legal actions against such violations.
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetMobileRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetMobileResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.access_token):
query['AccessToken'] = request.access_token
if not UtilClient.is_unset(request.out_id):
query['OutId'] = request.out_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetMobile',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetMobileResponse(),
self.call_api(params, req, runtime)
)
async def get_mobile_with_options_async(
self,
request: dypnsapi_20170525_models.GetMobileRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetMobileResponse:
"""
@summary Obtains a phone number for one-click logon.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable only to one-click logon or registration. You can call this operation only after you confirm the authorization on the authorization page provided by the SDK for one-click logon. You are prohibited from simulating or bypassing the authorization process. Alibaba Cloud reserves the right to terminate our services and take legal actions against such violations.
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetMobileRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetMobileResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.access_token):
query['AccessToken'] = request.access_token
if not UtilClient.is_unset(request.out_id):
query['OutId'] = request.out_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetMobile',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetMobileResponse(),
await self.call_api_async(params, req, runtime)
)
def get_mobile(
self,
request: dypnsapi_20170525_models.GetMobileRequest,
) -> dypnsapi_20170525_models.GetMobileResponse:
"""
@summary Obtains a phone number for one-click logon.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable only to one-click logon or registration. You can call this operation only after you confirm the authorization on the authorization page provided by the SDK for one-click logon. You are prohibited from simulating or bypassing the authorization process. Alibaba Cloud reserves the right to terminate our services and take legal actions against such violations.
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetMobileRequest
@return: GetMobileResponse
"""
runtime = util_models.RuntimeOptions()
return self.get_mobile_with_options(request, runtime)
async def get_mobile_async(
self,
request: dypnsapi_20170525_models.GetMobileRequest,
) -> dypnsapi_20170525_models.GetMobileResponse:
"""
@summary Obtains a phone number for one-click logon.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable only to one-click logon or registration. You can call this operation only after you confirm the authorization on the authorization page provided by the SDK for one-click logon. You are prohibited from simulating or bypassing the authorization process. Alibaba Cloud reserves the right to terminate our services and take legal actions against such violations.
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetMobileRequest
@return: GetMobileResponse
"""
runtime = util_models.RuntimeOptions()
return await self.get_mobile_with_options_async(request, runtime)
def get_phone_with_token_with_options(
self,
request: dypnsapi_20170525_models.GetPhoneWithTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetPhoneWithTokenResponse:
"""
@summary Obtains a phone number for one-click logon. This operation is exclusive to HTML5 pages.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable only to one-click logon or registration in HTML5 pages. You can call this operation only after you confirm the authorization on the authorization page provided by the JavaScript SDK. You are prohibited from simulating or bypassing the authorization process. Alibaba Cloud reserves the right to terminate our services and take legal actions against such violations.
### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetPhoneWithTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetPhoneWithTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.sp_token):
query['SpToken'] = request.sp_token
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetPhoneWithToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetPhoneWithTokenResponse(),
self.call_api(params, req, runtime)
)
async def get_phone_with_token_with_options_async(
self,
request: dypnsapi_20170525_models.GetPhoneWithTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetPhoneWithTokenResponse:
"""
@summary Obtains a phone number for one-click logon. This operation is exclusive to HTML5 pages.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable only to one-click logon or registration in HTML5 pages. You can call this operation only after you confirm the authorization on the authorization page provided by the JavaScript SDK. You are prohibited from simulating or bypassing the authorization process. Alibaba Cloud reserves the right to terminate our services and take legal actions against such violations.
### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetPhoneWithTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetPhoneWithTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.sp_token):
query['SpToken'] = request.sp_token
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetPhoneWithToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetPhoneWithTokenResponse(),
await self.call_api_async(params, req, runtime)
)
def get_phone_with_token(
self,
request: dypnsapi_20170525_models.GetPhoneWithTokenRequest,
) -> dypnsapi_20170525_models.GetPhoneWithTokenResponse:
"""
@summary Obtains a phone number for one-click logon. This operation is exclusive to HTML5 pages.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable only to one-click logon or registration in HTML5 pages. You can call this operation only after you confirm the authorization on the authorization page provided by the JavaScript SDK. You are prohibited from simulating or bypassing the authorization process. Alibaba Cloud reserves the right to terminate our services and take legal actions against such violations.
### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetPhoneWithTokenRequest
@return: GetPhoneWithTokenResponse
"""
runtime = util_models.RuntimeOptions()
return self.get_phone_with_token_with_options(request, runtime)
async def get_phone_with_token_async(
self,
request: dypnsapi_20170525_models.GetPhoneWithTokenRequest,
) -> dypnsapi_20170525_models.GetPhoneWithTokenResponse:
"""
@summary Obtains a phone number for one-click logon. This operation is exclusive to HTML5 pages.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable only to one-click logon or registration in HTML5 pages. You can call this operation only after you confirm the authorization on the authorization page provided by the JavaScript SDK. You are prohibited from simulating or bypassing the authorization process. Alibaba Cloud reserves the right to terminate our services and take legal actions against such violations.
### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetPhoneWithTokenRequest
@return: GetPhoneWithTokenResponse
"""
runtime = util_models.RuntimeOptions()
return await self.get_phone_with_token_with_options_async(request, runtime)
def get_sms_auth_tokens_with_options(
self,
request: dypnsapi_20170525_models.GetSmsAuthTokensRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetSmsAuthTokensResponse:
"""
@summary Obtains the authorization token for an SMS verification code.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the SMS verification feature](https://help.aliyun.com/document_detail/313209.html).
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetSmsAuthTokensRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetSmsAuthTokensResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.bundle_id):
query['BundleId'] = request.bundle_id
if not UtilClient.is_unset(request.expire):
query['Expire'] = request.expire
if not UtilClient.is_unset(request.os_type):
query['OsType'] = request.os_type
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.package_name):
query['PackageName'] = request.package_name
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scene_code):
query['SceneCode'] = request.scene_code
if not UtilClient.is_unset(request.sign_name):
query['SignName'] = request.sign_name
if not UtilClient.is_unset(request.sms_code_expire):
query['SmsCodeExpire'] = request.sms_code_expire
if not UtilClient.is_unset(request.sms_template_code):
query['SmsTemplateCode'] = request.sms_template_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetSmsAuthTokens',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetSmsAuthTokensResponse(),
self.call_api(params, req, runtime)
)
async def get_sms_auth_tokens_with_options_async(
self,
request: dypnsapi_20170525_models.GetSmsAuthTokensRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.GetSmsAuthTokensResponse:
"""
@summary Obtains the authorization token for an SMS verification code.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the SMS verification feature](https://help.aliyun.com/document_detail/313209.html).
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetSmsAuthTokensRequest
@param runtime: runtime options for this request RuntimeOptions
@return: GetSmsAuthTokensResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.bundle_id):
query['BundleId'] = request.bundle_id
if not UtilClient.is_unset(request.expire):
query['Expire'] = request.expire
if not UtilClient.is_unset(request.os_type):
query['OsType'] = request.os_type
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.package_name):
query['PackageName'] = request.package_name
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.scene_code):
query['SceneCode'] = request.scene_code
if not UtilClient.is_unset(request.sign_name):
query['SignName'] = request.sign_name
if not UtilClient.is_unset(request.sms_code_expire):
query['SmsCodeExpire'] = request.sms_code_expire
if not UtilClient.is_unset(request.sms_template_code):
query['SmsTemplateCode'] = request.sms_template_code
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='GetSmsAuthTokens',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.GetSmsAuthTokensResponse(),
await self.call_api_async(params, req, runtime)
)
def get_sms_auth_tokens(
self,
request: dypnsapi_20170525_models.GetSmsAuthTokensRequest,
) -> dypnsapi_20170525_models.GetSmsAuthTokensResponse:
"""
@summary Obtains the authorization token for an SMS verification code.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the SMS verification feature](https://help.aliyun.com/document_detail/313209.html).
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetSmsAuthTokensRequest
@return: GetSmsAuthTokensResponse
"""
runtime = util_models.RuntimeOptions()
return self.get_sms_auth_tokens_with_options(request, runtime)
async def get_sms_auth_tokens_async(
self,
request: dypnsapi_20170525_models.GetSmsAuthTokensRequest,
) -> dypnsapi_20170525_models.GetSmsAuthTokensResponse:
"""
@summary Obtains the authorization token for an SMS verification code.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the SMS verification feature](https://help.aliyun.com/document_detail/313209.html).
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: GetSmsAuthTokensRequest
@return: GetSmsAuthTokensResponse
"""
runtime = util_models.RuntimeOptions()
return await self.get_sms_auth_tokens_with_options_async(request, runtime)
def query_gate_verify_billing_public_with_options(
self,
request: dypnsapi_20170525_models.QueryGateVerifyBillingPublicRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.QueryGateVerifyBillingPublicResponse:
"""
@summary Queries the fees generated by a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: QueryGateVerifyBillingPublicRequest
@param runtime: runtime options for this request RuntimeOptions
@return: QueryGateVerifyBillingPublicResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.authentication_type):
query['AuthenticationType'] = request.authentication_type
if not UtilClient.is_unset(request.month):
query['Month'] = request.month
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='QueryGateVerifyBillingPublic',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.QueryGateVerifyBillingPublicResponse(),
self.call_api(params, req, runtime)
)
async def query_gate_verify_billing_public_with_options_async(
self,
request: dypnsapi_20170525_models.QueryGateVerifyBillingPublicRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.QueryGateVerifyBillingPublicResponse:
"""
@summary Queries the fees generated by a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: QueryGateVerifyBillingPublicRequest
@param runtime: runtime options for this request RuntimeOptions
@return: QueryGateVerifyBillingPublicResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.authentication_type):
query['AuthenticationType'] = request.authentication_type
if not UtilClient.is_unset(request.month):
query['Month'] = request.month
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='QueryGateVerifyBillingPublic',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.QueryGateVerifyBillingPublicResponse(),
await self.call_api_async(params, req, runtime)
)
def query_gate_verify_billing_public(
self,
request: dypnsapi_20170525_models.QueryGateVerifyBillingPublicRequest,
) -> dypnsapi_20170525_models.QueryGateVerifyBillingPublicResponse:
"""
@summary Queries the fees generated by a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: QueryGateVerifyBillingPublicRequest
@return: QueryGateVerifyBillingPublicResponse
"""
runtime = util_models.RuntimeOptions()
return self.query_gate_verify_billing_public_with_options(request, runtime)
async def query_gate_verify_billing_public_async(
self,
request: dypnsapi_20170525_models.QueryGateVerifyBillingPublicRequest,
) -> dypnsapi_20170525_models.QueryGateVerifyBillingPublicResponse:
"""
@summary Queries the fees generated by a verification service.
@description ### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: QueryGateVerifyBillingPublicRequest
@return: QueryGateVerifyBillingPublicResponse
"""
runtime = util_models.RuntimeOptions()
return await self.query_gate_verify_billing_public_with_options_async(request, runtime)
def query_gate_verify_statistic_public_with_options(
self,
request: dypnsapi_20170525_models.QueryGateVerifyStatisticPublicRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.QueryGateVerifyStatisticPublicResponse:
"""
@summary Queries the calls of Phone Number Verification Service.
@description ### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: QueryGateVerifyStatisticPublicRequest
@param runtime: runtime options for this request RuntimeOptions
@return: QueryGateVerifyStatisticPublicResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.authentication_type):
query['AuthenticationType'] = request.authentication_type
if not UtilClient.is_unset(request.end_date):
query['EndDate'] = request.end_date
if not UtilClient.is_unset(request.os_type):
query['OsType'] = request.os_type
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.scene_code):
query['SceneCode'] = request.scene_code
if not UtilClient.is_unset(request.start_date):
query['StartDate'] = request.start_date
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='QueryGateVerifyStatisticPublic',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.QueryGateVerifyStatisticPublicResponse(),
self.call_api(params, req, runtime)
)
async def query_gate_verify_statistic_public_with_options_async(
self,
request: dypnsapi_20170525_models.QueryGateVerifyStatisticPublicRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.QueryGateVerifyStatisticPublicResponse:
"""
@summary Queries the calls of Phone Number Verification Service.
@description ### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: QueryGateVerifyStatisticPublicRequest
@param runtime: runtime options for this request RuntimeOptions
@return: QueryGateVerifyStatisticPublicResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.authentication_type):
query['AuthenticationType'] = request.authentication_type
if not UtilClient.is_unset(request.end_date):
query['EndDate'] = request.end_date
if not UtilClient.is_unset(request.os_type):
query['OsType'] = request.os_type
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.scene_code):
query['SceneCode'] = request.scene_code
if not UtilClient.is_unset(request.start_date):
query['StartDate'] = request.start_date
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='QueryGateVerifyStatisticPublic',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.QueryGateVerifyStatisticPublicResponse(),
await self.call_api_async(params, req, runtime)
)
def query_gate_verify_statistic_public(
self,
request: dypnsapi_20170525_models.QueryGateVerifyStatisticPublicRequest,
) -> dypnsapi_20170525_models.QueryGateVerifyStatisticPublicResponse:
"""
@summary Queries the calls of Phone Number Verification Service.
@description ### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: QueryGateVerifyStatisticPublicRequest
@return: QueryGateVerifyStatisticPublicResponse
"""
runtime = util_models.RuntimeOptions()
return self.query_gate_verify_statistic_public_with_options(request, runtime)
async def query_gate_verify_statistic_public_async(
self,
request: dypnsapi_20170525_models.QueryGateVerifyStatisticPublicRequest,
) -> dypnsapi_20170525_models.QueryGateVerifyStatisticPublicResponse:
"""
@summary Queries the calls of Phone Number Verification Service.
@description ### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: QueryGateVerifyStatisticPublicRequest
@return: QueryGateVerifyStatisticPublicResponse
"""
runtime = util_models.RuntimeOptions()
return await self.query_gate_verify_statistic_public_with_options_async(request, runtime)
def query_send_details_with_options(
self,
request: dypnsapi_20170525_models.QuerySendDetailsRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.QuerySendDetailsResponse:
"""
@deprecated OpenAPI QuerySendDetails is deprecated
@summary Queries the delivery status of the SMS verification code. You can query only the delivery status of the SMS verification code that is sent by calling corresponding API operations.
@param request: QuerySendDetailsRequest
@param runtime: runtime options for this request RuntimeOptions
@return: QuerySendDetailsResponse
Deprecated
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.biz_id):
query['BizId'] = request.biz_id
if not UtilClient.is_unset(request.current_page):
query['CurrentPage'] = request.current_page
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.page_size):
query['PageSize'] = request.page_size
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.send_date):
query['SendDate'] = request.send_date
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='QuerySendDetails',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.QuerySendDetailsResponse(),
self.call_api(params, req, runtime)
)
async def query_send_details_with_options_async(
self,
request: dypnsapi_20170525_models.QuerySendDetailsRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.QuerySendDetailsResponse:
"""
@deprecated OpenAPI QuerySendDetails is deprecated
@summary Queries the delivery status of the SMS verification code. You can query only the delivery status of the SMS verification code that is sent by calling corresponding API operations.
@param request: QuerySendDetailsRequest
@param runtime: runtime options for this request RuntimeOptions
@return: QuerySendDetailsResponse
Deprecated
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.biz_id):
query['BizId'] = request.biz_id
if not UtilClient.is_unset(request.current_page):
query['CurrentPage'] = request.current_page
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.page_size):
query['PageSize'] = request.page_size
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.send_date):
query['SendDate'] = request.send_date
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='QuerySendDetails',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.QuerySendDetailsResponse(),
await self.call_api_async(params, req, runtime)
)
def query_send_details(
self,
request: dypnsapi_20170525_models.QuerySendDetailsRequest,
) -> dypnsapi_20170525_models.QuerySendDetailsResponse:
"""
@deprecated OpenAPI QuerySendDetails is deprecated
@summary Queries the delivery status of the SMS verification code. You can query only the delivery status of the SMS verification code that is sent by calling corresponding API operations.
@param request: QuerySendDetailsRequest
@return: QuerySendDetailsResponse
Deprecated
"""
runtime = util_models.RuntimeOptions()
return self.query_send_details_with_options(request, runtime)
async def query_send_details_async(
self,
request: dypnsapi_20170525_models.QuerySendDetailsRequest,
) -> dypnsapi_20170525_models.QuerySendDetailsResponse:
"""
@deprecated OpenAPI QuerySendDetails is deprecated
@summary Queries the delivery status of the SMS verification code. You can query only the delivery status of the SMS verification code that is sent by calling corresponding API operations.
@param request: QuerySendDetailsRequest
@return: QuerySendDetailsResponse
Deprecated
"""
runtime = util_models.RuntimeOptions()
return await self.query_send_details_with_options_async(request, runtime)
def send_sms_verify_code_with_options(
self,
request: dypnsapi_20170525_models.SendSmsVerifyCodeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.SendSmsVerifyCodeResponse:
"""
@summary Sends SMS verification codes.
@param request: SendSmsVerifyCodeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: SendSmsVerifyCodeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.auto_retry):
query['AutoRetry'] = request.auto_retry
if not UtilClient.is_unset(request.code_length):
query['CodeLength'] = request.code_length
if not UtilClient.is_unset(request.code_type):
query['CodeType'] = request.code_type
if not UtilClient.is_unset(request.country_code):
query['CountryCode'] = request.country_code
if not UtilClient.is_unset(request.duplicate_policy):
query['DuplicatePolicy'] = request.duplicate_policy
if not UtilClient.is_unset(request.interval):
query['Interval'] = request.interval
if not UtilClient.is_unset(request.out_id):
query['OutId'] = request.out_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.return_verify_code):
query['ReturnVerifyCode'] = request.return_verify_code
if not UtilClient.is_unset(request.scheme_name):
query['SchemeName'] = request.scheme_name
if not UtilClient.is_unset(request.sign_name):
query['SignName'] = request.sign_name
if not UtilClient.is_unset(request.sms_up_extend_code):
query['SmsUpExtendCode'] = request.sms_up_extend_code
if not UtilClient.is_unset(request.template_code):
query['TemplateCode'] = request.template_code
if not UtilClient.is_unset(request.template_param):
query['TemplateParam'] = request.template_param
if not UtilClient.is_unset(request.valid_time):
query['ValidTime'] = request.valid_time
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='SendSmsVerifyCode',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.SendSmsVerifyCodeResponse(),
self.call_api(params, req, runtime)
)
async def send_sms_verify_code_with_options_async(
self,
request: dypnsapi_20170525_models.SendSmsVerifyCodeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.SendSmsVerifyCodeResponse:
"""
@summary Sends SMS verification codes.
@param request: SendSmsVerifyCodeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: SendSmsVerifyCodeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.auto_retry):
query['AutoRetry'] = request.auto_retry
if not UtilClient.is_unset(request.code_length):
query['CodeLength'] = request.code_length
if not UtilClient.is_unset(request.code_type):
query['CodeType'] = request.code_type
if not UtilClient.is_unset(request.country_code):
query['CountryCode'] = request.country_code
if not UtilClient.is_unset(request.duplicate_policy):
query['DuplicatePolicy'] = request.duplicate_policy
if not UtilClient.is_unset(request.interval):
query['Interval'] = request.interval
if not UtilClient.is_unset(request.out_id):
query['OutId'] = request.out_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.return_verify_code):
query['ReturnVerifyCode'] = request.return_verify_code
if not UtilClient.is_unset(request.scheme_name):
query['SchemeName'] = request.scheme_name
if not UtilClient.is_unset(request.sign_name):
query['SignName'] = request.sign_name
if not UtilClient.is_unset(request.sms_up_extend_code):
query['SmsUpExtendCode'] = request.sms_up_extend_code
if not UtilClient.is_unset(request.template_code):
query['TemplateCode'] = request.template_code
if not UtilClient.is_unset(request.template_param):
query['TemplateParam'] = request.template_param
if not UtilClient.is_unset(request.valid_time):
query['ValidTime'] = request.valid_time
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='SendSmsVerifyCode',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.SendSmsVerifyCodeResponse(),
await self.call_api_async(params, req, runtime)
)
def send_sms_verify_code(
self,
request: dypnsapi_20170525_models.SendSmsVerifyCodeRequest,
) -> dypnsapi_20170525_models.SendSmsVerifyCodeResponse:
"""
@summary Sends SMS verification codes.
@param request: SendSmsVerifyCodeRequest
@return: SendSmsVerifyCodeResponse
"""
runtime = util_models.RuntimeOptions()
return self.send_sms_verify_code_with_options(request, runtime)
async def send_sms_verify_code_async(
self,
request: dypnsapi_20170525_models.SendSmsVerifyCodeRequest,
) -> dypnsapi_20170525_models.SendSmsVerifyCodeResponse:
"""
@summary Sends SMS verification codes.
@param request: SendSmsVerifyCodeRequest
@return: SendSmsVerifyCodeResponse
"""
runtime = util_models.RuntimeOptions()
return await self.send_sms_verify_code_with_options_async(request, runtime)
def verify_mobile_with_options(
self,
request: dypnsapi_20170525_models.VerifyMobileRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.VerifyMobileResponse:
"""
@summary Verifies the phone number that you use.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable to only the verification of thephone number that you use. To obtain a phone number for one-click logon, call [GetMobile](https://help.aliyun.com/document_detail/189865.html).
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifyMobileRequest
@param runtime: runtime options for this request RuntimeOptions
@return: VerifyMobileResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.access_code):
query['AccessCode'] = request.access_code
if not UtilClient.is_unset(request.out_id):
query['OutId'] = request.out_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='VerifyMobile',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.VerifyMobileResponse(),
self.call_api(params, req, runtime)
)
async def verify_mobile_with_options_async(
self,
request: dypnsapi_20170525_models.VerifyMobileRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.VerifyMobileResponse:
"""
@summary Verifies the phone number that you use.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable to only the verification of thephone number that you use. To obtain a phone number for one-click logon, call [GetMobile](https://help.aliyun.com/document_detail/189865.html).
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifyMobileRequest
@param runtime: runtime options for this request RuntimeOptions
@return: VerifyMobileResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.access_code):
query['AccessCode'] = request.access_code
if not UtilClient.is_unset(request.out_id):
query['OutId'] = request.out_id
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='VerifyMobile',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.VerifyMobileResponse(),
await self.call_api_async(params, req, runtime)
)
def verify_mobile(
self,
request: dypnsapi_20170525_models.VerifyMobileRequest,
) -> dypnsapi_20170525_models.VerifyMobileResponse:
"""
@summary Verifies the phone number that you use.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable to only the verification of thephone number that you use. To obtain a phone number for one-click logon, call [GetMobile](https://help.aliyun.com/document_detail/189865.html).
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifyMobileRequest
@return: VerifyMobileResponse
"""
runtime = util_models.RuntimeOptions()
return self.verify_mobile_with_options(request, runtime)
async def verify_mobile_async(
self,
request: dypnsapi_20170525_models.VerifyMobileRequest,
) -> dypnsapi_20170525_models.VerifyMobileResponse:
"""
@summary Verifies the phone number that you use.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](https://help.aliyun.com/document_detail/84541.html).
> This operation is applicable to only the verification of thephone number that you use. To obtain a phone number for one-click logon, call [GetMobile](https://help.aliyun.com/document_detail/189865.html).
### [](#qps)QPS limits
You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifyMobileRequest
@return: VerifyMobileResponse
"""
runtime = util_models.RuntimeOptions()
return await self.verify_mobile_with_options_async(request, runtime)
def verify_phone_with_token_with_options(
self,
request: dypnsapi_20170525_models.VerifyPhoneWithTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.VerifyPhoneWithTokenResponse:
"""
@summary Verifies the phone number used in HTML5 pages.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the phone number verification feature for HTML5 pages](https://help.aliyun.com/document_detail/169786.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifyPhoneWithTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: VerifyPhoneWithTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.sp_token):
query['SpToken'] = request.sp_token
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='VerifyPhoneWithToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.VerifyPhoneWithTokenResponse(),
self.call_api(params, req, runtime)
)
async def verify_phone_with_token_with_options_async(
self,
request: dypnsapi_20170525_models.VerifyPhoneWithTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.VerifyPhoneWithTokenResponse:
"""
@summary Verifies the phone number used in HTML5 pages.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the phone number verification feature for HTML5 pages](https://help.aliyun.com/document_detail/169786.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifyPhoneWithTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: VerifyPhoneWithTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.sp_token):
query['SpToken'] = request.sp_token
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='VerifyPhoneWithToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.VerifyPhoneWithTokenResponse(),
await self.call_api_async(params, req, runtime)
)
def verify_phone_with_token(
self,
request: dypnsapi_20170525_models.VerifyPhoneWithTokenRequest,
) -> dypnsapi_20170525_models.VerifyPhoneWithTokenResponse:
"""
@summary Verifies the phone number used in HTML5 pages.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the phone number verification feature for HTML5 pages](https://help.aliyun.com/document_detail/169786.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifyPhoneWithTokenRequest
@return: VerifyPhoneWithTokenResponse
"""
runtime = util_models.RuntimeOptions()
return self.verify_phone_with_token_with_options(request, runtime)
async def verify_phone_with_token_async(
self,
request: dypnsapi_20170525_models.VerifyPhoneWithTokenRequest,
) -> dypnsapi_20170525_models.VerifyPhoneWithTokenResponse:
"""
@summary Verifies the phone number used in HTML5 pages.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the phone number verification feature for HTML5 pages](https://help.aliyun.com/document_detail/169786.html).
### [](#qps)QPS limits
You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifyPhoneWithTokenRequest
@return: VerifyPhoneWithTokenResponse
"""
runtime = util_models.RuntimeOptions()
return await self.verify_phone_with_token_with_options_async(request, runtime)
def verify_sms_code_with_options(
self,
request: dypnsapi_20170525_models.VerifySmsCodeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.VerifySmsCodeResponse:
"""
@summary Verifies SMS verification codes.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the SMS verification feature](https://help.aliyun.com/document_detail/313209.html).
### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifySmsCodeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: VerifySmsCodeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.sms_code):
query['SmsCode'] = request.sms_code
if not UtilClient.is_unset(request.sms_token):
query['SmsToken'] = request.sms_token
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='VerifySmsCode',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.VerifySmsCodeResponse(),
self.call_api(params, req, runtime)
)
async def verify_sms_code_with_options_async(
self,
request: dypnsapi_20170525_models.VerifySmsCodeRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.VerifySmsCodeResponse:
"""
@summary Verifies SMS verification codes.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the SMS verification feature](https://help.aliyun.com/document_detail/313209.html).
### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifySmsCodeRequest
@param runtime: runtime options for this request RuntimeOptions
@return: VerifySmsCodeResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.phone_number):
query['PhoneNumber'] = request.phone_number
if not UtilClient.is_unset(request.sms_code):
query['SmsCode'] = request.sms_code
if not UtilClient.is_unset(request.sms_token):
query['SmsToken'] = request.sms_token
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='VerifySmsCode',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.VerifySmsCodeResponse(),
await self.call_api_async(params, req, runtime)
)
def verify_sms_code(
self,
request: dypnsapi_20170525_models.VerifySmsCodeRequest,
) -> dypnsapi_20170525_models.VerifySmsCodeResponse:
"""
@summary Verifies SMS verification codes.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the SMS verification feature](https://help.aliyun.com/document_detail/313209.html).
### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifySmsCodeRequest
@return: VerifySmsCodeResponse
"""
runtime = util_models.RuntimeOptions()
return self.verify_sms_code_with_options(request, runtime)
async def verify_sms_code_async(
self,
request: dypnsapi_20170525_models.VerifySmsCodeRequest,
) -> dypnsapi_20170525_models.VerifySmsCodeResponse:
"""
@summary Verifies SMS verification codes.
@description ### [](#)Preparations
You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Use the SMS verification feature](https://help.aliyun.com/document_detail/313209.html).
### [](#qps)QPS limits
You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
@param request: VerifySmsCodeRequest
@return: VerifySmsCodeResponse
"""
runtime = util_models.RuntimeOptions()
return await self.verify_sms_code_with_options_async(request, runtime)
def verify_with_fusion_auth_token_with_options(
self,
request: dypnsapi_20170525_models.VerifyWithFusionAuthTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.VerifyWithFusionAuthTokenResponse:
"""
@summary Obtains the verification results by using the verification token that is obtained by using the authentication token.
@param request: VerifyWithFusionAuthTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: VerifyWithFusionAuthTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.verify_token):
query['VerifyToken'] = request.verify_token
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='VerifyWithFusionAuthToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.VerifyWithFusionAuthTokenResponse(),
self.call_api(params, req, runtime)
)
async def verify_with_fusion_auth_token_with_options_async(
self,
request: dypnsapi_20170525_models.VerifyWithFusionAuthTokenRequest,
runtime: util_models.RuntimeOptions,
) -> dypnsapi_20170525_models.VerifyWithFusionAuthTokenResponse:
"""
@summary Obtains the verification results by using the verification token that is obtained by using the authentication token.
@param request: VerifyWithFusionAuthTokenRequest
@param runtime: runtime options for this request RuntimeOptions
@return: VerifyWithFusionAuthTokenResponse
"""
UtilClient.validate_model(request)
query = {}
if not UtilClient.is_unset(request.owner_id):
query['OwnerId'] = request.owner_id
if not UtilClient.is_unset(request.resource_owner_account):
query['ResourceOwnerAccount'] = request.resource_owner_account
if not UtilClient.is_unset(request.resource_owner_id):
query['ResourceOwnerId'] = request.resource_owner_id
if not UtilClient.is_unset(request.verify_token):
query['VerifyToken'] = request.verify_token
req = open_api_models.OpenApiRequest(
query=OpenApiUtilClient.query(query)
)
params = open_api_models.Params(
action='VerifyWithFusionAuthToken',
version='2017-05-25',
protocol='HTTPS',
pathname='/',
method='POST',
auth_type='AK',
style='RPC',
req_body_type='formData',
body_type='json'
)
return TeaCore.from_map(
dypnsapi_20170525_models.VerifyWithFusionAuthTokenResponse(),
await self.call_api_async(params, req, runtime)
)
def verify_with_fusion_auth_token(
self,
request: dypnsapi_20170525_models.VerifyWithFusionAuthTokenRequest,
) -> dypnsapi_20170525_models.VerifyWithFusionAuthTokenResponse:
"""
@summary Obtains the verification results by using the verification token that is obtained by using the authentication token.
@param request: VerifyWithFusionAuthTokenRequest
@return: VerifyWithFusionAuthTokenResponse
"""
runtime = util_models.RuntimeOptions()
return self.verify_with_fusion_auth_token_with_options(request, runtime)
async def verify_with_fusion_auth_token_async(
self,
request: dypnsapi_20170525_models.VerifyWithFusionAuthTokenRequest,
) -> dypnsapi_20170525_models.VerifyWithFusionAuthTokenResponse:
"""
@summary Obtains the verification results by using the verification token that is obtained by using the authentication token.
@param request: VerifyWithFusionAuthTokenRequest
@return: VerifyWithFusionAuthTokenResponse
"""
runtime = util_models.RuntimeOptions()
return await self.verify_with_fusion_auth_token_with_options_async(request, runtime)