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/2023-01-01/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/dytnsapi/2023-01-01/api-docs.php')
| -rw-r--r-- | data/en_us/dytnsapi/2023-01-01/api-docs.php | 694 |
1 files changed, 694 insertions, 0 deletions
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', + ], + ], +]; |
