'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' => '获取本机号码认证URL。', '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' => '客户端IP。', 'type' => 'string', 'required' => false, 'example' => '114.124.***.13', ], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => '客户端手机号（MSISDN格式）。', 'type' => 'string', 'required' => true, 'example' => '628211****113', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '外部流水号。', 'type' => 'string', 'required' => true, 'example' => '149b03d2-a749-4e6e-8f5b-34******5815', ], ], [ 'name' => 'AuthCode', 'in' => 'query', 'schema' => [ 'description' => '授权码。', 'type' => 'string', 'required' => true, 'example' => 'K***9i7CIe', ], ], [ 'name' => 'RememberPhoneNumber', 'in' => 'query', 'schema' => [ 'description' => '是否记录手机号。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回对象。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '68A40250-50CD-034C-B728-0BD******177', ], 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'IdentificationUrl' => [ 'description' => '认证URL。', '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' => '会话ID。', 'type' => 'string', 'example' => '8636b75e2fcb40c53ffecc2b5947115c.149b03d2a7494e6e8f5b34c915245815.707c7f0d93f4409db0761aa5da94ce01.1686******041', ], ], ], 'Code' => [ 'description' => '请求状态码。'."\n" ."\n" .'- **OK**：请求成功。'."\n" .'- **IdentificationNotAvailable**：该IP对应的手机号不支持认证。'."\n" .'- **MobileNumberIllegal**：手机号格式错误。', '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' => '获取本机号码认证URL', ], 'GetPhoneNumberIdentificationResult' => [ 'summary' => '获取本机号码认证结果。', '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' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '8636b75e2fcb40c53ffecc2b5947115c.149b03d2a7494e6e8f5b34c915245815.707c7f0d93f4409db0761aa5da94ce01.1686******041', ], ], [ 'name' => 'SessionPayload', 'in' => 'query', 'schema' => [ 'description' => '会话负载。', 'type' => 'string', 'required' => true, 'example' => 'uQne0vsuNywXVvI4VP5taHsgDNsd3BwcbmrhjXi58WbxBGFW+e8ufMEi9j89YonphV6NZ1PIeKvboHtU1nsSjZMTcoFPfkjqaORIHdSlPb6vmIzqOnJMsP1KPQ8K1JLXSaAKsB2lQ5A9HCkX2HzDEwje14HYQsnPd/Ka2YWgXuL0N8GE9oYi25d4DdlU0XR52YjSj8GMLSgbW7yNxEPvUCOQG83FZfQqmIWG2+0C/fQ3gdG9WI7AeeHZo4IRKGtQnpjKGtZZl8VoLPNIswDqZeeyjCyZlKUXKrAt4Co9c4I4q8G1jZm53COQJ+DuTiWH7w+tois3WJwFV/HmdlAKt8SqpiVrEv47VQ9V+8FYsdKz3A3CRyBVgNj6wYKKbwaI9BdQoOkbYzzA8CfAKO5w1oYVD2nOcYS/AffbPbE31PJj7SdVvKghwPL56OVdjS9Hd0iW0SMBWD0F1iRNCUNHL3ffHcFjJLdhTrMt8VHSRn0nOlvO1ZaWqMQ0yE0q*************************kXTpoQLo0+0h+CEcf90hTg8XdMhj9B0A3SOINceLlmoZb3czvYl00+CC0075DjOX41YtnuAUfaNYPgLIZkjYyq+JopBQFAkxPUbJHC0oCzB9dQa******WY38OPBs=', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '外部流水号。', 'type' => 'string', 'required' => true, 'example' => '149b03d2-a749-4e6e-8f5b-34******5815', ], ], [ 'name' => 'AuthCode', 'in' => 'query', 'schema' => [ 'description' => '授权码。', 'type' => 'string', 'required' => true, 'example' => 'K***9i7CIe', ], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => '客户端手机号（MSISDN格式，认证过程中须保持一致）。', 'type' => 'string', 'required' => true, 'example' => '628211****113', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回对象。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '68A40250-50CD-034C-B728-0BD******177', ], 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'IsIdentified' => [ 'description' => '是否通过认证。', 'type' => 'string', 'example' => 'true', ], ], ], 'Code' => [ 'description' => '请求状态码。'."\n" ."\n" .'- OK：请求成功。'."\n" .'- NoIdentificationResult：无认证结果或无法认证。'."\n" .'- SessionNotValid：无效或过期的会话。'."\n" .'- MobileNumberIllegal：手机号格式错误。', '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' => '获取本机号码认证结果', ], 'DescribeNumberMccMnc' => [ 'summary' => '号码百科国际站号码归属服务,用于查询号码归属的国家和运营商(Mcc Mnc 码)', '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' => '号码，（号码前需要带上区号）如中国香港地区号码，则为85212343433', 'type' => 'string', 'required' => false, 'example' => '86123434345', ], ], [ 'name' => 'AuthCode', 'in' => 'query', 'schema' => [ 'description' => '授权码。'."\n" ."\n" .'> 在**号码分析服务**->[**标签广场**](https://dytns.console.aliyun.com/analysis/square)选择标签，提交使用申请，申请通过后，会获得该授权码。', 'type' => 'string', 'required' => false, 'example' => '示例值', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息；只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => '-', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47', ], 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '结构体。', 'type' => 'object', 'properties' => [ 'Mnc' => [ 'description' => '号码归属的运营商Mnc码', 'type' => 'string', 'example' => '123', ], 'Ported' => [ 'description' => '号码是否有发生过携转', 'type' => 'boolean', 'example' => 'true', ], 'CountryIso3' => [ 'description' => '号码归属国家ISO3码', 'type' => 'string', 'example' => 'USA', ], 'Mcc' => [ 'description' => '号码归属的运营商mcc码', 'type' => 'string', 'example' => '123', ], ], ], 'Code' => [ 'description' => '请求状态码。 **OK**为成功。', '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"}]', 'description' => '请确保在使用该接口前，已充分了解号码产品的收费方式和价格。'."\n" ."\n" .'计费方式：当返回Code== \'OK\'进行计费。'."\n" ."\n" .'因为数据原因，MCC、MNC返回码可能为空。', 'responseParamsDescription' => '目前支持的国家或者地区只包括：美国、西班牙、马来西亚、日本、泰国、韩国、巴西、俄罗斯、越南、法国、菲律宾、德国、英国、意大利、巴基斯坦、新加坡、印度、中国香港地区', 'title' => '国际号码归属服务', ], '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' => '授权码。'."\n" ."\n" .'>登录[号码百科控制台](https://dytns.console.aliyun.com/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC)，在[我的申请](https://dytns.console.aliyun.com/analysis/apply)页面，获取授权ID即授权码。', 'type' => 'string', 'required' => false, 'example' => '示例值示例值', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息；只有Ram校验失败才会返回此字段', 'type' => 'string', 'example' => 'None', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '号码归属国家ISO3码', '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' => '请求状态码。取值：'."\n" ."\n" .'- **OK**：成功。', '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"}]', 'title' => '号码状态服务', 'description' => '- 请确保在使用本接口前，您已充分了解号码百科产品定价。'."\n" .'- 使用本接口前，请登录号码百科控制台，在标签广场页面，找到对应的标签，单击申请开通。'."\n" .'- 当接口值返回值：Code="OK"时计费，其他返回结果不计费。', ], ], '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', ], ], ];