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


2.地址智能识别接口

<h3>功能描述</h3> <ul> <li>该接口用于:地址智能识别。</li> </ul> <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/addressIdentify</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(1000)</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;">Object</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;">code</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;">0-成功,1-地址识别失败,2-请求地址识别服务</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">message</td> <td style="text-align: center;">String(1000)</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;">sn</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">结果标识sn码(唯一标识)</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">multiple</td> <td style="text-align: center;">String(1)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">错误标识</td> <td style="text-align: left;">返回“1”,表示识别到用户地址未输入省市信息,且输入的区在全国范围内有重复,返回其他值则表示正常结果</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">src</td> <td style="text-align: center;">String(20)</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;">paidata</td> <td style="text-align: center;">Object</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;">data</td> <td style="text-align: center;">Object</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>result.paidata 说明</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;">personName</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;">phoneNumber</td> <td style="text-align: center;">String(20)</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;">postalCode</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;">address</td> <td style="text-align: center;">String(1000)</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;">company</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;">目前暂不返回</td> </tr> <tr> <td style="text-align: center;">6</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>result.data 说明</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;">province</td> <td style="text-align: center;">String(20)</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;">city</td> <td style="text-align: center;">String(20)</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;">county</td> <td style="text-align: center;">String(20)</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;">town</td> <td style="text-align: center;">String(20)</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;">adcode</td> <td style="text-align: center;">String(20)</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;">citycode</td> <td style="text-align: center;">String(20)</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;">detailaddr</td> <td style="text-align: center;">String(1000)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">详细地址</td> <td style="text-align: left;">详细地址</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ "companyId":"201905140011898", "addresstext":"北京市顺义区南法信镇顺捷大厦" }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ "result": { "code": 0, "message": null, "sn": "0454112021072909295362029200", "multiple": "0", "src": "tip|ars", "paidata": { "personName": [], "phoneNumber": "", "postalCode": null, "address": "北京市顺义区南法信镇顺捷大厦", "company": null, "remark": "" }, "data": { "province": "北京市", "city": "北京市", "county": "顺义区", "town": "南法信地区", "adcode": "110113", "citycode": "010", "detailaddr": "顺捷大厦" } }, "succ": "ok", "msg": "地址解析成功" }</code></pre></li> <li>失败报文-范例1 <pre><code>{ "result": { "code": 0, "message": null, "sn": "local1616414023-709511502", "multiple": "1", "src": "local", "paidata": { "personName": [ "33京市" ], "phoneNumber": null, "postalCode": null, "address": "33京市", "company": null, "remark": null }, "data": { "province": null, "city": null, "county": null, "town": null, "adcode": null, "citycode": null, "detailaddr": null } }, "succ": "fail", "msg": "地址解析失败" }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML