【顺丰快递管家】通用接口文档


3.国际地址智能识别接口

<h3>功能描述</h3> <ul> <li>该接口用于:国际地址智能识别。 <h3>国家和语种:</h3> <p>地址智能拆分可以根据地址中的各个部分进行识别和拆分,并将其转化为对应的地理位置或地址要素。对于不同国家和语种,由于语言结构和语法规则的不 同,拆分的方式也可能会有所不同。 例如,对于英语地址的拆分,通常可以按照街道名称、城市、州或国家等方式进行拆分。而对于日语地址的拆分,则需要根据日语的语法规则,将地址拆分 为街道名称、城市、省份或国家等要素。针对不同的语种和国家,需要进行相应的地址拆分和翻译,才能正确地将地址转化为对应的地理位置。</p> <h3>支持多个国家</h3></li> <li>北美洲国家:美国 </li> <li>亚洲国家:日本、韩国 </li> <li>东南亚国家:新加坡、菲律宾、马来西亚、印度尼西亚、泰国、越南 <h3>支持多种语种</h3></li> <li>中文、英语、日语、韩语 <h3>详细国家和语种分布表</h3></li> </ul> <table> <thead> <tr> <th style="text-align: center;">国家</th> <th style="text-align: center;">国家全称</th> <th style="text-align: center;">国家简写</th> <th style="text-align: center;">语种</th> <th>用户名</th> <th>手机号</th> <th>邮编</th> <th>行政区域</th> <th>详细地址</th> <th>详细地址联想能力</th> <th>识别率</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">美国</td> <td style="text-align: center;">America</td> <td style="text-align: center;">US</td> <td style="text-align: center;">英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>87%</td> </tr> <tr> <td style="text-align: center;">日本</td> <td style="text-align: center;">Japan</td> <td style="text-align: center;">JP</td> <td style="text-align: center;">日语、英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>76%</td> </tr> <tr> <td style="text-align: center;">韩国</td> <td style="text-align: center;">Korea</td> <td style="text-align: center;">KR</td> <td style="text-align: center;">韩语、英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>75%</td> </tr> <tr> <td style="text-align: center;">新加坡</td> <td style="text-align: center;">Singapore</td> <td style="text-align: center;">SG</td> <td style="text-align: center;">英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>76%</td> </tr> <tr> <td style="text-align: center;">菲律宾</td> <td style="text-align: center;">Philippines</td> <td style="text-align: center;">PH</td> <td style="text-align: center;">英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>78%</td> </tr> <tr> <td style="text-align: center;">马来西亚</td> <td style="text-align: center;">Malaysia</td> <td style="text-align: center;">MY</td> <td style="text-align: center;">英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>--</td> </tr> <tr> <td style="text-align: center;">印度尼西亚</td> <td style="text-align: center;">Indonesia</td> <td style="text-align: center;">ID</td> <td style="text-align: center;">英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>77%</td> </tr> <tr> <td style="text-align: center;">泰国</td> <td style="text-align: center;">Thailand</td> <td style="text-align: center;">TH</td> <td style="text-align: center;">英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>82%</td> </tr> <tr> <td style="text-align: center;">越南</td> <td style="text-align: center;">Vietnam</td> <td style="text-align: center;">VN</td> <td style="text-align: center;">英语</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>√</td> <td>--%</td> </tr> </tbody> </table> <h3>接口定义</h3> <table> <thead> <tr> <th style="text-align: center;">服务名称</th> <th style="text-align: center;">批量交易</th> <th style="text-align: center;">接口类型</th> <th style="text-align: center;">接口uri(同确认接口)</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">地址智能识别接口</td> <td style="text-align: center;">不支持</td> <td style="text-align: center;">接入/POST</td> <td style="text-align: center;">/public/gis/v1/internationAddressIdentify</td> </tr> </tbody> </table> <h3>元素&lt;请求&gt;</h3> <ul> <li><strong>主体</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">默认值</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">companyId</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">公司ID</td> <td style="text-align: left;">分配客户sendAppId。</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">addresstext</td> <td style="text-align: center;">String(500)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">要识别的地址</td> </tr> </tbody> </table> <h3>元素&lt;响应&gt;</h3> <ul> <li><strong>主体</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">msg</td> <td style="text-align: center;">String(200)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">信息</td> <td style="text-align: left;">提示信息</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">succ</td> <td style="text-align: center;">String(10)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">状态码</td> <td style="text-align: left;">返回成功或失败信息(ok/fail)</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">List</td> <td style="text-align: center;">是</td> <td style="text-align: center;">错误详细信息</td> </tr> </tbody> </table> <ul> <li><strong>result 说明</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">splitRank</td> <td style="text-align: center;">Integer(1)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">请求状态</td> <td style="text-align: left;">1001:全部拆出结果 1002:部分拆除结果 1003:没有拆分出结果</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">usernameInfo</td> <td style="text-align: center;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">用户名拆分结果</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">phoneNumberInfo</td> <td style="text-align: center;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">电话号码拆分结果</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">postCodeInfo</td> <td style="text-align: center;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">邮编拆分结果</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">addressInfo</td> <td style="text-align: center;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">地址信息</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">advanceCheck</td> <td style="text-align: center;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">前置判断</td> </tr> <tr> <td style="text-align: center;">7</td> <td style="text-align: center;">companyname</td> <td style="text-align: center;">String(50)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">公司名称</td> <td style="text-align: left;">地址中包含公司则拆拆分接口中会有公司信息</td> </tr> </tbody> </table> <ul> <li><strong>usernameInfo 说明</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">username</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">地址中可能的人名</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">state</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">用户名</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">remark</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">备注信息</td> <td style="text-align: left;">目前暂不返回</td> </tr> </tbody> </table> <ul> <li><strong>phoneNumberInfo 说明</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">phoneNumber</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">电话号码</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">areaCode</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">电话号码-所属区号</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">state</td> <td style="text-align: center;">Integer(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">电话号码拆分状态,枚举值</td> <td style="text-align: left;">101:匹配,102:未匹配</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">remark</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">备注信息</td> <td style="text-align: left;">目前暂不返回</td> </tr> </tbody> </table> <ul> <li><strong>postCodeInfo 说明</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">postCode</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">邮编</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">state</td> <td style="text-align: center;">Integer(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">邮编拆分状态,枚举值</td> <td style="text-align: left;">101:匹配,102:未匹配,103:前几位匹配</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">remark</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">备注信息</td> <td style="text-align: left;">目前暂不返回</td> </tr> </tbody> </table> <ul> <li><strong>addressInfo 说明</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">country</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">国家</td> <td style="text-align: left;">为简写,例如:美国-US,日本-JP</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">state</td> <td style="text-align: center;">Integer(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">地址拆分状态,枚举值</td> <td style="text-align: left;">101:匹配,102:未匹配</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">formattedAddress</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">备注信息</td> <td style="text-align: left;">拆分后的详细地址</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">administrativeAreaLevelFirst</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">一级行政区域</td> <td style="text-align: left;">中国:省,美国:州</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">administrativeAreaLevelSecond</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">二级行政区域</td> <td style="text-align: left;">中国:市,美国:市</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">administrativeAreaLevelThree</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">三级行政区域</td> <td style="text-align: left;">目前暂不返回</td> </tr> <tr> <td style="text-align: center;">7</td> <td style="text-align: center;">adminState</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">行政区域拆分状态,枚举值</td> <td style="text-align: left;">101:匹配,102:未匹配</td> </tr> <tr> <td style="text-align: center;">8</td> <td style="text-align: center;">addressList</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">完整的地址-可以查看额外 的信息</td> <td style="text-align: left;">为当前地址的坐标具体信息,并不一定会返回 如果不需要了解详情,可不用关注</td> </tr> </tbody> </table> <ul> <li><strong>advanceCheck 说明</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">isContainPhone</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">是否包含电话</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">state</td> <td style="text-align: center;">Integer(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">isContainPostCode</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ &amp;quot;companyId&amp;quot;:&amp;quot;201905140011898&amp;quot;, &amp;quot;addresstext&amp;quot;:&amp;quot;US,955 Torero Plz, Campbell, CA, 95008。858-214-7027,测试公司&amp;quot; }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{     &amp;quot;msg&amp;quot;: &amp;quot;&amp;quot;,     &amp;quot;result&amp;quot;: [         {             &amp;quot;postCodeInfo&amp;quot;: {                 &amp;quot;postCode&amp;quot;: &amp;quot;95008&amp;quot;,                 &amp;quot;state&amp;quot;: 101             },             &amp;quot;phoneNumberInfo&amp;quot;: {                 &amp;quot;phoneNumber&amp;quot;: &amp;quot;8582147027&amp;quot;,                 &amp;quot;state&amp;quot;: 101             },             &amp;quot;addressInfo&amp;quot;: {                 &amp;quot;country&amp;quot;: &amp;quot;US&amp;quot;,                 &amp;quot;formattedAddress&amp;quot;: &amp;quot;955 Torero Plaza, Campbell, CA 95008, USA&amp;quot;,                 &amp;quot;addressList&amp;quot;: [                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;street_number&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;955&amp;quot;                     },                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;route&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;Torero Plaza&amp;quot;                     },                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;neighborhood&amp;quot;,                             &amp;quot;political&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;San Tomas&amp;quot;                     },                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;locality&amp;quot;,                             &amp;quot;political&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;Campbell&amp;quot;                     },                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;administrative_area_level_2&amp;quot;,                             &amp;quot;political&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;Santa Clara County&amp;quot;                     },                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;administrative_area_level_1&amp;quot;,                             &amp;quot;political&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;California&amp;quot;                     },                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;country&amp;quot;,                             &amp;quot;political&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;United States&amp;quot;                     },                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;postal_code&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;95008&amp;quot;                     },                     {                         &amp;quot;types&amp;quot;: [                             &amp;quot;postal_code_suffix&amp;quot;                         ],                         &amp;quot;long_name&amp;quot;: &amp;quot;5939&amp;quot;                     }                 ],                 &amp;quot;adminState&amp;quot;: 101,                 &amp;quot;administrativeAreaLevelSecond&amp;quot;: &amp;quot;Santa Clara&amp;quot;,                 &amp;quot;state&amp;quot;: 101,                 &amp;quot;administrativeAreaLevelFirst&amp;quot;: &amp;quot;California&amp;quot;             },             &amp;quot;usernameInfo&amp;quot;: {                 &amp;quot;state&amp;quot;: 102             },             &amp;quot;advanceCheck&amp;quot;: {                 &amp;quot;isContainPostCode&amp;quot;: 1,                 &amp;quot;isContainPhone&amp;quot;: 1             },             &amp;quot;companyname&amp;quot;: &amp;quot;测试公司&amp;quot;,             &amp;quot;splitRank&amp;quot;: 1001         }     ],     &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot; }</code></pre></li> <li>失败报文-范例1 <pre><code>{     &amp;quot;msg&amp;quot;: &amp;quot;当前USus国家不支持智能解析,详见智能解析说明&amp;quot;,     &amp;quot;result&amp;quot;: null,     &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML