diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/dytnsapi | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/dytnsapi')
| -rw-r--r-- | data/en_us/dytnsapi/2020-02-17/api-docs.php | 6324 | ||||
| -rw-r--r-- | data/en_us/dytnsapi/2023-01-01/api-docs.php | 694 |
2 files changed, 7018 insertions, 0 deletions
diff --git a/data/en_us/dytnsapi/2020-02-17/api-docs.php b/data/en_us/dytnsapi/2020-02-17/api-docs.php new file mode 100644 index 0000000..0d833e9 --- /dev/null +++ b/data/en_us/dytnsapi/2020-02-17/api-docs.php @@ -0,0 +1,6324 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dytnsapi', + 'version' => '2020-02-17', + ], + 'directories' => [ + [ + 'id' => 346319, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CertNoTwoElementVerification', + 'CertNoThreeElementVerification', + ], + ], + [ + 'id' => 346322, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetUAIDApplyTokenSign', + 'UAIDVerification', + ], + ], + [ + 'id' => 346325, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CompanyTwoElementsVerification', + 'CompanyThreeElementsVerification', + 'CompanyFourElementsVerification', + ], + ], + [ + 'id' => 346329, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribePhoneNumberOperatorAttribute', + ], + ], + [ + 'id' => 346331, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'PhoneNumberStatusForPublic', + 'PhoneNumberStatusForAccount', + 'PhoneNumberStatusForReal', + 'PhoneNumberStatusForSms', + 'PhoneNumberStatusForVoice', + ], + ], + [ + 'id' => 346337, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribePhoneTwiceTelVerify', + ], + ], + [ + 'id' => 346339, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribePhoneNumberOnlineTime', + ], + ], + [ + 'id' => 346341, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribePhoneNumberAnalysisAI', + 'DescribePhoneNumberAnalysis', + ], + ], + [ + 'id' => 346344, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeEmptyNumber', + ], + ], + [ + 'id' => 346346, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'TwoElementsVerification', + 'ThreeElementsVerification', + ], + ], + [ + 'id' => 346349, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'PhoneNumberEncrypt', + ], + ], + [ + 'id' => 346351, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'InvalidPhoneNumberFilter', + ], + ], + [ + 'id' => 346353, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QueryTagListPage', + 'QueryTagInfoBySelection', + 'QueryUsageStatisticsByTagId', + 'QueryTagApplyRule', + ], + ], + [ + 'id' => 346358, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QueryAvailableAuthCode', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'ListContacts', + 'SaveContacts', + 'UpdateContacts', + 'DeleteContacts', + 'QueryPackageTypeInfo', + 'QueryTaskList', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CertNoTwoElementVerification' => [ + 'summary' => '身份证二要素认证', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '200459', + 'abilityTreeNodes' => [ + 'FEATUREdytnsHIUT2Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'QASDW@#**', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '331021200001010000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IsConsistent' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"IsConsistent\\": \\"1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CertNoThreeElementVerification' => [ + 'summary' => '身份证三要素', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '231962', + 'abilityTreeNodes' => [ + 'FEATUREdytnsOFD0CE', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'QASDW@#**', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '3***************0', + ], + ], + [ + 'name' => 'CertPicture', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'iVBOFMKODOFNDFP123DFSMOO...', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + 'default' => 'NORMAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD******177', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IsConsistent' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD******177\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"IsConsistent\\": \\"1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'GetUAIDApplyTokenSign' => [ + 'summary' => 'Obtains the signature of an authorization token when China Mobile, China Unicom, or China Telecom provides the Uniform Anonymous Identifier (UAID) capability.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HwD97InG', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'b8b5b3a*******0b9893484fdf412c99', + ], + ], + [ + 'name' => 'ClientType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '30300', + ], + ], + [ + 'name' => 'ParamKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '955EC1A869852EA8BC66F********D7C6E92017BBD5B001C736EFEAFB775C232', + ], + ], + [ + 'name' => 'ParamStr', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'B2F0D4CD7A216D16CE2AF4BBC********29A454FDDD991F919106C12CB89ABA8', + ], + ], + [ + 'name' => 'Time', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '20121227180001165', + ], + ], + [ + 'name' => 'Carrier', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CM', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD******177', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OutId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'b8b5b3a*******0b9893484fdf412c99', + ], + 'Sign' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D2E204D74EEB373E468632********23F592C4C9', + ], + 'Carrier' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD******177\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OutId\\": \\"b8b5b3a*******0b9893484fdf412c99\\",\\n \\"Sign\\": \\"D2E204D74EEB373E468632********23F592C4C9\\",\\n \\"Carrier\\": \\"CM\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'GetUAIDApplyTokenSign', + ], + 'UAIDVerification' => [ + 'summary' => 'Obtains a Uniform Anonymous Identifier (UAID) based on the authorization token of a carrier. For more information about how to obtain the authorization token and its signature value, see the GetUAIDApplyTokenSign documentation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '195916', + 'abilityTreeNodes' => [ + 'FEATUREdytnsQNXFTN', + ], + ], + 'parameters' => [ + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'b8b5b3a*******0b9893484fdf412c99'."\n", + ], + ], + [ + 'name' => 'Carrier', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CM', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MIGfMA0********3DQEBAQUAA4GNADCB', + ], + ], + [ + 'name' => 'UserGrantId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Md****a3Em', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HwD97InG', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD******177', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Uaid' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B1E0C1********9F757AF52A035', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD******177\\",\\n \\"Data\\": {\\n \\"Uaid\\": \\"B1E0C1********9F757AF52A035\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'UAIDVerification', + ], + 'CompanyTwoElementsVerification' => [ + 'summary' => 'Verifies whether the enterprise name and the business license number belong to the same enterprise. The verification is successful only when the two elements belong to the same enterprise and the business status of the enterprise is Active.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'EpCertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business license number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '9242032*******J627'."\n", + ], + ], + [ + 'name' => 'EpCertName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The enterprise name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD135850177', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DetailInfo' => [ + 'description' => 'The information about the enterprise.'."\n", + 'type' => 'object', + 'properties' => [ + 'OpenTime' => [ + 'description' => 'The business term of the enterprise.'."\n", + 'type' => 'string', + 'example' => '2023-05-25/2053-05-24', + ], + 'EnterpriseStatus' => [ + 'description' => 'The business status of the enterprise.'."\n", + 'type' => 'string', + 'example' => 'Active'."\n", + ], + ], + 'example' => '', + ], + 'InconsistentData' => [ + 'description' => 'The fields to be verified.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '* EpCertName: the enterprise name.'."\n" + .'* EpCertNo: the business license number.'."\n", + 'type' => 'string', + 'example' => 'EpCertName', + ], + 'example' => '', + ], + 'VerifyResult' => [ + 'description' => 'The verification result. Valid values:'."\n" + ."\n" + .'* true: The two elements belong to the same enterprise and the business status of the enterprise is Active.'."\n" + .'* false: The two elements do not belong to the same enterprise.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ReasonCode' => [ + 'description' => 'The code of the verification result. Valid values:'."\n" + ."\n" + .'* 0: The two elements belong to the same enterprise.'."\n" + .'* 1: The two elements belong to the same enterprise, but the business status of the enterprise is abnormal.'."\n" + .'* 3: The two elements do not belong to the same enterprise.'."\n" + .'* 4: No information about the enterprise is found.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD135850177\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"DetailInfo\\": {\\n \\"OpenTime\\": \\"2023-05-25/2053-05-24\\",\\n \\"EnterpriseStatus\\": \\"在营（开业）\\"\\n },\\n \\"InconsistentData\\": [\\n \\"EpCertName\\"\\n ],\\n \\"VerifyResult\\": \\"true\\",\\n \\"ReasonCode\\": \\"0\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'CompanyTwoElementsVerification', + 'description' => '* Before you call this operation, make sure that you are familiar with the billing of services related to two-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).'."\n" + .'* You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0 or 1.'."\n" + .'* Before you call this operation, perform the following operations: Log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC\\&lang=zh). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n", + ], + 'CompanyThreeElementsVerification' => [ + 'summary' => 'Verifies whether the enterprise name, the business license number, and the name of the legal representative belong to the same enterprise. The verification is successful only when the three elements belong to the same enterprise and the business status of the enterprise is Active.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '195616', + 'abilityTreeNodes' => [ + 'FEATUREdytnsRFNMHG', + ], + ], + 'parameters' => [ + [ + 'name' => 'EpCertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business license number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '9242032*******J627', + ], + ], + [ + 'name' => 'EpCertName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The enterprise name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'LegalPersonCertName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the legal representative.'."\n" + ."\n" + .'> If an enterprise has multiple legal representatives, separate them with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD135850177', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DetailInfo' => [ + 'description' => 'The information about the enterprise.'."\n", + 'type' => 'object', + 'properties' => [ + 'OpenTime' => [ + 'description' => 'The business term of the enterprise.'."\n", + 'type' => 'string', + 'example' => '2023-05-25/2053-05-24', + ], + 'EnterpriseStatus' => [ + 'description' => 'The business status of the enterprise.'."\n", + 'type' => 'string', + 'example' => 'Active'."\n", + ], + ], + 'example' => '', + ], + 'InconsistentData' => [ + 'description' => 'The fields to be verified.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '* EpCertName: the enterprise name.'."\n" + .'* EpCertNo: the business license number.'."\n" + .'* CertName: the name of the legal representative.'."\n", + 'type' => 'string', + 'example' => 'CertName', + ], + 'example' => '', + ], + 'VerifyResult' => [ + 'description' => 'The verification result. Valid values:'."\n" + ."\n" + .'* true: The three elements belong to the same enterprise and the business status of the enterprise is Active.'."\n" + .'* false: The three elements do not belong to the same enterprise.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ReasonCode' => [ + 'description' => 'The code of the verification result. Valid values:'."\n" + ."\n" + .'* 0: The three elements belong to the same enterprise.'."\n" + .'* 1: The three elements belong to the same enterprise, and the business status of the enterprise is abnormal.'."\n" + .'* 2: The legal representative information cannot match the enterprise information.'."\n" + .'* 3: The three elements do not belong to the same enterprise.'."\n" + .'* 4: No information about the enterprise is found.'."\n" + .'* 5: No information about the legal representative is found.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD135850177\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"DetailInfo\\": {\\n \\"OpenTime\\": \\"2023-05-25/2053-05-24\\",\\n \\"EnterpriseStatus\\": \\"在营（开业）\\"\\n },\\n \\"InconsistentData\\": [\\n \\"CertName\\"\\n ],\\n \\"VerifyResult\\": \\"false\\",\\n \\"ReasonCode\\": 2\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'CompanyThreeElementsVerification', + 'description' => '* Before you call this operation, make sure that you are familiar with the billing of services related to three-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).'."\n" + .'* You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.'."\n" + .'* Before you call this operation, perform the following operations: Log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC\\&lang=zh). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n", + ], + 'CompanyFourElementsVerification' => [ + 'summary' => 'Verifies whether the enterprise name, the business license number, and the name and ID card of the legal representative belong to the same enterprise. The verification is successful only when the preceding four elements belong to the same enterprise and the business status of the enterprise is Active.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '195618', + 'abilityTreeNodes' => [ + 'FEATUREdytnsVTODD4', + ], + ], + 'parameters' => [ + [ + 'name' => 'EpCertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business license number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '9242032*******J627', + ], + ], + [ + 'name' => 'EpCertName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The enterprise name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'LegalPersonCertName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the legal representative.'."\n" + ."\n" + .'> If an enterprise has multiple legal representatives, separate them with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'LegalPersonCertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID card number of the legal representative.'."\n" + ."\n" + .'> If an enterprise has multiple legal representatives, separate the ID card numbers with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '331021********0011', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DetailInfo' => [ + 'description' => 'The information about the enterprise.'."\n", + 'type' => 'object', + 'properties' => [ + 'OpenTime' => [ + 'description' => 'The business term of the enterprise.'."\n", + 'type' => 'string', + 'example' => '2023-05-25/2053-05-24', + ], + 'EnterpriseStatus' => [ + 'description' => 'The business status of the enterprise.'."\n", + 'type' => 'string', + 'example' => 'Active'."\n", + ], + ], + 'example' => '', + ], + 'InconsistentData' => [ + 'description' => 'The fields to be verified.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '* EpCertName: the enterprise name.'."\n" + .'* EpCertNo: the business license number.'."\n" + .'* CertName: the name of the legal representative.'."\n" + .'* CertNo: the ID card number of the legal representative.'."\n", + 'type' => 'string', + 'example' => 'CertName', + ], + 'example' => '', + ], + 'VerifyResult' => [ + 'description' => 'The verification result. Valid values:'."\n" + ."\n" + .'* true: The four elements belong to the same enterprise and the business status of the enterprise is Active.'."\n" + .'* false: The four elements do not belong to the same enterprise.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ReasonCode' => [ + 'description' => 'The code of the verification result. Valid values:'."\n" + ."\n" + .'* 0: The four elements belong to the same enterprise.'."\n" + .'* 1: The four elements belong to the same enterprise, but the business status of the enterprise is abnormal.'."\n" + .'* 2: The legal representative information cannot match the enterprise information.'."\n" + .'* 3: The four elements do not belong to the same enterprise.'."\n" + .'* 4: No information about the enterprise is found.'."\n" + .'* 5: No information about the legal representative is found.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"DetailInfo\\": {\\n \\"OpenTime\\": \\"2023-05-25/2053-05-24\\",\\n \\"EnterpriseStatus\\": \\"在营（开业）\\"\\n },\\n \\"InconsistentData\\": [\\n \\"CertName\\"\\n ],\\n \\"VerifyResult\\": \\"true\\",\\n \\"ReasonCode\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'CompanyFourElementsVerification', + 'description' => '* Before you call this operation, make sure that you are familiar with the billing of services related to four-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).'."\n" + .'* You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.'."\n" + .'* Before you call this operation, perform the following operations: Log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC\\&lang=zh). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n", + ], + 'DescribePhoneNumberOperatorAttribute' => [ + 'summary' => 'Queries the attribute information about a phone number, including the registration province, registration city, basic carrier (such as China Mobile, China Unicom, China Telecom, or China Broadnet), reseller of mobile communications services (such as Alibaba Communications), mobile number portability, and the number segment to which the phone number belongs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '139022', + 'abilityTreeNodes' => [ + 'FEATUREdytnsK1J228', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.'."\n" + .'* If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.'."\n" + .'* If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '139****1234', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The phone number is not encrypted.'."\n" + .'* **MD5**: The phone number is MD5-encrypted.'."\n" + .'* **SHA256**: The phone number is SHA256-encrypted.'."\n" + ."\n" + .'> Letters in the string must be uppercase.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MD5', + ], + ], + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'ResultCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD135850177', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'BasicCarrier' => [ + 'description' => 'The basic carrier. Valid values:'."\n" + ."\n" + .'* **China Mobile**'."\n" + .'* **China Unicom**'."\n" + .'* **China Telecom**'."\n" + .'* **China Broadnet**'."\n", + 'type' => 'string', + 'example' => 'China Mobile', + ], + 'NumberSegment' => [ + 'description' => 'The number segment to which the phone number belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '139', + ], + 'IsNumberPortability' => [ + 'description' => 'Indicates whether the phone number involves mobile number portability. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Carrier' => [ + 'description' => 'The actual carrier, including the virtual network operator (VNO). If the phone number involves mobile number portability, the value of this parameter is the carrier after mobile number portability.'."\n", + 'type' => 'string', + 'example' => 'China Mobile', + ], + 'City' => [ + 'description' => 'The city where the phone number is registered.'."\n", + 'type' => 'string', + 'example' => 'hangzhou', + ], + 'Province' => [ + 'description' => 'The province where the phone number is registered.'."\n", + 'type' => 'string', + 'example' => 'zhejiang', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **InvalidParameter**: The specified phone number is invalid or the parameter format is invalid.'."\n" + .'* **PhoneNumberNotfound**: No attribute information can be found for the specified phone number.'."\n" + .'* **isp.UNKNOWN**: An unknown exception occurred.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EncyrptTypeIllegal', + 'errorMessage' => 'The encryption type of the mobile phone number is illegal', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified mobile phone number is invalid.', + ], + [ + 'errorCode' => 'PhoneNumberNotfound', + 'errorMessage' => 'The queried number is not found.', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'The number and number type do not match.', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The authorization code application failed and cannot be used.', + ], + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD135850177\\",\\n \\"Data\\": {\\n \\"BasicCarrier\\": \\"中国移动\\",\\n \\"NumberSegment\\": 139,\\n \\"IsNumberPortability\\": false,\\n \\"Carrier\\": \\"中国移动\\",\\n \\"City\\": \\"杭州\\",\\n \\"Province\\": \\"浙江\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'DescribePhoneNumberOperatorAttribute', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154008~~) of Cell Phone Number Service.'."\n" + .'* By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](~~154006~~).'."\n" + .'* You can call this operation to obtain the carrier, registration location, and mobile number portability information about a phone number. You can query phone numbers in **plaintext** and phone numbers that are encrypted by using **MD5** and **SHA256**.'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n", + 'responseParamsDescription' => '### Causes of returning response codes and solutions'."\n" + ."\n" + .'|Response code|Cause|Solution|'."\n" + .'|---|---|---|'."\n" + .'|OK|The request parameters meet the requirements.|This indicates that the request is successful.|'."\n" + .'|InvalidParameter|The format of the specified phone number is invalid or the request parameter does not meet the requirements of the API operation.|Enter a correct phone number or modify the format of the request parameter, and then resubmit the request. For example, you can delete the invisible characters and white-space characters in the phone number, and change the characters to half-width characters.|'."\n" + .'|PhoneNumberNotfound|No attribute information can be found for the specified phone number.|Specify another phone number.|'."\n" + .'|isp.UNKNOWN|An unknown exception is returned.|Call the operation again. We recommend that you do not call the operation more than three times.|'."\n" + ."\n" + .'### Description of BasicCarrier and Carrier'."\n" + ."\n" + .'|Phone number segment|Mobile number portability|Returned value of BasicCarrier|Returned value of Carrier|'."\n" + .'|---|---|---|---|'."\n" + .'|Phone number segment managed by basic carriers|Yes|Basic carriers after mobile number portability, such as China Mobile, China Unicom, China Telecom, and China Broadnet|Basic carriers after mobile number portability, such as China Mobile, China Unicom, China Telecom, and China Broadnet|'."\n" + .'|Phone number segment managed by basic carriers|No|Basic carriers such as China Mobile, China Unicom, China Telecom, and China Broadnet|Basic carriers such as China Mobile, China Unicom, China Telecom, and China Broadnet|'."\n" + .'|Phone number segment managed by VNOs|Not supported|Basic carriers such as China Mobile, China Unicom, China Telecom, and China Broadnet|VNOs such as Alibaba Cloud Communications|', + ], + 'PhoneNumberStatusForPublic' => [ + 'summary' => 'Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '157166', + 'abilityTreeNodes' => [ + 'FEATUREdytnsPMQ25H', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Dd1r***4id', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, the value of this field is an 11-digit phone number.'."\n" + .'* If the value of Mask is MD5, the value of this field is a 32-bit encrypted string.'."\n" + .'* If the value of Mask is SHA256, the value of this field is a 64-bit encrypted string.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '139****1234', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The phone number is not encrypted.'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NORMAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-****-****-9DCE-B38165CE4C47', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The returned status for the queried phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The queried phone number can be reached.'."\n" + .'* **SHUTDOWN**: The queried phone number is suspended.'."\n" + .'* **POWER_OFF**: The phone is powered off.'."\n" + .'* **NOT_EXIST**: The queried phone number is a nonexistent number.'."\n" + .'* **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.'."\n" + .'* **BUSY**: The queried phone number is busy.'."\n" + .'* **UNKNOWN**: The queried phone number is unknown.'."\n" + ."\n" + .'> Due to system adjustment of the carrier, the BUSY and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Carrier' => [ + 'description' => 'The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **CMCC**: China Mobile'."\n" + .'* **CUCC**: China Unicom'."\n" + .'* **CTCC**: China Telecom'."\n" + ."\n" + .'> You are not allowed to query the phone numbers assigned by China Broadnet.'."\n", + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **OperatorLimit**: The carrier prohibits the query of the phone number.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n" + ."\n" + .'> For a list of error codes, see [Service error codes](https://next.api.aliyun.com/document/Dytnsapi/2020-02-17/errorCode).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'OperatorLimit', + 'errorMessage' => 'The number is limited by the operator', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC3BB6D2-****-****-9DCE-B38165CE4C47\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"Carrier\\": \\"CMCC\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'PhoneNumberStatusForPublic', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + .'* By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](~~154006~~).'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 300 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", + ], + 'PhoneNumberStatusForAccount' => [ + 'summary' => 'Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '142578', + 'abilityTreeNodes' => [ + 'FEATUREdytnsPMQ25H', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.'."\n" + .'* If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.'."\n" + .'* If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '139****1234', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The phone number is not encrypted.'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **OperatorLimit**: The carrier prohibits the query of the phone number.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The returned status for the queried phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The queried phone number is valid.'."\n" + .'* **SHUTDOWN**: The queried phone number is suspended.'."\n" + .'* **POWER_OFF**: The queried phone number cannot be connected.'."\n" + .'* **NOT_EXIST**: The queried phone number is a nonexistent number.'."\n" + .'* **DEFECT**: The queried phone number is invalid.'."\n" + .'* **UNKNOWN**: The queried phone number is unknown.'."\n" + ."\n" + .'> Due to system adjustment of the carrier, the BUSY and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Carrier' => [ + 'description' => 'The basic carrier who assings the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:'."\n" + ."\n" + .'* **CMCC**: China Mobile'."\n" + .'* **CUCC**: China Unicom'."\n" + .'* **CTCC**: China Telecom'."\n" + ."\n" + .'> You are not allowed to query the phone numbers assigned by China Broadnet.'."\n", + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'OperatorLimit', + 'errorMessage' => 'The number is limited by the operator.', + ], + ], + 400 => [ + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'CarrierIllegal', + 'errorMessage' => 'Illegal carrier type', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The label application form does not exist, please replace the authorization code.', + ], + [ + 'errorCode' => 'MobileNumberTypeIllegal', + 'errorMessage' => 'Invalid number type.', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'The number and number type do not match.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System error', + ], + [ + 'errorCode' => 'Unknown', + 'errorMessage' => 'Unknown error', + ], + [ + 'errorCode' => 'EncyrptTypeIllegal', + 'errorMessage' => 'The encryption type of the mobile phone number is illegal', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"Carrier\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'PhoneNumberStatusForAccount', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + .'* By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](~~154006~~).'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 300 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", + ], + 'PhoneNumberStatusForReal' => [ + 'summary' => 'Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '142581', + 'abilityTreeNodes' => [ + 'FEATUREdytnsPMQ25H', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, the value of this field is an 11-digit phone number.'."\n" + .'* If the value of Mask is MD5, the value of this field is a 32-bit encrypted string.'."\n" + .'* If the value of Mask is SHA256, the value of this field is a 64-bit encrypted string.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '189****8999', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The phone number is not encrypted.'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **OperatorLimit**: The carrier prohibits the query of the phone number.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The returned status for the queried phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The queried phone number can be reached.'."\n" + .'* **SHUTDOWN**: The queried phone number is suspended.'."\n" + .'* **POWER_OFF**: The phone is powered off.'."\n" + .'* **NOT_EXIST**: The queried phone number is a nonexistent number.'."\n" + .'* **BUSY**: The queried phone number is busy.'."\n" + .'* **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.'."\n" + .'* **DEFECT**: The queried phone number is invalid.'."\n" + .'* **UNKNOWN**: The queried phone number is unknown.'."\n" + ."\n" + .'> Due to system adjustment of the carrier, the BUSY and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Carrier' => [ + 'description' => 'The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:'."\n" + ."\n" + .'* **CMCC**: China Mobile'."\n" + .'* **CUCC**: China Unicom'."\n" + .'* **CTCC**: China Telecom'."\n" + ."\n" + .'> You are not allowed to query the phone numbers assigned by China Broadnet.'."\n", + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'OperatorLimit', + 'errorMessage' => 'The number is limited by the operator.', + ], + ], + 400 => [ + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'CarrierIllegal', + 'errorMessage' => 'Illegal carrier type', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The label application form does not exist, please replace the authorization code.', + ], + [ + 'errorCode' => 'MobileNumberTypeIllegal', + 'errorMessage' => 'Invalid number type.', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'The number and number type do not match.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System error', + ], + [ + 'errorCode' => 'Unknown', + 'errorMessage' => 'Unknown error', + ], + [ + 'errorCode' => 'EncyrptTypeIllegal', + 'errorMessage' => 'The encryption type of the mobile phone number is illegal', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"Carrier\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'PhoneNumberStatusForReal', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + .'* By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](~~154006~~).'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 300 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", + ], + 'PhoneNumberStatusForSms' => [ + 'summary' => 'Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'zf08***pi6', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.'."\n" + .'* If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.'."\n" + .'* If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '181****1234', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: plaintext'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **OperatorLimit**: The carrier prohibits the query of the phone number.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD135850177', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The returned status for the queried phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The queried phone number can be reached.'."\n" + .'* **SHUTDOWN**: The queried phone number is suspended.'."\n" + .'* **POWER_OFF**: The phone is powered off.'."\n" + .'* **NOT_EXIST**: The queried phone number is a nonexistent number.'."\n" + .'* **DEFECT**: The queried phone number is invalid.'."\n" + .'* **UNKNOWN**: The queried phone number is unknown.'."\n" + ."\n" + .'> Due to system adjustment of the carrier, the BUSY, SUSPECTED_POWER_OFF, and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Carrier' => [ + 'description' => 'The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:'."\n" + ."\n" + .'* **CMCC**: China Mobile'."\n" + .'* **CUCC**: China Unicom'."\n" + .'* **CTCC**: China Telecom'."\n" + ."\n" + .'> You are not allowed to query the phone numbers assigned by China Broadnet.'."\n", + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'OperatorLimit', + 'errorMessage' => 'The number is limited by the operator.', + ], + ], + 400 => [ + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'CarrierIllegal', + 'errorMessage' => 'Illegal carrier type', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The label application form does not exist, please replace the authorization code.', + ], + [ + 'errorCode' => 'MobileNumberTypeIllegal', + 'errorMessage' => 'Invalid number type.', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'The number and number type do not match.', + ], + [ + 'errorCode' => 'isp.UNKNOWN', + 'errorMessage' => 'An error occurred due to unknown reasons.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System error', + ], + [ + 'errorCode' => 'Unknown', + 'errorMessage' => 'Unknown error', + ], + [ + 'errorCode' => 'EncyrptTypeIllegal', + 'errorMessage' => 'The encryption type of the mobile phone number is illegal', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD135850177\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"Carrier\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'PhoneNumberStatusForSms', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + .'* By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](~~154006~~).'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 300 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", + ], + 'PhoneNumberStatusForVoice' => [ + 'summary' => 'Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '142576', + 'abilityTreeNodes' => [ + 'FEATUREdytnsPMQ25H', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.'."\n" + .'* If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.'."\n" + .'* If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '139****1234', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method. Valid values:'."\n" + ."\n" + .'* **NORMAL**: plaintext'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **OperatorLimit**: The carrier prohibits the query of the phone number.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The returned status for the queried phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The queried phone number can be reached.'."\n" + .'* **SHUTDOWN**: The queried phone number is suspended.'."\n" + .'* **POWER_OFF**: The phone is powered off.'."\n" + .'* **NOT_EXIST**: The queried phone number is a nonexistent number.'."\n" + .'* **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.'."\n" + .'* **DEFECT**: The queried phone number is invalid.'."\n" + .'* **UNKNOWN**: The queried phone number is unknown.'."\n" + ."\n" + .'> Due to system adjustment of the carrier, the BUSY, SUSPECTED_POWER_OFF, and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Carrier' => [ + 'description' => 'The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:'."\n" + ."\n" + .'* **CMCC**: China Mobile'."\n" + .'* **CUCC**: China Unicom'."\n" + .'* **CTCC**: China Telecom'."\n" + ."\n" + .'> You are not allowed to query the phone numbers assigned by China Broadnet.'."\n", + 'type' => 'string', + 'example' => 'CTCC', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'OperatorLimit', + 'errorMessage' => 'The number is limited by the operator.', + ], + ], + 400 => [ + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'CarrierIllegal', + 'errorMessage' => 'Illegal carrier type', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The label application form does not exist, please replace the authorization code.', + ], + [ + 'errorCode' => 'MobileNumberTypeIllegal', + 'errorMessage' => 'Invalid number type.', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'The number and number type do not match.', + ], + [ + 'errorCode' => 'EncryptTypeIllegal', + 'errorMessage' => 'Invalid encryption type.', + ], + [ + 'errorCode' => 'isp.UNKNOWN', + 'errorMessage' => 'An error occurred due to unknown reasons.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System error', + ], + [ + 'errorCode' => 'Unknown', + 'errorMessage' => 'Unknown error', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"Carrier\\": \\"CTCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'PhoneNumberStatusForVoice', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + .'* By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](~~154006~~).'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 300 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", + ], + 'DescribePhoneTwiceTelVerify' => [ + 'summary' => 'Verifies whether a phone number is a reassigned phone number by calling this operation.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '154743', + 'abilityTreeNodes' => [ + 'FEATUREdytnsHYEZ9Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.'."\n" + .'* If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.'."\n" + .'* If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '139*******', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The phone number is not encrypted.'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The registration time. Specify the time in the yyyy-MM-dd HH:mm:ss format. This time is the service registration time of the mobile phone user. If the service registration time is later than the time when the phone number is assigned by a carrier, it indicates that the phone number is not a reassigned number. Otherwise, the phone number is a reassigned number.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If a carrier allocates a single number multiple times, the system will determine whether the phone number is a reassigned number based on the time when the carrier last allocated the phone number.'."\n" + ."\n" + .'* The service registration time must be later than 00:00:00 on January 1, 1970.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2018-01-01 00:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot and locate issues.'."\n", + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD135850177', + ], + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **PortabilityNumberNotSupported**: The phone number that is involved in mobile number portability is not supported.'."\n" + .'* **RequestNumberNotSupported**: You are not allowed to query phone numbers assigned by China Broadnet (that is, phone numbers start with 192) and phone numbers assigned by virtual network operators (VNOs).'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n" + ."\n" + .'> You are charged for phone number verifications if the value of Code is OK and the value of VerifyResult is not 0. For more information, see [Pricing](~~154751~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'VerifyResult' => [ + 'description' => 'The result of the request. Valid values:'."\n" + ."\n" + .'* **0**: It is unable to judge whether the phone number is a reassigned number.'."\n" + .'* **1**: The phone number is a reassigned number.'."\n" + .'* **2**: The phone number is not a reassigned number.'."\n" + .'* **3**: The phone number has been canceled.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Carrier' => [ + 'description' => 'The carrier. Valid values:'."\n" + ."\n" + .'* **CMCC**: China Mobile'."\n" + .'* **CUCC**: China Unicom'."\n" + .'* **CTCC**: China Telecom'."\n" + ."\n" + .'> The returned result indicates the carrier who assigns the phone number. If the phone number involves mobile number portability, the carrier after mobile number portability is returned.'."\n", + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'PortabilityNumberNotSupported', + 'errorMessage' => '不支持2021年6月前携号转网的号码查询', + ], + [ + 'errorCode' => 'RequestNumberNotSupported', + 'errorMessage' => '不支持中国广电号码（192开头）和虚拟运营商号码的查询', + ], + [ + 'errorCode' => 'RequestFrequencyLimit', + 'errorMessage' => '因运营商限制，禁止在短时间内高频对同一个号码进行反复查询', + ], + ], + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'Phone number and encryption type do not match', + ], + [ + 'errorCode' => 'InputParamIllegal', + 'errorMessage' => 'Wrong format of input parameter', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + [ + 'errorCode' => 'ThresholdIllegal', + 'errorMessage' => 'Please fill in the threshold range from 0 to 100 correctly.', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The label application form does not exist, please replace the authorization code.', + ], + [ + 'errorCode' => 'MobileNumberTypeIllegal', + 'errorMessage' => 'Invalid number type.', + ], + [ + 'errorCode' => 'TagNotExist', + 'errorMessage' => 'The label does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Unknown', + 'errorMessage' => 'Unknown error', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System error', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD135850177\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"VerifyResult\\": \\"1\\",\\n \\"Carrier\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribePhoneTwiceTelVerify', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + .'* You are charged for phone number verifications only if the value of Code is OK and the value of VerifyResult is not 0.'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + ."\n" + .'## [](#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" + ."\n" + .'## [](#)Authorization information'."\n" + ."\n" + .'By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](~~154006~~).'."\n", + 'responseParamsDescription' => '### Causes of returning response codes and solutions'."\n" + ."\n" + .'|HTTP status code|Response code|Cause|Solution|'."\n" + .'|---|---|---|---|'."\n" + .'|200|OK|The request parameters meet the requirements.|This indicates that the request is successful.|'."\n" + .'|200|PortabilityNumberNotSupported|This error code is returned for some phone numbers that involve mobile number portability.|We recommend that you query another phone number. A phone number that involves mobile number portability has been canceled in the system of the original carrier, and the new carrier considers that the time of performing mobile number portability is the time of activating the phone number. Therefore, the system cannot query the actual details of the phone number that involves mobile number portability.|'."\n" + ."\n" + .'### Exception causes and solutions'."\n" + ."\n" + .'|HTTP status code|Response code|Cause|Solution|'."\n" + .'|---|---|---|---|'."\n" + .'|400|AuthCodeNotExist|The authorization code does not exist.|On the Labels page, apply for the required labels first. After your application is approved and you obtain an authorization code, call this operation again.|'."\n" + .'|400|MobileNumberIllegal|The format of the specified phone number is invalid.|If the phone number is not encrypted, enter a valid 11-digit phone number. If the phone number is MD5-encrypted, enter a 32-bit encrypted string. If the phone number is SHA256-encrypted, enter a 64-bit encrypted string.|'."\n" + .'|400|MobileNumberTypeIllegal|The encryption method or encryption type is not supported.|The encryption method can be only NORMAL, MD5, or SHA256, and the value of Mask must be uppercase characters.|'."\n" + .'|500|Unknown|An unknown exception is returned.|Call this operation again. We recommend that you do not call this operation more than three times.|'."\n" + .'|500|SystemError|A system error occurred.|Call this operation again. We recommend that you do not call this operation more than three times.|', + ], + 'DescribePhoneNumberOnlineTime' => [ + 'summary' => 'Queries the usage period of a phone number of a user.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'QASDW@#**', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.'."\n" + .'* If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.'."\n" + .'* If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The phone number is not encrypted.'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'Carrier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The carrier. Valid values:'."\n" + ."\n" + .'* **MOBILE**: China Mobile'."\n" + .'* **UNICOM**: China Unicom'."\n" + .'* **TELECOM**: China Telecom'."\n" + ."\n" + .'> Alibaba Cloud automatically determines the carrier based on the carrier who assigns the phone number. Therefore, the value of this field does not affect the query result.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'UNICOM', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **PortabilityNumberNotSupported**: The phone number that is involved in mobile number portability is not supported.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n" + ."\n" + .'> You are charged if the value of Code is OK and the value of VerifyResult is not -1. For more information, see [Pricing](~~154751~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'VerifyResult' => [ + 'description' => 'The enumerated value of the usage period of a phone number. Valid values:'."\n" + ."\n" + .'* **-1**: No usage period information is available for the phone number.'."\n" + .'* **0**: The phone number status is abnormal. For example, the phone number is a nonexistent number.'."\n" + .'* **1** :\\[0-3) months.'."\n" + .'* **2** :\\[3-6] months.'."\n" + .'* **3** :(6-12] months.'."\n" + .'* **4** :(12-24] months.'."\n" + .'* **5** :(24,+) months.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'CarrierCode' => [ + 'description' => 'The carrier code. Valid values:'."\n" + ."\n" + .'* **CMCC**: China Mobile'."\n" + .'* **CUCC**: China Unicom'."\n" + .'* **CTCC**: China Telecom'."\n" + .'* **CBN**: China Broadnet'."\n", + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'PortabilityNumberNotSupported', + 'errorMessage' => 'Number portability is not supported', + ], + ], + 400 => [ + [ + 'errorCode' => 'Insufficient.Balance', + 'errorMessage' => 'You have an insufficient balance.', + ], + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'Authorization code does not exist', + ], + [ + 'errorCode' => 'CarrierIllegal', + 'errorMessage' => 'Illegal carrier type', + ], + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'Phone number and encryption type do not match', + ], + [ + 'errorCode' => 'MobileNumberTypeIllegal', + 'errorMessage' => 'Invalid number type.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System error', + ], + [ + 'errorCode' => 'Unknown', + 'errorMessage' => 'Unknown error', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"VerifyResult\\": \\"1\\",\\n \\"CarrierCode\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribePhoneNumberOnlineTime', + 'description' => '* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + .'* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 200 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", + 'responseParamsDescription' => '### Causes of returning response codes and solutions'."\n" + ."\n" + .'|HTTP status code|Response code|Cause|Solution|'."\n" + .'|---|---|---|---|'."\n" + .'|200|OK|The request parameters meet the requirements.|This indicates that the request is successful.|'."\n" + .'|200|PortabilityNumberNotSupported|This error code is returned for a few of phone numbers that involve mobile number portability.|We recommend that you query another phone number. A phone number that involves mobile number portability has been canceled in the system of the original carrier, and the new carrier considers that the time of performing mobile number portability is the time of activating the phone number. Therefore, the system cannot query the actual details of the phone number that involves mobile number portability.|'."\n" + ."\n" + .'### Exception causes and solutions'."\n" + ."\n" + .'|HTTP status code|Response code|Cause|Solution|'."\n" + .'|---|---|---|---|'."\n" + .'|400|AuthCodeNotExist|The authorization code does not exist.|On the Labels page, apply for the required labels first. After your application is approved and you obtain an authorization code, call this operation again.|'."\n" + .'|400|CarrierIllegal|The carrier type is invalid.|Enter a valid carrier type. For encrypted phone numbers, you must specify Carrier and its value must be uppercase letters.|'."\n" + .'|400|MobileNumberIllegal|The format of the specified phone number is invalid.|If the phone number is not encrypted, enter a valid 11-digit phone number. If the phone number is MD5-encrypted, enter a 32-bit encrypted string. If the phone number is SHA256-encrypted, enter a 64-bit encrypted string.|'."\n" + .'|400|MobileNumberTypeNotMatch|The specified phone number does not match the encryption type.|Enter a valid phone number and a correct number encryption type.|'."\n" + .'|400|MobileNumberTypeIllegal|The encryption method or encryption type is not supported.|The encryption method can be only NORMAL, MD5, or SHA256, and the value of Mask must be uppercase characters.|'."\n" + .'|500|Unknown|An unknown exception is returned.|Call this operation again. We recommend that you do not call this operation more than three times.|'."\n" + .'|500|SystemError|A system error occurred.|Call this operation again. We recommend that you do not call this operation more than three times.|', + ], + 'DescribePhoneNumberAnalysisAI' => [ + 'summary' => 'Obtains the analysis results of a phone number.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '187****5620', + ], + ], + [ + 'name' => 'Rate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The score threshold for the phone number. Valid values: **0 to 100**.'."\n" + ."\n" + .'> The system provided by Alibaba Cloud determines whether to accept the specified score threshold. When the system does not accept the specified score threshold, the value of this field is invalid.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '96', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the ****[**Labels**](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click Activate Now, enter the required information, and then submit your application. After your application is approved, you can obtain an authorization code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'HwD***nG', + ], + ], + [ + 'name' => 'ModelConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The model parameter configuration. This field is required by some labels.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"trainingJobId": "17**********48"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD******177', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Number' => [ + 'description' => 'The specified phone number.'."\n", + 'type' => 'string', + 'example' => '187****5620', + ], + 'Code' => [ + 'description' => 'The returned code.'."\n" + ."\n" + .'* YES: The specified phone number is valid.'."\n" + .'* NO: The specified phone number is invalid.'."\n" + .'* UNKNOWN: The specified phone number is unknown'."\n", + 'type' => 'string', + 'example' => 'YES', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* OK: The request is successful.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD******177\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Number\\": \\"187****5620\\",\\n \\"Code\\": \\"YES\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'DescribePhoneNumberAnalysisAI', + 'description' => 'Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the Labels page, find the label that you want to use, click Activate Now, enter the required information, and then submit your application. After your application is approved, you can use the label. Before you call this operation, make sure that you are familiar with the billing of Cell Phone Number Service.'."\n", + ], + 'DescribePhoneNumberAnalysis' => [ + 'summary' => 'Obtains the analysis results of a number.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'QASDW@#**', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1310000****', + ], + ], + [ + 'name' => 'NumberType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'MD5', + ], + ], + [ + 'name' => 'Rate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'name' => 'Code', + 'description' => '', + 'type' => 'string', + 'example' => 'YES', + 'backendName' => 'code', + ], + 'Number' => [ + 'name' => 'Number', + 'description' => '', + 'type' => 'string', + 'example' => '1310000****', + 'backendName' => 'number', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'properties' => [ + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Number' => [ + 'type' => 'string', + 'example' => '18752785620', + ], + 'Code' => [ + 'type' => 'string', + 'example' => 'NO', + ], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'EncyrptTypeIllegal', + 'errorMessage' => 'The encryption type of the mobile phone number is illegal', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'Phone number and encryption type do not match', + ], + [ + 'errorCode' => 'CarrierIllegal', + 'errorMessage' => 'Illegal carrier type', + ], + [ + 'errorCode' => 'RateIllegal', + 'errorMessage' => 'Illegal threshold parameter', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'invalid parameter', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The authorization code application failed and cannot be used.', + ], + [ + 'errorCode' => 'TagNotExist', + 'errorMessage' => 'The label does not exist.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Permission.NotAuthorized', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Number\\": \\"187****5620\\",\\n \\"Code\\": \\"NO\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribePhoneNumberAnalysisResponse>\\n <RequestId>CC3BB6D2-2FDF-4321-9DCE-B38165CE****</RequestId>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>\\n <Code>YES</Code>\\n <Number>1310000****</Number>\\n </Data>\\n</DescribePhoneNumberAnalysisResponse>","errorExample":""}]', + 'title' => 'DescribePhoneNumberAnalysis', + ], + 'DescribeEmptyNumber' => [ + 'summary' => 'Predicts whether a phone number is a nonexistent number by using AI algorithms.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '162520', + 'abilityTreeNodes' => [ + 'FEATUREdytnsPMQ25H', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Dd1r***4id'."\n", + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'> You can query only one phone number a time.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '189****1234', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The phone number is not encrypted.'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The unique request ID. It is a common parameter and can be used to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The returned status for the queried phone number. Valid values:'."\n" + ."\n" + .'* **EMPTY**: The queried phone number is a nonexistent number.'."\n" + .'* **NORMAL**: The queried phone number is valid.'."\n" + .'* **SUSPECT_EMPTY**: The queried phone number is suspected to be a nonexistent number.'."\n" + .'* **UNKNOWN**: The queried phone number is unknown.'."\n", + 'type' => 'string', + 'example' => 'EMPTY', + ], + 'Number' => [ + 'description' => 'The specified phone number.'."\n", + 'type' => 'string', + 'example' => '189****1234', + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **InvalidPhoneNumber.Check**: The phone number is invalid.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Status\\": \\"EMPTY\\",\\n \\"Number\\": \\"189****1234\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'DescribeEmptyNumber', + 'description' => '* You can call this operation to verify whether a phone number is a nonexistent number. When you call this operation to verify a number, the system charges you CNY 0.01 per verification based on the number of verifications. **Before you call this operation, make sure that you are familiar with the billing of Cell Phone Number Service.**'."\n" + .'* You are charged only if the value of Code is OK and the value of Status is not UNKNOWN.'."\n" + .'* The prediction is not strictly accurate because Cell Phone Number Service predicts the nonexistent number probability by using AI algorithms. The accuracy rate of the prediction and the recall rate of empty numbers are about 95%. **Pay attention to this point when you call this operation**.'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + ."\n" + .'### [](#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" + ."\n" + .'### [](#)Authorization information'."\n" + ."\n" + .'By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](~~154006~~).'."\n", + ], + 'TwoElementsVerification' => [ + 'summary' => 'Verifies whether the name and phone number entered by a user belong to the same user.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '136682', + 'abilityTreeNodes' => [ + 'FEATUREdytnsNQKUF2', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'QASDW@#**', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be verified.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify a value in plaintext for this field.'."\n" + .'* If the value of Mask is MD5, specify a MD5-encrypted value for this field.'."\n" + .'* If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method. Valid values:'."\n" + ."\n" + .'* **NORMAL**: plaintext'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MD5', + 'enum' => [], + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name to be verified.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify a value in plaintext for this field.'."\n" + .'* If the value of Mask is MD5, specify a MD5-encrypted value for this field.'."\n" + .'* If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* For more information, see Error codes in this documentation.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number or name at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE****', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsConsistent' => [ + 'description' => 'Indicates whether the specified name and phone number belong to the same user. Valid values:'."\n" + ."\n" + .'* **1**: The specified name and phone number belong to the same user.'."\n" + ."\n" + .'* **0**: The specified name and phone number do not belong to the same user.'."\n" + ."\n" + .'* **2**: The specified name and phone number cannot be found.'."\n" + ."\n" + .'The phone number registration data of a user is usually updated one or three days after registration. The registration data can be queried only after the update. The following table shows the verification results under different phone number states.'."\n" + ."\n" + .'|Carrier/Phone number state|Out-of-service|Nonexistent|Canceled|'."\n" + .'|---|---|---|---|'."\n" + .'|China Mobile|Verifications can be carried out normally.|The specified name and phone number cannot be found.|The specified name and phone number cannot be found.|'."\n" + .'|China Unicom|Verifications can be carried out normally.|The specified name and phone number do not belong to the same user.|The specified name and phone number do not belong to the same user.|'."\n" + .'|China Telecom|Verifications can be carried out normally.|The specified name and phone number cannot be found.|The specified name and phone number cannot be found.|', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BasicCarrier' => [ + 'description' => 'The basic carriers. Valid values:'."\n" + ."\n" + .'* **China Mobile**'."\n" + .'* **China Unicom**'."\n" + .'* **China Telecom**'."\n" + ."\n" + .'> You are not allowed to verify numbers assigned by China Broadnet.'."\n", + 'type' => 'string', + 'example' => 'China Mobile', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'OperatorLimit', + 'errorMessage' => 'The number is limited by the operator.', + ], + ], + 400 => [ + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'EncyrptTypeIllegal', + 'errorMessage' => 'The encryption type of the mobile phone number is illegal', + ], + [ + 'errorCode' => 'CarrierIllegal', + 'errorMessage' => 'Illegal carrier type', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The label application form does not exist, please replace the authorization code.', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'The number and number type do not match.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Unknown', + 'errorMessage' => 'Unknown error', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System error', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE****\\",\\n \\"Data\\": {\\n \\"IsConsistent\\": 1,\\n \\"BasicCarrier\\": \\"中国移动\\"\\n }\\n}","type":"json"}]', + 'title' => 'TwoElementsVerification', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + .'* You are charged only if the value of Code is OK and the value of IsConsistent is not 2.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 200 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", + ], + 'ThreeElementsVerification' => [ + 'summary' => 'Verifies whether the name, phone number, and ID card number entered by a user belong to the same user.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '136769', + 'abilityTreeNodes' => [ + 'FEATUREdytns9WIVIU', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'QASDW@#**', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be verified.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify a value in plaintext for this field.'."\n" + .'* If the value of Mask is MD5, specify a MD5-encrypted value for this field.'."\n" + .'* If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The phone number is not encrypted.'."\n" + .'* **MD5**'."\n" + .'* **SHA256**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MD5', + 'enum' => [], + ], + ], + [ + 'name' => 'CertCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID card number to be verified.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify a value in plaintext for this field.'."\n" + .'* If the value of Mask is MD5, specify a MD5-encrypted value for this field.'."\n" + .'* If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '83d8040d3cb2181e04****dc6ff5566d4493876a4a5da782887446356b0a787e', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name to be verified.'."\n" + ."\n" + .'* If the value of Mask is NORMAL, specify a value in plaintext for this field.'."\n" + .'* If the value of Mask is MD5, specify a MD5-encrypted value for this field.'."\n" + .'* If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.'."\n" + ."\n" + .'> Letters in the encrypted strings are not case-sensitive.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* For more information, see Error codes in this documentation.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'BasicCarrier' => [ + 'description' => 'The basic carrier. Valid values:'."\n" + ."\n" + .'* **China Mobile**'."\n" + .'* **China Unicom**'."\n" + .'* **China Telecom**'."\n", + 'type' => 'string', + 'example' => 'China Mobile', + ], + 'IsConsistent' => [ + 'description' => 'Indicates whether the specified name, phone number, and ID card number belong to the same user. Valid values:'."\n" + ."\n" + .'* **1**: The specified name, phone number, and ID card number belong to the same user.'."\n" + .'* **0**: The specified name, phone number, and ID card number do not belong to the same user.'."\n" + .'* **2**: The specified name, phone number, and ID card number cannot be found.'."\n" + ."\n" + .'**Note** The phone number registration data of a user is usually updated one or three days after registration. The registration data can be queried only after the update. The following table shows the verification results under different phone number states.'."\n" + ."\n" + .'|Carrier/Phone number state|Out-of-service|Nonexistent|Canceled|'."\n" + .'|---|---|---|---|'."\n" + .'|China Mobile|Verifications can be carried out normally.|The specified name, phone number, and ID card number cannot be found.|The specified name, phone number, and ID card number cannot be found.|'."\n" + .'|China Unicom|Verifications can be carried out normally.|The specified name, phone number, and ID card number do not belong to the same user.|The specified name, phone number, and ID card number do not belong to the same user.|'."\n" + .'|China Telecom|Verifications can be carried out normally.|The specified name, phone number, and ID card number cannot be found.|The specified name, phone number, and ID card number cannot be found.|', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'OperatorLimit', + 'errorMessage' => 'The number is limited by the operator.', + ], + ], + 400 => [ + [ + 'errorCode' => 'MobileNumberIllegal', + 'errorMessage' => 'Wrong format of phone number', + ], + [ + 'errorCode' => 'EncyrptTypeIllegal', + 'errorMessage' => 'The encryption type of the mobile phone number is illegal', + ], + [ + 'errorCode' => 'CarrierIllegal', + 'errorMessage' => 'Illegal carrier type', + ], + [ + 'errorCode' => 'CertCodeIllegal', + 'errorMessage' => 'Invalid CertCode value.', + ], + [ + 'errorCode' => 'MobileNumberTypeNotMatch', + 'errorMessage' => 'The number and number type do not match.', + ], + [ + 'errorCode' => 'AuthCodeNotExist', + 'errorMessage' => 'The label application form does not exist, please replace the authorization code.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Unknown', + 'errorMessage' => 'Unknown error', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System error', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Data\\": {\\n \\"BasicCarrier\\": \\"中国移动\\",\\n \\"IsConsistent\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ThreeElementsVerification', + 'description' => '* Before you call this operation, make sure that you are familiar with the [billing](~~154751~~) of Cell Phone Number Service.'."\n" + .'* Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\n" + .'* You are charged only if the value of Code is OK and the value of IsConsistent is not 2.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 200 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", + ], + 'PhoneNumberEncrypt' => [ + 'summary' => 'Encrypts the original phone number into a virtual number that starts with 140. Cell Phone Number Service integrates the communications services provided by Alibaba Cloud. This allows you to initiate a call by using a virtual number that starts with 140.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '133477', + 'abilityTreeNodes' => [ + 'FEATUREdytns6A4MC8', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'QASDW@#**', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n" + ."\n" + .'> You can query only one phone number at a time.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number. Set the value to **NORMAL**.'."\n" + ."\n" + .'> Only the NORMAL encryption method is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'Details about the returned entries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OriginalNumber' => [ + 'description' => 'The original phone number.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'EncryptedNumber' => [ + 'description' => 'The encrypted phone number.'."\n", + 'type' => 'string', + 'example' => '1400513****', + ], + 'ExpireTime' => [ + 'description' => 'The time when the phone number expires.'."\n", + 'type' => 'string', + 'example' => '2022-05-27 16:05:23', + ], + 'OutId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Permission.NotAuthorized', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"OriginalNumber\\": \\"1390000****\\",\\n \\"EncryptedNumber\\": \\"1400513****\\",\\n \\"ExpireTime\\": \\"2022-05-27 16:05:23\\",\\n \\"OutId\\": \\"215044c917374256269257695e9d22\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'PhoneNumberEncrypt', + 'description' => 'Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\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", + ], + 'InvalidPhoneNumberFilter' => [ + 'summary' => 'Filters invalid phone numbers.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '132665', + 'abilityTreeNodes' => [ + 'FEATUREdytnsPMQ25H', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n" + ."\n" + .'> On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'QASDW@#**', + ], + ], + [ + 'name' => 'InputNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be queried.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'Mask', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption method of the phone number.'."\n" + ."\n" + .'> Only the NORMAL encryption method is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NORMAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **MobileNumberIllegal**: The phone number is invalid.'."\n" + .'* **EncyrptTypeIllegal**: The encryption type is invalid.'."\n" + .'* **MobileNumberTypeNotMatch**: The phone number does not match the encryption type.'."\n" + .'* **CarrierIllegal**: The carrier type is invalid.'."\n" + .'* **AuthCodeNotExist**: The authorization code does not exist.'."\n" + .'* **PortabilityNumberNotSupported**: Mobile number portability is not supported.'."\n" + .'* **Unknown**: An unknown exception occurred.'."\n" + .'* **AuthCodeAndApiNotMatch**: A system exception occurred.'."\n" + .'* **AuthCodeAndApiNotMatch**: The authorization code does not match the API operation.'."\n" + .'* **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'Details about the returned entries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The returned filter results.'."\n" + ."\n" + .'* **YES**: the valid phone number. The mappings are returned.'."\n" + .'* **NO**: the invalid phone number. No mappings are returned.'."\n", + 'type' => 'string', + 'example' => 'YES', + ], + 'OriginalNumber' => [ + 'description' => 'The original phone number.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'EncryptedNumber' => [ + 'description' => 'The encrypted phone number.'."\n", + 'type' => 'string', + 'example' => '1400513****', + ], + 'ExpireTime' => [ + 'description' => 'The time when the phone number expires.'."\n", + 'type' => 'string', + 'example' => '2022-05-27 16:05:23', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Permission.NotAuthorized', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"YES\\",\\n \\"OriginalNumber\\": \\"1390000****\\",\\n \\"EncryptedNumber\\": \\"1400513****\\",\\n \\"ExpireTime\\": \\"2022-05-27 16:05:23\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'InvalidPhoneNumberFilter', + 'description' => 'Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.'."\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", + ], + 'QueryTagListPage' => [ + 'summary' => 'Queries a list of tags by page.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '18', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '66', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A4475657-BB7E-585D-9E09-37934F096103', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '', + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'TotalPage' => [ + 'title' => '', + 'description' => 'The total number of returned pages.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '91', + ], + 'PageSize' => [ + 'title' => '', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'PageNo' => [ + 'title' => '', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'Records' => [ + 'title' => '', + 'description' => 'The retruned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'title' => '场景id', + 'description' => 'The scene ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13', + ], + 'SceneName' => [ + 'title' => '场景名称', + 'description' => 'The scene name.'."\n", + 'type' => 'string', + 'example' => 'check', + ], + 'IndustryId' => [ + 'title' => '行业id', + 'description' => 'The industry ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Introduction' => [ + 'title' => '标签介绍', + 'description' => 'The tag description.'."\n", + 'type' => 'string', + 'example' => 'for autotest new', + ], + 'SaleStatusStr' => [ + 'title' => '0 隐藏 1 公开', + 'description' => '* 0: The number is hidden.'."\n" + .'* 1: The number is public.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ApiName' => [ + 'title' => '前端调用的api名称', + 'description' => 'The API operation that is called by the frontend.'."\n", + 'type' => 'string', + 'example' => 'TwoElementsVerification', + ], + 'Id' => [ + 'title' => '标签 id', + 'description' => 'The tag ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '75', + ], + 'IndustryName' => [ + 'title' => '行业名称', + 'description' => 'The industry name.'."\n", + 'type' => 'string', + 'example' => 'Test', + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'Code'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'DocAddress' => [ + 'title' => 'API文档链接', + 'description' => 'The URL for the API documentation.'."\n", + 'type' => 'string', + 'example' => 'https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.388997.0.0.cf804cc7DX4vlP', + ], + 'Name' => [ + 'title' => '标签名称', + 'description' => 'The tag name.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'IsOpen' => [ + 'title' => '是否已经申请开通', + 'description' => 'Indicates whether the number is activated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The response code. **OK** indicates that the request is successful.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4475657-BB7E-585D-9E09-37934F096103\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 32,\\n \\"TotalPage\\": 91,\\n \\"PageSize\\": 24,\\n \\"PageNo\\": 11,\\n \\"Records\\": [\\n {\\n \\"SceneId\\": 13,\\n \\"SceneName\\": \\"查询\\",\\n \\"IndustryId\\": 2,\\n \\"Introduction\\": \\"这个标签是查询号码状态的。\\",\\n \\"SaleStatusStr\\": \\"1\\",\\n \\"ApiName\\": \\"TwoElementsVerification\\",\\n \\"Id\\": 75,\\n \\"IndustryName\\": \\"测试\\",\\n \\"Code\\": \\"OK\\",\\n \\"DocAddress\\": \\"https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.388997.0.0.cf804cc7DX4vlP\\",\\n \\"Name\\": \\"阿里云\\",\\n \\"IsOpen\\": 0\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryTagListPage', + ], + 'QueryTagInfoBySelection' => [ + 'summary' => 'Queries information about tags.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IndustryId', + 'in' => 'query', + 'schema' => [ + 'title' => '行业id', + 'description' => 'The industry ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '58', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '场景id', + 'description' => 'The scene ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '83', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'title' => '标签id', + 'description' => 'The tag ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '71', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1C3B8084-3A7D-570B-BC84-BF945A9CF65E', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'title' => '场景id', + 'description' => 'The scene ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41', + ], + 'IndustryId' => [ + 'title' => '行业id', + 'description' => 'The industry ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '83', + ], + 'SceneName' => [ + 'title' => '场景名称', + 'description' => 'The scene name.'."\n", + 'type' => 'string', + 'example' => 'General scenario', + ], + 'TagName' => [ + 'title' => '标签名称', + 'description' => 'The tag name.'."\n", + 'type' => 'string', + 'example' => 'Number ownership', + ], + 'FlowName' => [ + 'title' => '流程名称', + 'description' => 'The flow name.'."\n", + 'type' => 'string', + 'example' => 'process name', + ], + 'EnumDefinitionAddress' => [ + 'title' => '枚举值定义链接', + 'description' => 'The URL for the definitions of the enumerated values.'."\n", + 'type' => 'string', + 'example' => 'example.aliyundoc.com'."\n", + ], + 'TagId' => [ + 'title' => '标签id', + 'description' => 'The tag ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '31', + ], + 'AuthCodeList' => [ + 'title' => '可用的授权码列表', + 'description' => 'The list of available authorization codes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'None'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'example' => '', + ], + 'IndustryName' => [ + 'title' => '行业名称', + 'description' => 'The industry name.'."\n", + 'type' => 'string', + 'example' => 'logistics', + ], + 'DocAddress' => [ + 'title' => 'API文档链接', + 'description' => 'The URL for the API documentation.'."\n", + 'type' => 'string', + 'example' => 'https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.2573870.0.0.3aa921cbOrtqJz', + ], + 'DemoAddress' => [ + 'title' => 'API demo链接', + 'description' => 'The URL for the API demo.'."\n", + 'type' => 'string', + 'example' => 'https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.2573870.0.0.3aa921cbOrtqJz', + ], + 'ParamList' => [ + 'title' => '标签参数列表', + 'description' => 'The list of tag parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ValueDict' => [ + 'title' => '枚举值定义，code:desc', + 'description' => 'The definitions of the enumerated values such as Code or Desc.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Desc' => [ + 'title' => '中文名', + 'description' => 'The Chinese name.'."\n", + 'type' => 'string', + 'example' => '阿里云', + ], + 'Code' => [ + 'title' => '英文名', + 'description' => 'The English name.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + ], + ], + 'example' => '', + ], + 'Type' => [ + 'title' => '类型EnumUIWidgetTypes对应的code', + 'description' => 'The type. The code that corresponds to EnumUIWidgetTypes.'."\n", + 'type' => 'string', + 'example' => 'aqzx', + ], + 'Hint' => [ + 'title' => '输入提示', + 'description' => 'The input hint.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'Code' => [ + 'title' => '参数英文名', + 'description' => 'The English name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'preame', + ], + 'Must' => [ + 'title' => '是否必填', + 'description' => 'Indicates whether the parameter is required.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Name' => [ + 'title' => '参数中文名', + 'description' => 'The Chinese name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + ], + ], + 'example' => '', + ], + 'RichTextDescription' => [ + 'type' => 'string', + ], + 'ComplexityType' => [ + 'type' => 'string', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The response code. **OK** indicates that the request is successful.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C3B8084-3A7D-570B-BC84-BF945A9CF65E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"SceneId\\": 41,\\n \\"IndustryId\\": 83,\\n \\"SceneName\\": \\"通用\\",\\n \\"TagName\\": \\"号码归属\\",\\n \\"FlowName\\": \\"查询\\",\\n \\"EnumDefinitionAddress\\": \\"example.aliyundoc.com\\\\n\\",\\n \\"TagId\\": 31,\\n \\"AuthCodeList\\": [\\n \\"无\\"\\n ],\\n \\"IndustryName\\": \\"物流\\",\\n \\"DocAddress\\": \\"https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.2573870.0.0.3aa921cbOrtqJz\\",\\n \\"DemoAddress\\": \\"https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.2573870.0.0.3aa921cbOrtqJz\\",\\n \\"ParamList\\": [\\n {\\n \\"ValueDict\\": [\\n {\\n \\"Desc\\": \\"阿里云\\",\\n \\"Code\\": \\"Aliyun\\"\\n }\\n ],\\n \\"Type\\": \\"aqzx\\",\\n \\"Hint\\": \\"无\\",\\n \\"Code\\": \\"preame\\",\\n \\"Must\\": false,\\n \\"Name\\": \\"无\\"\\n }\\n ],\\n \\"RichTextDescription\\": \\"无\\",\\n \\"ComplexityType\\": \\"SINGLE_STAGE\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryTagInfoBySelection', + ], + 'QueryUsageStatisticsByTagId' => [ + 'summary' => 'Queries the usage statistics based on tag IDs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20230308', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20230406', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The tag ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D45CC751-34DF-5797-81FB-9A2ED6DC024B', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AuthorizationCode' => [ + 'title' => '授权码', + 'description' => 'The authorization code.'."\n", + 'type' => 'string', + 'example' => 'g61I8UV5zd', + ], + 'SuccessTotal' => [ + 'title' => '查询成功号码数', + 'description' => 'The numbers for which the query succeeded.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '93', + ], + 'FailTotal' => [ + 'title' => '查询失败号码数', + 'description' => 'The numbers for which the query failed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '71', + ], + 'TagName' => [ + 'title' => '标签名称', + 'description' => 'The tag name.'."\n", + 'type' => 'string', + 'example' => 'Alibaba Cloud Query', + ], + 'SceneName' => [ + 'title' => '场景名称', + 'description' => 'The scene name.'."\n", + 'type' => 'string', + 'example' => 'Return visit', + ], + 'Total' => [ + 'title' => '查询总号码数', + 'description' => 'The total quantity of numbers that are involved in the query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41', + ], + 'TagId' => [ + 'title' => '标签名称', + 'description' => 'The tag name.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '69', + ], + 'PartnerId' => [ + 'title' => '客户 pid', + 'description' => 'The customer product ID (PID).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89', + ], + 'Id' => [ + 'title' => '授权码使用记录 id', + 'description' => 'The ID of the authorization code usage record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17', + ], + 'GmtDateStr' => [ + 'title' => '创建时间', + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '20230312', + ], + 'IndustryName' => [ + 'title' => '行业名称', + 'description' => 'The industry name.'."\n", + 'type' => 'string', + 'example' => 'Home security', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The response code. **OK** indicates that the request is successful.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => 'Indicates whether the call is successful.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D45CC751-34DF-5797-81FB-9A2ED6DC024B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"AuthorizationCode\\": \\"g61I8UV5zd\\",\\n \\"SuccessTotal\\": 93,\\n \\"FailTotal\\": 71,\\n \\"TagName\\": \\"阿里云查询\\",\\n \\"SceneName\\": \\"电话回访1\\",\\n \\"Total\\": 41,\\n \\"TagId\\": 69,\\n \\"PartnerId\\": 0,\\n \\"Id\\": 0,\\n \\"GmtDateStr\\": \\"20230312\\",\\n \\"IndustryName\\": \\"家政安保\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryUsageStatisticsByTagId', + ], + 'QueryTagApplyRule' => [ + 'summary' => 'Queries tag application rules.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'title' => '标签id', + 'description' => 'The tag ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '61', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC3BB6D2-****-****-9DCE-B38165CE4C47', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'NeedApplyMaterial' => [ + 'title' => '是否需要提供申请材料', + 'description' => 'Indicates whether application materials are required.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '46', + ], + 'EncryptedQuery' => [ + 'title' => '是否支持加密查询', + 'description' => 'indicates whether encrypted queries are supported.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + ], + 'SlaLink' => [ + 'title' => '服务协议链接', + 'description' => 'The URL for the service agreement.'."\n", + 'type' => 'string', + 'example' => 'example.aliyundoc.com', + ], + 'ApplyMaterialDesc' => [ + 'title' => '申请材料要求', + 'description' => 'The requirements for application materials.'."\n", + 'type' => 'string', + 'example' => 'Requirements for application materials', + ], + 'AutoAudit' => [ + 'title' => '是否自动审批', + 'description' => 'Indicates whether the application is automatically approved.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'ChargingStandardLink' => [ + 'title' => '计费标准说明链接', + 'description' => 'The URL for the billing documentation.'."\n", + 'type' => 'string', + 'example' => 'aliyundoc.com', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The response code. **OK** indicates that the request is successful.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC3BB6D2-****-****-9DCE-B38165CE4C47\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"NeedApplyMaterial\\": 1,\\n \\"EncryptedQuery\\": 0,\\n \\"SlaLink\\": \\"example.aliyundoc.com\\",\\n \\"ApplyMaterialDesc\\": \\"申请材料的要求是XXX\\",\\n \\"AutoAudit\\": 1,\\n \\"ChargingStandardLink\\": \\"aliyundoc.com\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryTagApplyRule', + ], + 'QueryAvailableAuthCode' => [ + 'summary' => 'Queries available authorization codes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'title' => '标签id', + 'description' => 'The tag ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '22', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6ADDCD31-6BC7-5913-A47F-E29A07E37FEE', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'string', + 'example' => '[\'n81Q8M63rg\']', + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The response code. **OK** indicates that the request is successful.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6ADDCD31-6BC7-5913-A47F-E29A07E37FEE\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n \\"[\'n81Q8M63rg\']\\"\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryAvailableAuthCode', + ], + 'ListContacts' => [ + 'summary' => '预警联系人查询', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'dytns', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1298647', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ContactId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ContactName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ContactPhone' => [ + 'description' => '', + 'type' => 'string', + 'example' => '19211111111', + ], + 'ContactEmail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx @alibaba-inc.com', + ], + 'OpentAttributionWarning' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OpenStatusWarning' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Main' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PhoneStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MailStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"ContactId\\": 0,\\n \\"ContactName\\": \\"黄勇\\",\\n \\"ContactPhone\\": \\"19211111111\\",\\n \\"ContactEmail\\": \\"xxxx @alibaba-inc.com\\",\\n \\"OpentAttributionWarning\\": true,\\n \\"OpenStatusWarning\\": true,\\n \\"Main\\": 0,\\n \\"PhoneStatus\\": 1,\\n \\"MailStatus\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'SaveContacts' => [ + 'summary' => '预警联系人保存', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'maximum' => '99999', + 'minimum' => '1', + 'example' => 'dytns', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999', + 'minimum' => '1', + 'example' => '', + ], + ], + [ + 'name' => 'ContactEmail', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'ContactPhone', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '122354532434', + ], + ], + [ + 'name' => 'OpentAttributionWarning', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OpenStatusWarning', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MailStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PhoneStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '29E058D7-4B28-55EE-BE3B-61D5AE488A9E', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '0001', + 'errorMessage' => 'test', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29E058D7-4B28-55EE-BE3B-61D5AE488A9E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"1\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'UpdateContacts' => [ + 'summary' => '预警联系人更新', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '35630', + 'abilityTreeNodes' => [ + 'FEATUREdytnsVCETJO', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999', + 'minimum' => '1', + 'example' => '1194432', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'maximum' => '99999', + 'minimum' => '1', + 'example' => 'XXX', + ], + ], + [ + 'name' => 'ContactPhone', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192XXXXXXXX', + ], + ], + [ + 'name' => 'ContactEmail', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'OpentAttributionWarning', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OpenStatusWarning', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PhoneStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MailStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD******177', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD******177\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": false\\n}","type":"json"}]', + ], + 'DeleteContacts' => [ + 'summary' => '预警联系人删除', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '35631', + 'abilityTreeNodes' => [ + 'FEATUREdytnsVCETJO', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5454735262', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'QueryPackageTypeInfo' => [ + 'summary' => '套餐包类型信息查询', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductName', + 'in' => 'query', + 'schema' => [ + 'title' => '产品名称，如dysms', + 'description' => '产品名称，如dysms', + 'type' => 'string', + 'required' => false, + 'example' => 'dytns', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'A system error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Example\\",\\n \\"RequestId\\": \\"Example\\",\\n \\"Data\\": {\\n \\"efactorVerification\\": \\"平台风控-二要素核验查询套餐包\\"\\n },\\n \\"Code\\": \\"Example\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryPackageTypeInfo', + ], + 'QueryTaskList' => [ + 'summary' => '查询离线任务列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '15', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '91', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '[0]', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Result', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '[0]', + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD******177', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'example' => '', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '62', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'AuthCodeIllegal', + 'errorMessage' => 'Illegal authCode.', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request supplier timed out.', + ], + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD******177\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 22,\\n \\"Data\\": [\\n \\"{\\\\\\"createDate\\\\\\":\\\\\\"创建时间\\\\\\"}\\"\\n ],\\n \\"PageNo\\": 62\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/dytnsapi/2023-01-01/api-docs.php b/data/en_us/dytnsapi/2023-01-01/api-docs.php new file mode 100644 index 0000000..7ba079e --- /dev/null +++ b/data/en_us/dytnsapi/2023-01-01/api-docs.php @@ -0,0 +1,694 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dytnsapi', + 'version' => '2023-01-01', + ], + 'directories' => [ + 'GetPhoneNumberIdentificationUrl', + 'GetPhoneNumberIdentificationResult', + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeNumberMccMnc', + 'DescribeNumberHLR', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetPhoneNumberIdentificationUrl' => [ + 'summary' => 'Obtains the verification URL of your phone number.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '178936', + 'abilityTreeNodes' => [ + 'FEATUREdytnsFPPMA9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Ip', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The IP address of the subscriber\'s phone.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '114.124.***.13', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number of the subscriber. The phone number is in the Mobile Station International Subscriber Directory Number (MSISDN) format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '628211****113', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The external ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '149b03d2-a749-4e6e-8f5b-34******5815', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'K***9i7CIe', + ], + ], + [ + 'name' => 'RememberPhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remember the phone number.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD******177', + ], + 'Message' => [ + 'description' => 'The description of the return code.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'IdentificationUrl' => [ + 'description' => 'The verification URL.'."\n", + 'type' => 'string', + 'example' => 'https://global-ip-auth.dycpaas.com/global/biz/ip_auth/start?ipa_s_c_c=IPF0000000000000******&ipa_s_i=8636b75e2fcb40c53ffecc2b59******', + ], + 'SessionId' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'example' => '8636b75e2fcb40c53ffecc2b5947115c.149b03d2a7494e6e8f5b34c915245815.707c7f0d93f4409db0761aa5da94ce01.1686******041', + ], + ], + ], + 'Code' => [ + 'description' => 'The return code. Valid values:'."\n" + ."\n" + .'* **OK**: The request is successful.'."\n" + .'* **IdentificationNotAvailable**: The verification system does not support the phone number that corresponds to the IP address.'."\n" + .'* **MobileNumberIllegal**: The format of the phone number is invalid.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD******177\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"IdentificationUrl\\": \\"https://global-ip-auth.dycpaas.com/global/biz/ip_auth/start?ipa_s_c_c=IPF0000000000000******&ipa_s_i=8636b75e2fcb40c53ffecc2b59******\\",\\n \\"SessionId\\": \\"8636b75e2fcb40c53ffecc2b5947115c.149b03d2a7494e6e8f5b34c915245815.707c7f0d93f4409db0761aa5da94ce01.1686******041\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'GetPhoneNumberIdentificationUrl', + ], + 'GetPhoneNumberIdentificationResult' => [ + 'summary' => 'Obtains the verification result of your phone number.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '179163', + 'abilityTreeNodes' => [ + 'FEATUREdytnsFPPMA9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8636b75e2fcb40c53ffecc2b5947115c.149b03d2a7494e6e8f5b34c915245815.707c7f0d93f4409db0761aa5da94ce01.1686******041', + ], + ], + [ + 'name' => 'SessionPayload', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session payload.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'uQne0vsuNywXVvI4VP5taHsgDNsd3BwcbmrhjXi58WbxBGFW+e8ufMEi9j89YonphV6NZ1PIeKvboHtU1nsSjZMTcoFPfkjqaORIHdSlPb6vmIzqOnJMsP1KPQ8K1JLXSaAKsB2lQ5A9HCkX2HzDEwje14HYQsnPd/Ka2YWgXuL0N8GE9oYi25d4DdlU0XR52YjSj8GMLSgbW7yNxEPvUCOQG83FZfQqmIWG2+0C/fQ3gdG9WI7AeeHZo4IRKGtQnpjKGtZZl8VoLPNIswDqZeeyjCyZlKUXKrAt4Co9c4I4q8G1jZm53COQJ+DuTiWH7w+tois3WJwFV/HmdlAKt8SqpiVrEv47VQ9V+8FYsdKz3A3CRyBVgNj6wYKKbwaI9BdQoOkbYzzA8CfAKO5w1oYVD2nOcYS/AffbPbE31PJj7SdVvKghwPL56OVdjS9Hd0iW0SMBWD0F1iRNCUNHL3ffHcFjJLdhTrMt8VHSRn0nOlvO1ZaWqMQ0yE0q*************************kXTpoQLo0+0h+CEcf90hTg8XdMhj9B0A3SOINceLlmoZb3czvYl00+CC0075DjOX41YtnuAUfaNYPgLIZkjYyq+JopBQFAkxPUbJHC0oCzB9dQahUthWY38OPBs=', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The external ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '149b03d2-a749-4e6e-8f5b-34******5815', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'K***9i7CIe', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number of the subscriber. The phone number to be verified must be in the Mobile Station International Subscriber Directory Number (MSISDN) format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '628211****113', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '68A40250-50CD-034C-B728-0BD******177', + ], + 'Message' => [ + 'description' => 'The description of the return code.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsIdentified' => [ + 'description' => 'Indicates whether the phone number passed the verification.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'Code' => [ + 'description' => 'The return code. Valid values:'."\n" + ."\n" + .'* OK: The request is successful.'."\n" + .'* NoIdentificationResult: No verification result is available or the verification failed.'."\n" + .'* SessionNotValid: The session is invalid or expired.'."\n" + .'* MobileNumberIllegal: The format of the phone number is invalid.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68A40250-50CD-034C-B728-0BD******177\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"IsIdentified\\": \\"true\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'GetPhoneNumberIdentificationResult', + ], + 'DescribeNumberMccMnc' => [ + 'summary' => '号码百科国际站号码归属服务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '263170', + 'abilityTreeNodes' => [ + 'FEATUREdytnsFPPMA9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '86123434345', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Mnc' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Ported' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CountryIso3' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Mcc' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'RequestNumberNotSupported', + 'errorMessage' => 'NotSupported this RequestNumber.', + ], + [ + 'errorCode' => 'PhoneNumberNotfound', + 'errorMessage' => '传入的手机号查不到结果', + ], + ], + 500 => [ + [ + 'errorCode' => 'RequestSupplierError', + 'errorMessage' => 'Request supplier error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"-\\",\\n \\"RequestId\\": \\"CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Mnc\\": \\"123\\",\\n \\"Ported\\": true,\\n \\"CountryIso3\\": \\"USA\\",\\n \\"Mcc\\": \\"123\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'DescribeNumberHLR' => [ + 'summary' => 'HLR服务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '265522', + 'abilityTreeNodes' => [ + 'FEATUREdytnsFPPMA9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1C3B8084-3A7D-570B-BC84-BF945A9CF65E', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Call' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MinLength' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'CleansedCode' => [ + 'description' => 'call', + 'type' => 'string', + 'example' => '示例值', + ], + 'MaxLength' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + ], + ], + 'PhoneType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'CountryIso3' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Live' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RoamingCountry' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'DeviceStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'SubscriberStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Roaming' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'Sms' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MinLength' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MaxLength' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '59', + ], + 'CleansedCode' => [ + 'description' => 'sms', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '58', + ], + ], + ], + 'Carrier' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'City' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Blocked' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"1C3B8084-3A7D-570B-BC84-BF945A9CF65E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Call\\": {\\n \\"MinLength\\": 21,\\n \\"CleansedCode\\": \\"示例值\\",\\n \\"MaxLength\\": 22\\n },\\n \\"PhoneType\\": \\"示例值示例值\\",\\n \\"CountryIso3\\": \\"示例值示例值\\",\\n \\"Live\\": {\\n \\"RoamingCountry\\": \\"示例值\\",\\n \\"DeviceStatus\\": \\"示例值\\",\\n \\"SubscriberStatus\\": \\"示例值\\",\\n \\"Roaming\\": \\"示例值示例值\\"\\n },\\n \\"Sms\\": {\\n \\"MinLength\\": 2,\\n \\"MaxLength\\": 59,\\n \\"CleansedCode\\": 58\\n },\\n \\"Carrier\\": \\"示例值示例值示例值\\",\\n \\"City\\": \\"示例值示例值\\",\\n \\"Blocked\\": \\"示例值示例值\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'dytnsapi.aliyuncs.com', + ], + ], +]; |