'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Dypnsapi', 'version' => '2017-05-25', ], 'directories' => [ [ 'id' => 186296, 'title' => 'SMS Authentication Service', 'type' => 'directory', 'children' => [ 'SendSmsVerifyCode', 'CheckSmsVerifyCode', ], ], [ 'id' => 134039, 'title' => 'Number Authentication', 'type' => 'directory', 'children' => [ [ 'id' => 182057, 'title' => 'Client one-click login and local number verification', 'type' => 'directory', 'children' => [ 'VerifyMobile', 'GetMobile', ], ], [ 'id' => 175693, 'title' => 'H5 one-click login and local number verification', 'type' => 'directory', 'children' => [ 'GetAuthToken', 'GetPhoneWithToken', 'VerifyPhoneWithToken', ], ], ], ], [ 'id' => 181112, 'title' => 'Converged authentication (scenario-based)', 'type' => 'directory', 'children' => [ 'GetFusionAuthToken', 'VerifyWithFusionAuthToken', ], ], [ 'id' => 134045, 'title' => 'SMS Authentication', 'type' => 'directory', 'children' => [ 'GetSmsAuthTokens', 'VerifySmsCode', ], ], [ 'id' => 134050, 'title' => 'Communication Authorization Service', 'type' => 'directory', 'children' => [ 'GetAuthorizationUrl', ], ], [ 'id' => 134035, 'title' => 'Certification Scheme Management', 'type' => 'directory', 'children' => [ 'CreateSchemeConfig', 'CreateVerifyScheme', 'DeleteVerifyScheme', 'DescribeVerifyScheme', ], ], [ 'id' => 134052, 'title' => 'Usage and cost statistics', 'type' => 'directory', 'children' => [ 'QueryGateVerifyStatisticPublic', 'QueryGateVerifyBillingPublic', ], ], [ 'id' => 190109, 'title' => 'Other', 'type' => 'directory', 'children' => [ 'QuerySendDetails', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'SendSmsVerifyCode' => [ 'summary' => 'Sends SMS verification codes.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '192247', 'abilityTreeNodes' => [ 'FEATUREdypnsZ7LLRH', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SchemeName', 'in' => 'query', 'schema' => [ 'description' => 'The verification service name. If this parameter is not specified, the default service is used. The name can be up to 20 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Aliyun', 'default' => '默认方案', ], ], [ 'name' => 'CountryCode', 'in' => 'query', 'schema' => [ 'description' => 'The country code of the phone number. SMS verification codes can be sent only by using phone numbers in the Chinese mainland. Default value: 86.'."\n", 'type' => 'string', 'required' => false, 'example' => '86', 'default' => '86', ], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => 'The phone number.'."\n", 'type' => 'string', 'required' => true, 'example' => '86130****0000', ], ], [ 'name' => 'SignName', 'in' => 'query', 'schema' => [ 'description' => 'The signature.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Aliyun Test', ], ], [ 'name' => 'TemplateCode', 'in' => 'query', 'schema' => [ 'description' => 'The code of the text message template.'."\n" ."\n" .'Log on to the [SMS console](https://dysms.console.aliyun.com/dysms.htm?spm=5176.12818093.categories-n-products.ddysms.3b2816d0xml2NA#/overview). In the left-side navigation pane, click **Go China** or **Go Globe**. You can view the text message template code in the **Template Code** column on the **Message Templates** tab.'."\n" ."\n" .'> The text message templates must be created on the Go Globe page and approved.'."\n", 'type' => 'string', 'required' => true, 'example' => 'azsq_*****', ], ], [ 'name' => 'TemplateParam', 'in' => 'query', 'schema' => [ 'description' => 'The value of the variable in the text message template. The verification code is replaced with "##code##".'."\n" ."\n" .'Example 1: For a system-defined template that contains variables, if the template content is "Your verification code is ${code} and valid for 5 minutes. Do not disclose the verification code to others.", specify the value of this parameter as {"code":"##code##"}'."\n" ."\n" .'Example 2: For a custom template, if the template content is ${content}, specify the value of this parameter as {"content":"Your verification code is ##code## and must be used within 5 minutes."}.'."\n" ."\n" .'> '."\n" ."\n" .'* If line breaks are required in JSON-formatted data, they must meet the relevant requirements that are specified in the standard JSON protocol.'."\n" ."\n" .'* For more information about template variables, see [SMS template specifications](~~108253~~).'."\n", 'type' => 'string', 'required' => true, 'example' => '{"code":"##code##"}', ], ], [ 'name' => 'SmsUpExtendCode', 'in' => 'query', 'schema' => [ 'description' => 'The extension code of the upstream text message. Upstream text messages are text messages sent to the communication service provider. Upstream text messages are used to customize a service, complete an inquiry, or send a request. You are charged for sending upstream text messages based on the billing standards of the service provider.'."\n" ."\n" .'> The extension code is automatically generated by the system when the signature is generated. You do not need to specify the extension code. You can skip this parameter based on your business requirements. If you want to use custom extension codes, contact your account manager.'."\n", 'type' => 'string', 'required' => false, 'example' => '1213123', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => 'The external ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '12358794Aqzaq', ], ], [ 'name' => 'CodeLength', 'in' => 'query', 'schema' => [ 'description' => 'The length of the verification code. Default value: 4. Valid values: 4 to 8.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'default' => '4', ], ], [ 'name' => 'ValidTime', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the verification code. Unit: seconds. Default value: 300.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'default' => '300', ], ], [ 'name' => 'DuplicatePolicy', 'in' => 'query', 'schema' => [ 'description' => 'Specifies how to handle the verification codes received earlier in a case where verification codes are sent to the same phone number for the same scenario within the validity period.'."\n" ."\n" .'* 1 (default): The latest verification code overwrites the verification codes received earlier. In this case, verification codes received earlier expire.'."\n" .'* 2: Verification codes within their validity period are valid and can be used for verification.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'enumValueTitles' => [ 1 => '', '', ], 'example' => '1', 'default' => '1', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'The time interval. Unit: seconds. Default value: 60. This parameter specifies how often you can send a verification code.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'default' => '60', ], ], [ 'name' => 'CodeType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the generated verification code. Default value: 1. Valid values:'."\n" ."\n" .'* 1: digits only'."\n" .'* 2: uppercase letters only'."\n" .'* 3: lowercase letters only'."\n" .'* 4: uppercase and lowercase letters'."\n" .'* 5: digits and uppercase letters'."\n" .'* 6: digits and lowercase letters'."\n" .'* 7: digits and uppercase and lowercase letters'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'enumValueTitles' => [ 1 => '', '', '', '', '', '', '', ], 'example' => '1', 'default' => '1', ], ], [ 'name' => 'ReturnVerifyCode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return a verification code.'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'AutoRetry', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '是否自动重试', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => 'The details about the access denial.'."\n", 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'type' => 'string', ], 'Model' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'VerifyCode' => [ 'description' => 'The verification code.'."\n", 'type' => 'string', 'example' => '42324', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'API-reqelekrqkllkkewrlwrjlsdfsdf', ], 'OutId' => [ 'description' => 'The external ID.'."\n", 'type' => 'string', 'example' => '1231231313', ], 'BizId' => [ 'description' => 'The business ID.'."\n", 'type' => 'string', 'example' => '112231421412414124123^4', ], ], ], 'Code' => [ 'description' => 'The response code. If OK is returned, the request is successful. For more information, see [Response codes](https://help.aliyun.com/zh/pnvs/developer-reference/api-return-code?spm=a2c4g.11174283.0.0.70c5616bkj38Wa).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MOBILE_NUMBER_ILLEGAL', 'errorMessage' => 'The mobile number is illegal.', ], [ 'errorCode' => 'BUSINESS_LIMIT_CONTROL', 'errorMessage' => 'The number has exceeded the limit for the day.', ], [ 'errorCode' => 'FREQUENCY_FAIL', 'errorMessage' => 'Check frequency fail.', ], [ 'errorCode' => 'INVALID_PARAMETERS', 'errorMessage' => 'parameter is not valid.', ], [ 'errorCode' => 'FUNCTION_NOT_OPENED', 'errorMessage' => 'You have not opened this function.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"成功 \\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Model\\": {\\n \\"VerifyCode\\": \\"4232\\",\\n \\"RequestId\\": \\"a3671ccf-0102-4c8e-8797-a3678e091d09\\",\\n \\"OutId\\": \\"1231231313\\",\\n \\"BizId\\": \\"112231421412414124123^4\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'SendSmsVerifyCode', ], 'CheckSmsVerifyCode' => [ 'summary' => 'Verifies SMS verification codes.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '192246', 'abilityTreeNodes' => [ 'FEATUREdypnsF4260C', ], ], 'parameters' => [ [ 'name' => 'SchemeName', 'in' => 'query', 'schema' => [ 'description' => 'The verification service name. If this parameter is not specified, the default service is used. The name can be up to 20 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Aliyun', 'default' => '默认方案', ], ], [ 'name' => 'CountryCode', 'in' => 'query', 'schema' => [ 'description' => 'The country code of the phone number. Default value: 86.'."\n", 'type' => 'string', 'required' => false, 'example' => '86', 'default' => '86', ], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => 'The phone number.'."\n", 'type' => 'string', 'required' => true, 'example' => '18653529399', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => 'The external ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '12123231', 'default' => '', ], ], [ 'name' => 'VerifyCode', 'in' => 'query', 'schema' => [ 'description' => 'The verification code.'."\n", 'type' => 'string', 'required' => true, 'example' => '1231', ], ], [ 'name' => 'CaseAuthPolicy', 'in' => 'query', 'schema' => [ 'description' => 'The verification policy for uppercase and lowercase letters of the verification code. Valid values:'."\n" ."\n" .'* 1: The verification policy does not distinguish uppercase and lowercase letters.'."\n" .'* 2: The verification policy distinguishes uppercase and lowercase letters.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'enumValueTitles' => [], 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => 'The details about the access denial.'."\n", 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Model' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'OutId' => [ 'description' => 'The external ID.'."\n", 'type' => 'string', 'example' => '1212312', ], 'VerifyResult' => [ 'description' => 'The verification results. Valid values:'."\n" ."\n" .'* PASS: The verification is successful.'."\n" .'* UNKNOWN: The verification failed.'."\n", 'type' => 'string', 'example' => 'PASS', ], ], ], 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [Response codes](https://help.aliyun.com/zh/pnvs/developer-reference/api-return-code?spm=a2c4g.11174283.0.0.70c5616bkj38Wa).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'false', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"成功\\",\\n \\"Model\\": {\\n \\"OutId\\": \\"1212312\\",\\n \\"VerifyResult\\": \\"PASS\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'CheckSmsVerifyCode', ], 'VerifyMobile' => [ 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '92639', 'abilityTreeNodes' => [ 'FEATUREdypns8SCJSK', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'AccessCode', 'in' => 'query', 'schema' => [ 'description' => 'The token obtained by the SDK for your app.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Dfafdafad542****', ], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => 'The phone number.'."\n", 'type' => 'string', 'required' => true, 'example' => '13800****00', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => 'The external ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], 'GateVerifyResultDTO' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'VerifyResult' => [ 'description' => 'The verification results. Valid values:'."\n" ."\n" .'* **PASS: The input phone number is consistent with the phone number that you use.**'."\n" .'* **REJECT: The input phone number is different from the phone number that you use.**'."\n" .'* **UNKNOWN: The system cannot judge whether the input phone number is consistent with the phone number that you use.'."\n", 'type' => 'string', 'example' => 'PASS', ], 'VerifyId' => [ 'description' => 'The verification ID.'."\n", 'type' => 'string', 'example' => '121343241', ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"GateVerifyResultDTO\\": {\\n \\"VerifyResult\\": \\"PASS\\",\\n \\"VerifyId\\": \\"121343241\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n PASS\\n 121343241\\n\\n请求成功\\n8906582E-6722\\nOK\\n","errorExample":""}]', 'title' => 'VerifyMobile', 'summary' => 'Verifies the phone number that you use.', 'description' => '### [](#)Preparations'."\n" ."\n" .'You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](~~84541~~).'."\n" ."\n" .'> 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](~~189865~~).'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'GetMobile' => [ 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '92629', 'abilityTreeNodes' => [ 'FEATUREdypns8SCJSK', ], ], 'parameters' => [ [ 'name' => 'AccessToken', 'in' => 'query', 'schema' => [ 'description' => 'The logon token obtained by the SDK for your app.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Dfafdafad5422****', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => 'The external ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '22345****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], 'GetMobileResultDTO' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Mobile' => [ 'description' => 'The phone number,'."\n", 'type' => 'string', 'example' => '13900001234', ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"GetMobileResultDTO\\": {\\n \\"Mobile\\": \\"139****1234\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n请求成功\\n8906582E-6722\\nOK\\n\\n 150****0000\\n\\n","errorExample":""}]', 'title' => 'GetMobile', 'summary' => 'Obtains a phone number for one-click logon.', 'description' => '### [](#)Preparations'."\n" ."\n" .'You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](~~84541~~).'."\n" ."\n" .'> 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.'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'GetAuthToken' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '92626', 'abilityTreeNodes' => [ 'FEATUREdypns8SCJSK', ], ], 'parameters' => [ [ 'name' => 'Url', 'in' => 'query', 'schema' => [ 'description' => 'The URL of the requested web page.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://www.aliyundoc.com/', ], ], [ 'name' => 'Origin', 'in' => 'query', 'schema' => [ 'description' => 'The requested domain name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://www.aliyundoc.com', ], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => [ 'title' => '方案号', 'type' => 'string', 'docRequired' => false, ], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', ], ], [ 'name' => 'CmApiCode', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'default' => '5', ], ], [ 'name' => 'CuApiCode', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'default' => '10', ], ], [ 'name' => 'CtApiCode', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'default' => '8', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], 'TokenInfo' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AccessToken' => [ 'description' => 'The business authentication token.'."\n" ."\n" .'> AccessToken is valid for 10 minutes and can be used repeatedly within its validity period.'."\n", 'type' => 'string', 'example' => 'agag****', ], 'JwtToken' => [ 'description' => 'The API authentication token.'."\n" ."\n" .'> JwtToken is valid for 1 hour and can be used repeatedly within its validity period.'."\n", 'type' => 'string', 'example' => 'aweghd****', ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"TokenInfo\\": {\\n \\"AccessToken\\": \\"agag****\\",\\n \\"JwtToken\\": \\"aweghd****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 请求成功\\n 8906582E-6722\\n \\n agag****\\n aweghd****\\n \\n","errorExample":""}]', 'title' => 'GetAuthToken', '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'."\n" ."\n" .'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](~~169786~~).'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'GetPhoneWithToken' => [ 'summary' => 'Obtains a phone number for one-click logon. This operation is exclusive to HTML5 pages.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'SpToken', 'in' => 'query', 'schema' => [ '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 Telecom, 30 minutes for China Unicom, and 2 minutes for China Mobile. The token can be used only once.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Dfafdafad542****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0F335F48-****-****-****-CA7914FE5D77', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Mobile' => [ 'description' => 'The phone number.'."\n", 'type' => 'string', 'example' => '13900001234', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"0F335F48-****-****-****-CA7914FE5D77\\",\\n \\"Data\\": {\\n \\"Mobile\\": \\"13900001234\\"\\n }\\n}","type":"json"}]', 'title' => 'GetPhoneWithToken', 'description' => '### [](#)Preparations'."\n" ."\n" .'You must register an Alibaba Cloud account, obtain an Alibaba Cloud AccessKey pair, and create a verification service. For more information, see [Getting Started](~~84541~~).'."\n" ."\n" .'> 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.'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", ], 'VerifyPhoneWithToken' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => 'The phone number.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1380000****', ], ], [ 'name' => 'SpToken', 'in' => 'query', 'schema' => [ 'description' => 'The token for phone number verification that is obtained by the JavaScript SDK.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Dfafdafad542****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], 'GateVerify' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'VerifyResult' => [ 'description' => 'The verification results. Valid values:'."\n" ."\n" .'* PASS: The input phone number is consistent with the phone number used in HTML5 pages.'."\n" .'* REJECT: The input phone number is different from the phone number used in HTML5 pages.'."\n" .'* UNKNOWN: The system cannot judge whether the input phone number is consistent with the phone number used in HTML5 pages.'."\n", 'type' => 'string', 'example' => 'PASS', ], 'VerifyId' => [ 'description' => 'The external ID.'."\n", 'type' => 'string', 'example' => '12134****', ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RamPermissionDeny', 'errorMessage' => 'The user is not authorized to operate on the specified resource.', ], [ 'errorCode' => 'UnknowError', 'errorMessage' => 'The requested service is not available now, please try again later.', ], [ 'errorCode' => 'Unsupported.Account', 'errorMessage' => 'Your account has not activated the product.', ], [ 'errorCode' => 'MobileNumberIllgeal', 'errorMessage' => 'The specified mobile phone number is invalid.', ], [ 'errorCode' => 'InvalidToken', 'errorMessage' => 'The token is invalid.', ], [ 'errorCode' => 'VerifySchemeNotExist', 'errorMessage' => 'The specified verify scheme already exists.', ], ], 500 => [ [ 'errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"GateVerify\\": {\\n \\"VerifyResult\\": \\"PASS\\",\\n \\"VerifyId\\": \\"12134****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 请求成功\\n 8906582E-6722\\n \\n PASS\\n 12134****\\n \\n","errorExample":""}]', 'title' => 'VerifyPhoneWithToken', 'summary' => 'Verifies the phone number used in HTML5 pages.', 'description' => '### [](#)Preparations'."\n" ."\n" .'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](~~169786~~).'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'GetFusionAuthToken' => [ 'summary' => 'Obtains the verification results by using the token that is obtained from the client SDKs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'SchemeCode', 'in' => 'query', 'schema' => [ 'title' => '方案Code。', 'description' => 'The service code.'."\n", 'type' => 'string', 'required' => true, 'example' => 'FA1000*************201', ], ], [ 'name' => 'PackageName', 'in' => 'query', 'schema' => [ 'title' => 'Platform为Android时必须传入，App的包名信息。', 'description' => 'The package name of the app. This parameter is required when Platform is set to Android.'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.example.test', ], ], [ 'name' => 'PackageSign', 'in' => 'query', 'schema' => [ 'title' => 'Platform为Android时必须传入，App的包签名信息。', 'description' => 'The package signature of the app. This parameter is required when Platform is set to Android.'."\n", 'type' => 'string', 'required' => false, 'example' => '47fcc************************278', ], ], [ 'name' => 'BundleId', 'in' => 'query', 'schema' => [ 'title' => 'Platform为iOS时必须传入，App的bundleId信息。', 'description' => 'The bundle ID of the app. This parameter is required when Platform is set to iOS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.example.test', ], ], [ 'name' => 'Platform', 'in' => 'query', 'schema' => [ 'title' => '平台，Android或者iOS。', 'description' => 'The platform type. Valid values: Android and iOS.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Android', ], ], [ 'name' => 'DurationSeconds', 'in' => 'query', 'schema' => [ 'title' => 'Token有效时长，单位是秒，最小值900，最大值43200。', 'description' => 'The validity period of the token. Unit: seconds. Valid values: 900 to 43200.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '900', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', ], 'Model' => [ 'description' => 'The authentication code. The value of this parameter is a string.'."\n", 'type' => 'string', 'example' => 'FKcksloqk***********jalEc+', ], 'Code' => [ 'description' => 'The response code. If OK is returned, the request is successful. Other values indicate that the request failed. For more information, see Error codes.'."\n", 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values: true false'."\n", 'type' => 'boolean', 'example' => 'false', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'SchemeNumberOverLimit', 'errorMessage' => 'The maximum number of scheme is exceeded.', ], [ 'errorCode' => 'SmsCodeVerifyFail', 'errorMessage' => 'The specified smsCode is invalid.', ], [ 'errorCode' => 'SmsSignNameNotExist', 'errorMessage' => 'The specified sms signName is invalid.', ], [ 'errorCode' => 'Throttling.System', 'errorMessage' => 'The request was denied due to API flow control.', ], [ 'errorCode' => 'UnknowError', 'errorMessage' => 'The requested service is not available now, please try again later.', ], [ 'errorCode' => 'Unsupported.Account', 'errorMessage' => 'Your account has not activated the product.', ], [ 'errorCode' => 'VerifySchemeNotExist', 'errorMessage' => 'The specified verify scheme already exists.', ], [ 'errorCode' => 'PackageSignedConflict', 'errorMessage' => 'The specified package signed already exists.', ], [ 'errorCode' => 'RamPermissionDeny', 'errorMessage' => 'The user is not authorized to operate on the specified resource.', ], [ 'errorCode' => 'SceneQueryFail', 'errorMessage' => 'The specified scene does not exist.', ], [ 'errorCode' => 'SchemeNotPassed', 'errorMessage' => 'The scheme is not passed.', ], ], 403 => [ [ 'errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'Failed to verify your access permissions.', ], ], 500 => [ [ 'errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred.', ], [ 'errorCode' => 'OutOfService', 'errorMessage' => 'The account is suspended.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Model\\": \\"FKcksloqk***********jalEc+\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'GetFusionAuthToken', ], 'VerifyWithFusionAuthToken' => [ 'summary' => 'Obtains the verification results by using the verification token that is obtained by using the authentication token.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '167123', 'abilityTreeNodes' => [ 'FEATUREdypns9ZAN79', 'FEATUREdypns1LCGAH', 'FEATUREdypnsBK4NX5', 'FEATUREdypnsC68T0U', 'FEATUREdypnsRN54HJ', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'VerifyToken', 'in' => 'query', 'schema' => [ 'description' => 'The unified verification token that is returned by the client SDKs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'LD108enNdlsl*******sFLKCks1==', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID, which is used to troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47'."\n", ], 'Model' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'PhoneNumber' => [ 'description' => 'The phone number, which is returned when the verification is successful.'."\n", 'type' => 'string', 'example' => '180********', 'title' => '', ], 'VerifyResult' => [ 'description' => 'The verification result. Valid values: PASS and UNKNOWN.'."\n", 'type' => 'string', 'example' => 'PASS', 'title' => '', ], 'PhoneScore' => [ 'description' => 'The phone number score, which is generated only after the phone number scoring node is enabled and the verification is successful. The higher the score, the more risky the phone number. Valid values: 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => '', ], ], ], 'Code' => [ 'description' => 'The response code. If OK is returned, the request is successful. Other values indicate that the request failed. For more information, see Error codes.'."\n", 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values: true false'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'SchemeNumberOverLimit', 'errorMessage' => 'The maximum number of scheme is exceeded.', ], [ 'errorCode' => 'SmsCodeVerifyFail', 'errorMessage' => 'The specified smsCode is invalid.', ], [ 'errorCode' => 'SmsSignNameNotExist', 'errorMessage' => 'The specified sms signName is invalid.', ], [ 'errorCode' => 'Throttling.System', 'errorMessage' => 'The request was denied due to API flow control.', ], [ 'errorCode' => 'UnknowError', 'errorMessage' => 'The requested service is not available now, please try again later.', ], [ 'errorCode' => 'Unsupported.Account', 'errorMessage' => 'Your account has not activated the product.', ], [ 'errorCode' => 'VerifySchemeNotExist', 'errorMessage' => 'The specified verify scheme already exists.', ], [ 'errorCode' => 'PackageSignedConflict', 'errorMessage' => 'The specified package signed already exists.', ], [ 'errorCode' => 'RamPermissionDeny', 'errorMessage' => 'The user is not authorized to operate on the specified resource.', ], [ 'errorCode' => 'SceneQueryFail', 'errorMessage' => 'The specified scene does not exist.', ], [ 'errorCode' => 'SchemeNotPassed', 'errorMessage' => 'The scheme is not passed.', ], ], 403 => [ [ 'errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'Failed to verify your access permissions.', ], ], 500 => [ [ 'errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred.', ], [ 'errorCode' => 'OutOfService', 'errorMessage' => 'The account is suspended.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\\\n\\",\\n \\"Model\\": {\\n \\"PhoneNumber\\": \\"180****1234\\",\\n \\"VerifyResult\\": \\"PASS\\",\\n \\"PhoneScore\\": 20\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'VerifyWithFusionAuthToken', ], 'GetSmsAuthTokens' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '92630', 'abilityTreeNodes' => [ 'FEATUREdypnsZ7LLRH', ], ], 'parameters' => [ [ 'name' => 'PackageName', 'in' => 'query', 'schema' => [ 'description' => 'The package name. This parameter is required if OsType is set to **Android**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.aliqin.mytel.test', ], ], [ 'name' => 'SignName', 'in' => 'query', 'schema' => [ 'description' => 'The signature. This parameter is required if OsType is set to **Android**.'."\n", 'type' => 'string', 'required' => false, 'example' => '47fcc6615485e83b4100433****', ], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => [ 'description' => 'The service code.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC100000134840112', ], ], [ 'name' => 'OsType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operating system. Valid values: **Android** and **iOS**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Android', ], ], [ 'name' => 'BundleId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the iOS application. This parameter is required if OsType is set to **iOS**.'."\n", 'type' => 'string', 'required' => false, 'example' => '12345****', ], ], [ 'name' => 'Expire', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the token. Unit: seconds. Valid values: 900 to 43200.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '43200', 'minimum' => '900', 'example' => '900', ], ], [ 'name' => 'SmsTemplateCode', 'in' => 'query', 'schema' => [ 'description' => 'The code of the text message template.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS_13987****', ], ], [ 'name' => 'SmsCodeExpire', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the SMS verification code. Unit: seconds. Default value: 180.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BizToken' => [ 'description' => 'The business token.'."\n", 'type' => 'string', 'example' => 'FZSMeRbLCiapIBo65NXNHvGbkGDmhs23XWTZDOtZN0g5n/kqSc2FU27Gc9YhGb6dNn9/L9ZXSYiIB6C6LMLQJjyXjRzt5v6pzZXqnjO4cSuPWYUxJvdc8l8OpucEYe8Mx17HxsHDzj0VC4D5+atcrTpJE6jQ7e2QVNjZIPMwsfxELjQS7c****', ], 'StsAccessKeySecret' => [ 'description' => 'The AccessKey secret.'."\n", 'type' => 'string', 'example' => 'VboZ4xbZ****', ], 'StsAccessKeyId' => [ 'description' => 'The AccessKey ID.'."\n", 'type' => 'string', 'example' => 'STS.NSqC****', ], 'ExpireTime' => [ 'description' => 'The time when the token expired. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1631526326000', ], 'StsToken' => [ 'description' => 'The security token.'."\n", 'type' => 'string', 'example' => 'CAISiQJ1q6Ft5B2yfSjIr5DEDP/BurtW9PemMEfBrEpsOr5K17XjuDz2IHtLfXFsBusYt/U2nWpX5v4clrxIToR7SFbFY9pb6ZhazBisebDGv8HtR3TcFEjiSwapEBfe8JL4QYeQFaHwGJqEb1TDiVUAo9/TfimjWFqIKICAjYUdAP0cQgi/a0gtZr4UXHwAzvUXLnzML/2gHwf3i27LdipStxF7lHl05NbUoKTeyGKH3AGqlLVF9tite8f9NpczBvolDYfpht4RX7HazStd5yJN8KpLl6Fe8V/FxIrGXAAJv0rdbbOFq4Q1c18hOLJHAKtfsvXmlPNpsevfmpnsx****', ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'SmsSignNameNotExist', 'errorMessage' => 'The specified sms signName is invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"Data\\": {\\n \\"BizToken\\": \\"FZSMeRbLCiapIBo65NXNHvGbkGDmhs23XWTZDOtZN0g5n/kqSc2FU27Gc9YhGb6dNn9/L9ZXSYiIB6C6LMLQJjyXjRzt5v6pzZXqnjO4cSuPWYUxJvdc8l8OpucEYe8Mx17HxsHDzj0VC4D5+atcrTpJE6jQ7e2QVNjZIPMwsfxELjQS7c****\\",\\n \\"StsAccessKeySecret\\": \\"VboZ4xbZ****\\",\\n \\"StsAccessKeyId\\": \\"STS.NSqC****\\",\\n \\"ExpireTime\\": 1631526326000,\\n \\"StsToken\\": \\"CAISiQJ1q6Ft5B2yfSjIr5DEDP/BurtW9PemMEfBrEpsOr5K17XjuDz2IHtLfXFsBusYt/U2nWpX5v4clrxIToR7SFbFY9pb6ZhazBisebDGv8HtR3TcFEjiSwapEBfe8JL4QYeQFaHwGJqEb1TDiVUAo9/TfimjWFqIKICAjYUdAP0cQgi/a0gtZr4UXHwAzvUXLnzML/2gHwf3i27LdipStxF7lHl05NbUoKTeyGKH3AGqlLVF9tite8f9NpczBvolDYfpht4RX7HazStd5yJN8KpLl6Fe8V/FxIrGXAAJv0rdbbOFq4Q1c18hOLJHAKtfsvXmlPNpsevfmpnsx****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 请求成功\\n 8906582E-6722\\n \\n FZSMeRbLCiapIBo65NXNHvGbkGDmhs23XWTZDOtZN0g5n/kqSc2FU27Gc9YhGb6dNn9/L9ZXSYiIB6C6LMLQJjyXjRzt5v6pzZXqnjO4cSuPWYUxJvdc8l8OpucEYe8Mx17HxsHDzj0VC4D5+atcrTpJE6jQ7e2QVNjZIPMwsfxELjQS7c****\\n VboZ4xbZ****\\n STS.NSqC****\\n 1631526326000\\n CAISiQJ1q6Ft5B2yfSjIr5DEDP/BurtW9PemMEfBrEpsOr5K17XjuDz2IHtLfXFsBusYt/U2nWpX5v4clrxIToR7SFbFY9pb6ZhazBisebDGv8HtR3TcFEjiSwapEBfe8JL4QYeQFaHwGJqEb1TDiVUAo9/TfimjWFqIKICAjYUdAP0cQgi/a0gtZr4UXHwAzvUXLnzML/2gHwf3i27LdipStxF7lHl05NbUoKTeyGKH3AGqlLVF9tite8f9NpczBvolDYfpht4RX7HazStd5yJN8KpLl6Fe8V/FxIrGXAAJv0rdbbOFq4Q1c18hOLJHAKtfsvXmlPNpsevfmpnsx****\\n \\n","errorExample":""}]', 'title' => 'GetSmsAuthTokens', 'summary' => 'Obtains the authorization token for an SMS verification code.', 'description' => '### [](#)Preparations'."\n" ."\n" .'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](~~313209~~).'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'VerifySmsCode' => [ 'summary' => 'Verifies SMS verification codes.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'SmsCode', 'in' => 'query', 'schema' => [ 'description' => 'The SMS verification code.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12****', ], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => 'The phone number, which is used to receive SMS verification codes.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1321111****', ], ], [ 'name' => 'SmsToken', 'in' => 'query', 'schema' => [ 'description' => 'The text message verification code. After you successfully call the corresponding API operation to send the SMS verification code, the end users receive the SMS verification code. SmsToken is returned by the SDK for SMS verification for you to verify the text message verification code. For an Android client, sendVerifyCode is called to send the verification code. For an iOS client, sendVerifyCodeWithTimeout is called to send the verification code. For more information, see [Overview](~~400434~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sddsbvdbvjd****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Unsupported.Account', 'errorMessage' => 'Your account has not activated the product.', ], [ 'errorCode' => 'SmsCodeVerifyFail', 'errorMessage' => 'The specified smsCode is invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"8906582E-6722\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 请求成功\\n true\\n 8906582E-6722\\n","errorExample":""}]', 'title' => 'VerifySmsCode', 'description' => '### [](#)Preparations'."\n" ."\n" .'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](~~313209~~).'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'GetAuthorizationUrl' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'PhoneNo', 'in' => 'query', 'schema' => [ 'description' => 'The phone number.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1390000****', ], ], [ 'name' => 'SchemeId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the authorization scenario. You can view the ID of the authorization scenario on the **Authorization Scenario Management** page in the **Phone Number Verification Service console**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '234****', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'description' => 'The authorization end date, which is in the yyyy-MM-dd format. This parameter is required for services of contract type.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020–12–28', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AuthorizationUrl' => [ 'description' => 'The authorization URL.'."\n", 'type' => 'string', 'example' => 'https://render.****.com/p/s/web-call-minapp/auth-bao?page=commauth/index&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJiaXpUeXBlIjoiQ29tbUF1dGgiLCJiaXpJZCI6IjVmNWZjNjAzZDQzMTQ0MWZiYTZiNjYzM2QyMjIyNzU0IiwiZXhwIjoxNjA4MTkxODQxfQ.5IvBj2nKgr60APtotaIB13vtPVrdsPQ6avIfWxte1pA&_env=prod', ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters', 'errorMessage' => 'The specified parameter is not valid.', ], [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify the parameter.', ], [ 'errorCode' => 'Throttling.System', 'errorMessage' => 'The request was denied due to API flow control.', ], [ 'errorCode' => 'MobileNumberIllgeal', 'errorMessage' => 'The specified mobile phone number is invalid.', ], [ 'errorCode' => 'DataNotFound', 'errorMessage' => 'The specified scheme does not exist.', ], [ 'errorCode' => 'IllegalParameter', 'errorMessage' => 'The specified endDate is invalid.', ], [ 'errorCode' => 'SchemeNotPassed', 'errorMessage' => 'The scheme is not passed.', ], ], 403 => [ [ 'errorCode' => 'Forbidden', 'errorMessage' => 'The user is not authorized to operate on the specified resource.', ], [ 'errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'Failed to verify your access permissions.', ], ], 500 => [ [ 'errorCode' => 'IdentityCertifyNotExist', 'errorMessage' => 'The identity verification record does not exist.', ], [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', ], [ 'errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred.', ], [ 'errorCode' => 'OutOfService', 'errorMessage' => 'The account is suspended.', ], [ 'errorCode' => 'FunctionNotSubscribed', 'errorMessage' => 'You have not subscribed to the function.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"Data\\": {\\n \\"AuthorizationUrl\\": \\"https://render.****.com/p/s/web-call-minapp/auth-bao?page=commauth/index&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJiaXpUeXBlIjoiQ29tbUF1dGgiLCJiaXpJZCI6IjVmNWZjNjAzZDQzMTQ0MWZiYTZiNjYzM2QyMjIyNzU0IiwiZXhwIjoxNjA4MTkxODQxfQ.5IvBj2nKgr60APtotaIB13vtPVrdsPQ6avIfWxte1pA&_env=prod\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 请求成功\\n 8906582E-6722\\n \\n https://render.****.com/p/s/web-call-minapp/auth-bao?page=commauth/index&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJiaXpUeXBlIjoiQ29tbUF1dGgiLCJiaXpJZCI6IjVmNWZjNjAzZDQzMTQ0MWZiYTZiNjYzM2QyMjIyNzU0IiwiZXhwIjoxNjA4MTkxODQxfQ.5IvBj2nKgr60APtotaIB13vtPVrdsPQ6avIfWxte1pA&_env=prod\\n \\n","errorExample":""}]', 'title' => 'GetAuthorizationUrl', 'summary' => 'Obtains the URL for the Alipay account authorization.', 'description' => '### [](#)Preparations'."\n" ."\n" .'You must register an Alibaba Cloud account and obtain an Alibaba Cloud AccessKey pair. For more information, see [Process of communication authorization](~~196922~~).'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', ], 'CreateSchemeConfig' => [ 'summary' => 'Creates a code for a converged communication authentication service.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '193622', 'abilityTreeNodes' => [ 'FEATUREdypnsF4260C', ], ], 'parameters' => [ [ 'name' => 'SchemeName', 'in' => 'query', 'schema' => [ 'title' => '方案名称，由中、英文字母构成，长度限制为10个字符。'."\n", 'description' => 'The service name, which can be up to 10 characters in length and can contain letters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Aliyun', ], ], [ 'name' => 'Platform', 'in' => 'query', 'schema' => [ 'title' => '方案应用平台', 'description' => 'The app platform.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Android'."\n" .'* iOS'."\n", 'type' => 'string', 'required' => true, 'example' => 'Android', 'enum' => [ 'Android', 'iOS', ], ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'title' => '应用方案的App名称，由中、英文字母构成，长度限制20个字符。', 'description' => 'The app name, which can be up to 20 characters in length and can contain letters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Alibaba Cloud Communications', ], ], [ 'name' => 'AndroidPackageName', 'in' => 'query', 'schema' => [ 'title' => '包名，Platform为Android时必选。由数字、字母、短划线（-）、下划线或点组成，长度限制为1~128个字符。', 'description' => 'The package name. This parameter is required when Platform is set to Android. The name must be 1 to 128 characters in length and can contain digits, letters, hyphens (-), underscores (\\_), and periods (.).'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.aliyun.android', ], ], [ 'name' => 'AndroidPackageSign', 'in' => 'query', 'schema' => [ 'title' => '包签名，Platform为Android时必选。由数字和字母组成，长度为32个字符。', 'description' => 'The package signature. This parameter is required when Platform is set to Android. The signature must be 32 characters in length and can contain digits and letters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dfsfaawklll1****olkweklk***', ], ], [ 'name' => 'IosBundleId', 'in' => 'query', 'schema' => [ 'title' => 'BundleID，osType为iOS时必选。由数字、字母、短划线（-）、下划线或点组成，长度限制为1~128个字符。', 'description' => 'The bundle ID. This parameter is required when OsType is set to iOS. The bundle ID must be 1 to 128 characters in length and can contain digits, letters, hyphens (-), underscores (\\_), and periods (.).'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.aliyun.ios', ], ], [ 'name' => 'H5Url', 'in' => 'query', 'schema' => [ 'title' => '保留字段，暂不支持H5方案', 'description' => 'The reserved field. HTML5 apps are not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', ], ], [ 'name' => 'H5Origin', 'in' => 'query', 'schema' => [ 'title' => '保留字段，暂不支持H5方案。', 'description' => 'The reserved field. HTML5 apps are not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B95B36EC-8108-4479-D3AA-2BB27F9B155A'."\n", ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Model' => [ 'description' => 'The returned results.'."\n", 'type' => 'object', 'properties' => [ 'SchemeCode' => [ 'description' => 'The service code.'."\n", 'type' => 'string', 'example' => 'FA100000168468035', ], ], ], 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](https://help.aliyun.com/zh/pnvs/developer-reference/api-return-code?spm=a2c4g.11186623.0.0.5c3a662fbgeAuk).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], ], 'description' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B95B36EC-8108-4479-D3AA-2BB27F9B155A\\\\n\\",\\n \\"Message\\": \\"成功\\",\\n \\"Model\\": {\\n \\"SchemeCode\\": \\"FA100000168468035\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'CreateSchemeConfig', ], 'CreateVerifyScheme' => [ 'summary' => 'Creates a verification service.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '92619', 'abilityTreeNodes' => [ 'FEATUREdypns8SCJSK', ], ], 'parameters' => [ [ 'name' => 'SchemeName', 'in' => 'query', 'schema' => [ 'description' => 'The service name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Aliyun', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => 'The app name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Alibaba Cloud Communications', ], ], [ 'name' => 'OsType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operating system for the terminal. Valid values: iOS and Android.'."\n", 'type' => 'string', 'required' => true, 'example' => 'iOS', ], ], [ 'name' => 'PackName', 'in' => 'query', 'schema' => [ 'description' => 'The package name. This parameter is required when OsType is set to Android. The name must be 1 to 128 characters in length and can contain digits, letters, hyphens (-), underscores (\\_), and periods (.).'."\n", 'type' => 'string', 'required' => false, 'example' => 'com.aliyun', ], ], [ 'name' => 'PackSign', 'in' => 'query', 'schema' => [ 'description' => 'The package signature. This parameter is required when OsType is set to Android. The signature must be 32 characters in length and can contain digits and letters.'."\n", 'type' => 'string', 'required' => false, 'example' => '123aliyun', ], ], [ 'name' => 'BundleId', 'in' => 'query', 'schema' => [ 'description' => 'The bundle ID. This parameter is required when OsType is set to iOS. The bundle ID must be 1 to 128 characters in length and can contain digits, letters, hyphens (-), underscores (\\_), and periods (.).'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'Origin', 'in' => 'query', 'schema' => [ 'description' => 'The source URL of the HTML5 app page. We recommend that you specify this parameter as a domain name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://h5.minexiot.com', ], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => [ 'description' => 'The URL of the HTML5 app page.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://h5.minexiot.com/index.html', ], ], [ 'name' => 'IpWhiteList', 'in' => 'query', 'schema' => [ 'description' => 'The IP address whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '139.9.167.181'."\n" .'122.112.210.205'."\n" .'139.9.172.0/24', ], ], [ 'name' => 'CmApiCode', 'in' => 'query', 'schema' => [ 'description' => 'The channel code of China Mobile.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CuApiCode', 'in' => 'query', 'schema' => [ 'description' => 'The channel code of China Unicom.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], ], [ 'name' => 'CtApiCode', 'in' => 'query', 'schema' => [ 'description' => 'The channel code of China Telecom.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', ], ], [ 'name' => 'SceneType', 'in' => 'query', 'schema' => [ 'description' => 'The service type.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => [ 'description' => 'The email address that receives the key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'username@aliyundoc.com', ], ], [ 'name' => 'AuthType', 'in' => 'query', 'schema' => [ 'description' => 'The verification type. You can select multiple types only when the phone number verification is supported. Separate multiple types with commas (,).'."\n" ."\n" .'* **1**: phone number verification'."\n" .'* **2**: SMS verification'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2', ], ], [ 'name' => 'SmsSignName', 'in' => 'query', 'schema' => [ 'description' => 'The bound SMS signature. This parameter is valid only when AuthType is set to 2. The signature must be approved.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Aliyun Test', ], ], [ 'name' => 'HmPackageName', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'HmSignName', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'HmAppIdentifier', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A1E75E69-3049-5FDB-A376-D745837CD2B1', ], 'GateVerifySchemeDTO' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'SchemeCode' => [ 'description' => 'The service code.'."\n", 'type' => 'string', 'example' => 'FC10001287****', ], ], ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'SchemeNumberOverLimit', 'errorMessage' => 'The maximum number of scheme is exceeded.', ], [ 'errorCode' => 'BundleIdConflict', 'errorMessage' => 'The specified bundleId already exists.', ], [ 'errorCode' => 'InvalidParameters', 'errorMessage' => 'The specified parameter is not valid.', ], [ 'errorCode' => 'InvalidAccountStatus', 'errorMessage' => 'Your account has been suspended.', ], [ 'errorCode' => 'RamPermissionDeny', 'errorMessage' => 'The user is not authorized to operate on the specified resource.', ], [ 'errorCode' => 'PackageSignedConflict', 'errorMessage' => 'The specified package signed already exists.', ], [ 'errorCode' => 'Unsupported.Account', 'errorMessage' => 'Your account has not activated the product.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"A1E75E69-3049-5FDB-A376-D745837CD2B1\\",\\n \\"GateVerifySchemeDTO\\": {\\n \\"SchemeCode\\": \\"FC10001287****\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 请求成功\\n 8906582E6722\\n \\n FC10001287****\\n \\n","errorExample":""}]', 'title' => 'CreateVerifyScheme', 'description' => '### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteVerifyScheme' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'SchemeCode', 'in' => 'query', 'schema' => [ 'description' => 'The service code.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC10000014164****', ], ], [ 'name' => 'CustomerId', 'in' => 'query', 'schema' => [ 'description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345678', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The request is successful. For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E3754956-D0B1-5947-962A-AE767D354F01', ], 'Result' => [ 'description' => 'The result of the operation. Valid values:'."\n" ."\n" .'* **true**: The verification service is deleted.'."\n" .'* **false**: The verification service failed to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Throttling.System', 'errorMessage' => 'The request was denied due to API flow control.', ], [ 'errorCode' => 'InvalidAccountStatus', 'errorMessage' => 'Your account has been suspended.', ], [ 'errorCode' => 'Unsupported.Account', 'errorMessage' => 'Your account has not activated the product.', ], [ 'errorCode' => 'InvalidParameters', 'errorMessage' => 'The specified parameter is not valid.', ], ], 403 => [ [ 'errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'You are not authorized to perform this operation.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', ], [ 'errorCode' => 'SystemError', 'errorMessage' => 'An error occurred while processing your request.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"E3754956-D0B1-5947-962A-AE767D354F01\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n OK\\n E3754956-D0B1-5947-962A-AE767D354F01\\n true\\n","errorExample":""}]', 'title' => 'DeleteVerifyScheme', 'summary' => 'Deletes a verification service.', 'description' => '### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeVerifyScheme' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'SchemeCode', 'in' => 'query', 'schema' => [ 'description' => 'The service code.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC10000010643****', ], ], [ 'name' => 'CustomerId', 'in' => 'query', 'schema' => [ 'description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code. OK indicates that the request is successful. For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0C5380A7-2032-5F7D-9614-1BF8B54D16CB', ], 'SchemeQueryResultDTO' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AppEncryptInfo' => [ 'description' => 'The key generated when you create a service in the console.'."\n", 'type' => 'string', 'example' => 'ZDMARqPkyQzWVJjB/sB/+fCp5TA4lNsRnY7rEC+HfGsOIOk1Brj8UyXFW2RBYIWqLieCSo8ZypEaEj+h9rLd3FgpXAjGYDfmOperod6jPUUwFHhBObxK+HuKVoi2jOqN7aDOlyPyGcATyq3BDdlf922JmnFLT8Hvnu4qgzzCZk0LXWTb0XVPnm5/fHUGHEA2Q+aTrGkaWcHjmTDqQ7BtvrAIIcJJkCJu4i1aeU++/0EzGWap4mcb2VhKROBs****', ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Throttling.System', 'errorMessage' => 'The request was denied due to API flow control.', ], [ 'errorCode' => 'InvalidAccountStatus', 'errorMessage' => 'Your account has been suspended.', ], [ 'errorCode' => 'Unsupported.Account', 'errorMessage' => 'Your account has not activated the product.', ], [ 'errorCode' => 'SceneQueryFail', 'errorMessage' => 'The specified scene does not exist.', ], ], 403 => [ [ 'errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'You are not authorized to perform this operation.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', ], [ 'errorCode' => 'SystemError', 'errorMessage' => 'An error occurred while processing your request.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"0C5380A7-2032-5F7D-9614-1BF8B54D16CB\\",\\n \\"SchemeQueryResultDTO\\": {\\n \\"AppEncryptInfo\\": \\"ZDMARqPkyQzWVJjB/sB/+fCp5TA4lNsRnY7rEC+HfGsOIOk1Brj8UyXFW2RBYIWqLieCSo8ZypEaEj+h9rLd3FgpXAjGYDfmOperod6jPUUwFHhBObxK+HuKVoi2jOqN7aDOlyPyGcATyq3BDdlf922JmnFLT8Hvnu4qgzzCZk0LXWTb0XVPnm5/fHUGHEA2Q+aTrGkaWcHjmTDqQ7BtvrAIIcJJkCJu4i1aeU++/0EzGWap4mcb2VhKROBs****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"OK\\n0C5380A7-2032-5F7D-9614-1BF8B54D16CB\\nOK\\n\\n ZDMARqPkyQzWVJjB/sB/+fCp5TA4lNsRnY7rEC+HfGsOIOk1Brj8UyXFW2RBYIWqLieCSo8ZypEaEj+h9rLd3FgpXAjGYDfmOperod6jPUUwFHhBObxK+HuKVoi2jOqN7aDOlyPyGcATyq3BDdlf922JmnFLT8Hvnu4qgzzCZk0LXWTb0XVPnm5/fHUGHEA2Q+aTrGkaWcHjmTDqQ7BtvrAIIcJJkCJu4i1aeU++/0EzGWap4mcb2VhKROBs****\\n","errorExample":""}]', 'title' => 'DescribeVerifyScheme', 'summary' => 'Queries the details of a verification service.', 'description' => '### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'QueryGateVerifyStatisticPublic' => [ 'summary' => 'Queries the calls of Phone Number Verification Service.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => [ 'description' => 'The service code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FC100000038194004', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'description' => 'The start date. Specify this parameter in the YYYYMMDD format. Example: 20220101.'."\n", 'type' => 'string', 'required' => true, 'example' => '20220101', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'description' => 'The end date. Specify this parameter in the YYYYMMDD format. Example: 20220106.'."\n", 'type' => 'string', 'required' => true, 'example' => '20220106', ], ], [ 'name' => 'AuthenticationType', 'in' => 'query', 'schema' => [ 'description' => 'The verification method. Valid values:'."\n" ."\n" .'* **1**: one-click logon'."\n" .'* **2**: phone number verification, including the verification of the phone number used in HTML5 pages'."\n" .'* **3**: SMS verification'."\n" .'* **4**: facial recognition'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '99', 'minimum' => '0', 'example' => '1', ], ], [ 'name' => 'OsType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **Android**'."\n" .'* **iOS**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Android', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code. Valid values:'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], 'Data' => [ 'description' => 'The information about the calls of Phone Number Verification Service, including the total calls, the successful calls, failed calls, unknown calls, and daily calls within the statistical date range.'."\n", 'type' => 'object', 'properties' => [ 'TotalFail' => [ 'description' => 'The failed calls.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Total' => [ 'description' => 'The total calls.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'TotalSuccess' => [ 'description' => 'The successful calls.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'TotalUnknown' => [ 'description' => 'The unknown calls.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DayStatistic' => [ 'description' => 'The information about the daily calls.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StatisticDateStr' => [ 'description' => 'The date. This field is accurate to the day. The value of this field is in the YYYYMMDD format. Example: 20220103.'."\n", 'type' => 'string', 'example' => '20220103', ], 'TotalSuccess' => [ 'description' => 'The successful calls on the day.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'TotalFail' => [ 'description' => 'The failed calls on the day.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'TotalUnknown' => [ 'description' => 'The unknown calls on the day.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"Data\\": {\\n \\"TotalFail\\": 20,\\n \\"Total\\": 20,\\n \\"TotalSuccess\\": 0,\\n \\"TotalUnknown\\": 0,\\n \\"DayStatistic\\": [\\n {\\n \\"StatisticDateStr\\": \\"20220103\\",\\n \\"TotalSuccess\\": 0,\\n \\"TotalFail\\": 20,\\n \\"TotalUnknown\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 请求成功\\n 8906582E-6722\\n \\n 20\\n 20\\n 0\\n 0\\n \\n 20220103\\n 0\\n 20\\n 0\\n \\n \\n","errorExample":""}]', 'title' => 'QueryGateVerifyStatisticPublic', 'description' => '### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", ], 'QueryGateVerifyBillingPublic' => [ 'summary' => 'Queries the fees generated by a verification service.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'Month', 'in' => 'query', 'schema' => [ 'description' => 'The month in which the bill is generated. Specify this parameter in the YYYYMM format. Example: 202111.'."\n", 'type' => 'string', 'required' => true, 'example' => '202111', ], ], [ 'name' => 'AuthenticationType', 'in' => 'query', 'schema' => [ 'description' => 'The verification method. Valid values:'."\n" ."\n" .'* **0**: phone number verification'."\n" .'* **1**: one-click logon'."\n" .'* **2**: all'."\n" .'* **3**: facial recognition'."\n" .'* **4**: SMS verification'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '99', 'minimum' => '0', 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code. Valid values:'."\n" ."\n" .'* If OK is returned, the request is successful.'."\n" .'* For more information about other error codes, see [API response codes](~~85198~~).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8906582E-6722', ], 'Data' => [ 'description' => 'The billing information about each verification service.'."\n", 'type' => 'object', 'properties' => [ 'AmountSum' => [ 'description' => 'The fees generated for all verification services. Unitrogen: CNY.'."\n", 'type' => 'string', 'example' => '1234', ], 'SceneBillingList' => [ 'description' => 'The details of fees.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Add' => [ 'description' => 'The billable items.'."\n", 'type' => 'string', 'example' => '74', ], 'SinglePrice' => [ 'description' => 'The unit price. Unit: CNY.'."\n", 'type' => 'string', 'example' => '0.02', ], 'Amount' => [ 'description' => 'The fees generated for the verification service. Unitrogen: CNY.'."\n", 'type' => 'string', 'example' => '1.48', ], 'ItemName' => [ 'description' => 'The verification method.'."\n", 'type' => 'string', 'example' => 'Verification of local phone number', ], 'SceneCode' => [ 'description' => 'The service code.'."\n", 'type' => 'string', 'example' => 'FC100000038194004', ], 'AppName' => [ 'description' => 'The application name.'."\n", 'type' => 'string', 'example' => 'Aliyun', ], 'SceneName' => [ 'description' => 'The service name.'."\n", 'type' => 'string', 'example' => 'Alibaba Cloud Communications', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"Data\\": {\\n \\"AmountSum\\": \\"1234\\",\\n \\"SceneBillingList\\": [\\n {\\n \\"Add\\": \\"74\\",\\n \\"SinglePrice\\": \\"0.02\\",\\n \\"Amount\\": \\"1.48\\",\\n \\"ItemName\\": \\"本机号码校验\\",\\n \\"SceneCode\\": \\"FC100000038194004\\",\\n \\"AppName\\": \\"阿里云\\",\\n \\"SceneName\\": \\"阿里云通信\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 请求成功\\n 8906582E-6722\\n \\n 92760\\n 1234\\n \\n 74\\n 15810****\\n 0.02\\n 1.48\\n 本机号码校验\\n FC100000038194004\\n 阿里云\\n 阿里云通信\\n www.example.com\\n \\n \\n","errorExample":""}]', 'title' => 'QueryGateVerifyBillingPublic', 'description' => '### [](#qps)QPS limits'."\n" ."\n" .'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.'."\n", ], 'QuerySendDetails' => [ '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.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => 'The phone number.'."\n", 'type' => 'string', 'required' => true, 'example' => '186****9399', ], ], [ 'name' => 'SendDate', 'in' => 'query', 'schema' => [ 'description' => 'The date when the text message was sent. You can query text messages that were sent within the last 30 days.'."\n" ."\n" .'Specify the date in the yyyyMMdd format. Example: 20181225.'."\n", 'type' => 'string', 'required' => true, 'example' => '20181225', ], ], [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the business, which is provided by Alibaba Cloud.'."\n", 'type' => 'string', 'required' => false, 'example' => '1231891289318923^12', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '50', 'default' => '', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page on which you are reading the text message. Pages start from page 1. The value of this parameter cannot exceed the maximum page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'default' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => 'The details about the access denial.'."\n", 'type' => 'string', 'example' => 'none', ], 'TotalCount' => [ 'description' => 'The total number of entries in the list.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '42', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Model' => [ 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TemplateCode' => [ 'description' => 'The code of the text message template.'."\n" ."\n" .'Log on to the SMS console. In the left-side navigation pane, click **Go China** or **Go Globe**. You can view the text message template code in the **Template Code** column on the **Message Templates** tab.'."\n" ."\n" .'> The text message templates must be created on the Go Globe page and approved.'."\n", 'type' => 'string', 'example' => 'SMS_12231****'."\n", ], 'ReceiveDate' => [ 'description' => 'The date and time when the text message was received.'."\n", 'type' => 'string', 'example' => '2019-01-08 16:44:13'."\n", ], 'PhoneNum' => [ 'description' => 'The phone number.'."\n", 'type' => 'string', 'example' => '1390000****'."\n", ], 'Content' => [ 'description' => 'The content of the text message.'."\n", 'type' => 'string', 'example' => '203160', ], 'SendStatus' => [ 'description' => 'The delivery status of the text message.'."\n" ."\n" .'* 1: A delivery receipt is to be sent.'."\n" .'* 2: The text message failed to be sent.'."\n" .'* 3: The text message was sent.'."\n", 'type' => 'integer', 'format' => 'int64', 'enumValueTitles' => [], 'example' => '3', ], 'OutId' => [ 'description' => 'The extension field.'."\n", 'type' => 'string', 'example' => '12131231', ], 'SendDate' => [ 'description' => 'The date when the text message was sent. You can query text messages that were sent within the last 30 days.'."\n" ."\n" .'The date is in the yyyyMMdd format. Example: 20181225.'."\n", 'type' => 'string', 'example' => '2019-01-08 16:44:13'."\n", ], 'ErrCode' => [ 'description' => 'The status code returned by the carrier.'."\n" ."\n" .'* If the text message was delivered, "DELIVERED" is returned.'."\n" .'* If the text message failed to be sent, see [Error codes](https://help.aliyun.com/document_detail/101347.html?spm=a2c4g.419277.0.i8) for more information.'."\n", 'type' => 'string', 'example' => 'DELIVERED', ], ], ], 'example' => '', ], 'Code' => [ 'description' => 'The response code.'."\n" ."\n" .'If OK is returned, the request is successful. Other values indicate that the request failed. For more information, see [Error codes](https://help.aliyun.com/document_detail/101346.html?spm=a2c4g.419277.0.i11).'."\n", 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"TotalCount\\": 42,\\n \\"Message\\": \\"成功\\",\\n \\"Model\\": [\\n {\\n \\"TemplateCode\\": \\"SMS_12231****\\\\n\\",\\n \\"ReceiveDate\\": \\"2019-01-08 16:44:13\\\\n\\",\\n \\"PhoneNum\\": \\"1390000****\\\\n\\",\\n \\"Content\\": \\"203160\\",\\n \\"SendStatus\\": 3,\\n \\"OutId\\": \\"12131231\\",\\n \\"SendDate\\": \\"2019-01-08 16:44:13\\\\n\\",\\n \\"ErrCode\\": \\"DELIVERED\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'QuerySendDetails', ], ], 'endpoints' => [ [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-qingdao', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], [ 'regionId' => 'cn-north-2-gov-1', 'endpoint' => 'dypnsapi.aliyuncs.com', ], ], ];