{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dypnsapi/check-sms-verify-code":{"post":{"operationId":"cloud_aliyun_dypnsapi_check_sms_verify_code","summary":"Verifies an SMS verification code and returns the verification result","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumber","VerifyCode"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SchemeName":{"type":"string","description":"The scheme name. If this parameter is not specified, the value defaults to \"Default Scheme\". The value can be up to 20 characters in…"},"CountryCode":{"type":"string","description":"The country code of the phone number. Default value: 86"},"PhoneNumber":{"type":"string","description":"The phone number"},"OutId":{"type":"string","description":"The external serial number"},"VerifyCode":{"type":"string","description":"The verification code. The TemplateParam field of the SendSmsVerifyCode operation can be configured in two ways: -…"},"CaseAuthPolicy":{"type":"integer","description":"The case sensitivity policy for verification code validation. Valid values: 1: case-insensitive. 2: case-sensitive"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/create-scheme-config":{"post":{"operationId":"cloud_aliyun_dypnsapi_create_scheme_config","summary":"Creates a unified authentication scheme and retrieves the scheme code. A unified authentication scheme…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SchemeName","Platform"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SchemeName":{"type":"string","description":"The scheme name. The name can contain only Chinese and English letters and must be up to 10 characters in length"},"Platform":{"type":"string","enum":["Android","iOS"],"description":"The platform to which the scheme applies"},"AppName":{"type":"string","description":"The name of the app for the scheme. The name can contain only Chinese and English letters and must be up to 20 characters in length"},"AndroidPackageName":{"type":"string","description":"The package name. This parameter is required when Platform is set to Android. The package name can contain digits, letters, hyphens (-),…"},"AndroidPackageSign":{"type":"string","description":"The package signature. This parameter is required when Platform is set to Android. The signature can contain digits and letters and must…"},"IosBundleId":{"type":"string","description":"The bundle ID. This parameter is required when osType is set to iOS. The bundle ID can contain digits, letters, hyphens (-), underscores…"},"H5Url":{"type":"string","description":"Reserved. H5 schemes are not supported"},"H5Origin":{"type":"string","description":"Reserved. H5 schemes are not supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/create-verify-scheme":{"post":{"operationId":"cloud_aliyun_dypnsapi_create_verify_scheme","summary":"A verification scheme identifies authentication scenarios for an application (App). Each scheme typically…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SchemeName","AppName","OsType"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SchemeName":{"type":"string","description":"Scheme name"},"AppName":{"type":"string","description":"App name"},"OsType":{"type":"string","description":"Operating system type of the client. Valid values: iOS Android Harmony Web"},"PackName":{"type":"string","description":"Package name. Required when OsType is Android. Must contain only digits, letters, hyphens (-), underscores, or periods. Length: 1 to 128…"},"PackSign":{"type":"string","description":"Package signature. Required when OsType is Android. Must contain only digits and letters. Length: 32 characters"},"BundleId":{"type":"string","description":"Bundle ID. Required when OsType is iOS. Must contain only digits, letters, hyphens (-), underscores, or periods. Length: 1 to 128 characters"},"Origin":{"type":"string","description":"Source URL of the H5 scheme page. We recommend specifying the domain level"},"Url":{"type":"string","description":"Page URL used by the H5 scheme"},"IpWhiteList":{"type":"string","description":"IP address whitelist. Optional"},"CmApiCode":{"type":"integer","description":"China Mobile channel code. Optional"},"CuApiCode":{"type":"integer","description":"China Unicom channel code. Optional"},"CtApiCode":{"type":"integer","description":"China Telecom channel code. Optional"},"SceneType":{"type":"string","description":"Scheme type. Optional"},"Email":{"type":"string","description":"Email address to receive the key. Optional"},"AuthType":{"type":"string","description":"Authentication type. Optional. Select multiple values only if number authentication is supported. Separate multiple values with commas. 1:…"},"SmsSignName":{"type":"string","description":"Bound text message signature. Valid only if AuthType includes 2 (text message authentication). The signature must be approved and created…"},"HmPackageName":{"type":"string","description":"Package name. Required when OsType is `Harmony`. Must contain only digits, letters, underscores, or periods. Must start with a letter.…"},"HmSignName":{"type":"string","description":"Package signature. Required when OsType is `Harmony`. Must contain only digits and letters. Length: 64 characters"},"HmAppIdentifier":{"type":"string","description":"App ID. Required when OsType is `Harmony`. Length: 19 digits"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/delete-verify-scheme":{"post":{"operationId":"cloud_aliyun_dypnsapi_delete_verify_scheme","summary":"If you no longer need a verification scheme, you can call this operation or delete the scheme in the Phone…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SchemeCode"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SchemeCode":{"type":"string","description":"The scheme code. Get this value from the `SchemeCode` parameter in the response of the [CreateVerifyScheme](~~CreateVerifyScheme~~)…"},"CustomerId":{"type":"integer","description":"The user ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/describe-verify-scheme":{"post":{"operationId":"cloud_aliyun_dypnsapi_describe_verify_scheme","summary":"Queries the details of a verification service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SchemeCode"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SchemeCode":{"type":"string","description":"The service code"},"CustomerId":{"type":"integer","description":"The user ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/get-auth-token":{"post":{"operationId":"cloud_aliyun_dypnsapi_get_auth_token","summary":"Obtain an authorization token for H5 native number verification. The response includes an AccessToken and a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Url","Origin"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"Url":{"type":"string","description":"URL of the request page. Enter the URL you specified when creating the authentication plan in the console. Format: protocol + // + domain…"},"Origin":{"type":"string","description":"Origin URL. Enter the origin URL you specified when creating the authentication plan in the console. Format: protocol + // + domain name"},"SceneCode":{"type":"string","description":"Authentication plan code. This parameter is required due to plan upgrades. After creating an authentication plan in the console, pass its…"},"Version":{"type":"string","description":"The Version"},"BizType":{"type":"integer","description":"Business type. Valid values: 0: Native number verification. 1: One-click logon. This parameter is required due to flow optimizations that…"},"CmApiCode":{"type":"integer","description":"The CmApiCode"},"CuApiCode":{"type":"integer","description":"The CuApiCode"},"CtApiCode":{"type":"integer","description":"The CtApiCode"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/get-authorization-url":{"post":{"operationId":"cloud_aliyun_dypnsapi_get_authorization_url","summary":"This operation is offline","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNo","SchemeId"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"PhoneNo":{"type":"string","description":"The phone number"},"SchemeId":{"type":"integer","description":"The authorization scenario ID. You can view the authorization scenario ID on the Authorization Scenarios page in the Phone Number…"},"EndDate":{"type":"string","description":"The authorization end date. This field is required for contract-based plans. Format: yyyy-MM-dd"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/get-fusion-auth-token":{"post":{"operationId":"cloud_aliyun_dypnsapi_get_fusion_auth_token","summary":"After the fusion authentication client completes initialization, you can call this API from your server to…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SchemeCode","Platform","DurationSeconds"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SchemeCode":{"type":"string","description":"The scheme code"},"PackageName":{"type":"string","description":"Required when Platform is Android. The app package name"},"PackageSign":{"type":"string","description":"Required when Platform is Android. The app package signature"},"BundleId":{"type":"string","description":"Required when Platform is iOS. The app bundle ID"},"Platform":{"type":"string","description":"The platform. Valid values: Android or iOS"},"DurationSeconds":{"type":"integer","description":"The validity period of the token, in seconds. Minimum value: 900. Maximum value: 43200"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/get-mobile":{"post":{"operationId":"cloud_aliyun_dypnsapi_get_mobile","summary":"This API retrieves a mobile phone number using the one-click login feature of the Phone Number Verification…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AccessToken"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"AccessToken":{"type":"string","description":"Login token obtained from the app-side SDK. Token validity period and usage limits: China Telecom: 10 minutes, usable once. China Unicom:…"},"OutId":{"type":"string","description":"External transaction ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/get-phone-with-token":{"post":{"operationId":"cloud_aliyun_dypnsapi_get_phone_with_token","summary":"Obtains a phone number for one-click logon. This operation is exclusive to HTML5 pages","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SpToken"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SpToken":{"type":"string","description":"The token for phone number verification that is obtained by the JavaScript SDK. The validity period of the token is 10 minutes for China…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/get-sms-auth-tokens":{"post":{"operationId":"cloud_aliyun_dypnsapi_get_sms_auth_tokens","summary":"This operation is offline","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SceneCode","OsType","Expire","SmsTemplateCode"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"PackageName":{"type":"string","description":"Package name. Required when OsType is Android"},"SignName":{"type":"string","description":"Signature. Required when OsType is Android"},"SceneCode":{"type":"string","description":"Authentication flow ID"},"OsType":{"type":"string","description":"Operating system type. Valid values: Android or iOS"},"BundleId":{"type":"string","description":"iOS bundle ID. Required when OsType is iOS"},"Expire":{"type":"integer","description":"Token time-to-live (TTL), in seconds. Minimum value: 900. Maximum value: 43200"},"SmsTemplateCode":{"type":"string","description":"SMS template code"},"SmsCodeExpire":{"type":"integer","description":"SMS verification code TTL, in seconds. Default value: 180"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/query-gate-verify-billing-public":{"post":{"operationId":"cloud_aliyun_dypnsapi_query_gate_verify_billing_public","summary":"You can call this API to query monthly billing details for a specific authentication method","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Month","AuthenticationType"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"Month":{"type":"string","description":"The monthly bill. Format is YYYYMM, such as 202111"},"AuthenticationType":{"type":"integer","description":"The authentication method. Values: 0: Native number verification. 1: One-click logon. 2: All. 3: Liveness verification. 4: Text message…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/query-gate-verify-statistic-public":{"post":{"operationId":"cloud_aliyun_dypnsapi_query_gate_verify_statistic_public","summary":"Queries the calls of Phone Number Verification Service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","AuthenticationType"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SceneCode":{"type":"string","description":"The service code"},"StartDate":{"type":"string","description":"The start date. Specify this parameter in the YYYYMMDD format. Example: 20220101"},"EndDate":{"type":"string","description":"The end date. Specify this parameter in the YYYYMMDD format. Example: 20220106"},"AuthenticationType":{"type":"integer","description":"The verification method. Valid values: 1: one-click logon 2: phone number verification, including the verification of the phone number…"},"OsType":{"type":"string","description":"The type of the operating system. Valid values: Android iOS"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/send-sms-verify-code":{"post":{"operationId":"cloud_aliyun_dypnsapi_send_sms_verify_code","summary":"Sends an SMS verification code","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumber","SignName","TemplateCode","TemplateParam"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SchemeName":{"type":"string","description":"The scheme name. If this parameter is not specified, the value defaults to \"Default Scheme\". The value can be up to 20 characters in length"},"CountryCode":{"type":"string","description":"The country code of the phone number. Default value: 86. Currently, only Chinese mainland phone numbers are supported"},"PhoneNumber":{"type":"string","description":"The phone number of the SMS recipient"},"SignName":{"type":"string","description":"The signature name. Custom signatures are not supported. Use the system-provided signatures. You can select the signature to use on the…"},"TemplateCode":{"type":"string","description":"The SMS template code. When the SignName parameter is set to a system-provided signature, you must use a system-provided template to send…"},"TemplateParam":{"type":"string","description":"The SMS template parameters. There are two ways to pass the verification code value: Use \"##code##\" as a placeholder, and the CodeType…"},"SmsUpExtendCode":{"type":"string","description":"The uplink SMS extension code. Uplink SMS messages are messages sent to a telecommunications service provider to subscribe to a service,…"},"OutId":{"type":"string","description":"The external serial number"},"CodeLength":{"type":"integer","description":"The length of the verification code. Valid values: 4 to 8. Default value: 4"},"ValidTime":{"type":"integer","description":"The validity period of the verification code. Unit: seconds. Default value: 300"},"DuplicatePolicy":{"type":"integer","description":"The verification rule that specifies how to handle old verification codes when a new verification code is sent to the same phone number…"},"Interval":{"type":"integer","description":"The minimum interval between two consecutive verification code deliveries to the same phone number. Unit: seconds. This parameter is used…"},"CodeType":{"type":"integer","description":"The type of the generated verification code. This parameter is required when the TemplateParam parameter contains a placeholder. The…"},"ReturnVerifyCode":{"type":"string","description":"Specifies whether to return the verification code. Valid values: true: Returned. false: Not returned"},"AutoRetry":{"type":"integer","description":"Specifies whether to enable automatic signature replacement and retry (enabled by default). Valid values: 1: Enables automatic retry. When…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/verify-mobile":{"post":{"operationId":"cloud_aliyun_dypnsapi_verify_mobile","summary":"Call this operation to verify the phone number of the current device. It returns the verification result","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AccessCode","PhoneNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"AccessCode":{"type":"string","description":"Token validity and usage limits: China Telecom: valid for 10 minutes. Use once only. China Unicom: valid for 30 minutes. Use once only.…"},"PhoneNumber":{"type":"string","description":"The phone number to verify"},"OutId":{"type":"string","description":"The external sequence number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/verify-phone-with-token":{"post":{"operationId":"cloud_aliyun_dypnsapi_verify_phone_with_token","summary":"Call this API to verify phone numbers on H5 pages and retrieve the verification result when the operation…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumber","SpToken"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"PhoneNumber":{"type":"string","description":"The phone number to verify"},"SpToken":{"type":"string","description":"The phone number verification token obtained from the JSSDK. The validity period and usage count of the token vary by carrier: China…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/verify-sms-code":{"post":{"operationId":"cloud_aliyun_dypnsapi_verify_sms_code","summary":"This API operation is unpublished","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SmsCode","PhoneNumber","SmsToken"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"SmsCode":{"type":"string","description":"The verification code"},"PhoneNumber":{"type":"string","description":"The mobile phone number. This is returned when you obtain the text message verification code"},"SmsToken":{"type":"string","description":"The text message token. When you call the operation to send a verification code using the text message verification software development…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/verify-with-fusion-auth-token":{"post":{"operationId":"cloud_aliyun_dypnsapi_verify_with_fusion_auth_token","summary":"Obtains the verification results by using the verification token that is obtained by using the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["VerifyToken"],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"},"VerifyToken":{"type":"string","description":"The unified verification token that is returned by the client SDKs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dypnsapi/version":{"post":{"operationId":"cloud_aliyun_dypnsapi_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dypnsapi.aliyuncs.com"],"default":"https://dypnsapi.aliyuncs.com","description":"Regional endpoint, for example https://dypnsapi.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}