快寶智慧解析API文件
應用場景
1. 電商平臺、電商ERP軟體、物流應用軟體等需要錄入聯絡人資訊,允許使用者自由輸入聯絡資訊,無需分段按規格錄入,提升錄入效率和使用體驗
2. 已有的聯絡人資訊為純文字,需要自動解析為姓名、電話、省市區、詳細地址和備註
3. 使用者輸入的聯絡人資訊中,省、市、區資訊不全或有錯誤,需要自動糾正為完整、準確的行政區域資訊
主要功能
1. 將包含收發件人資訊的文字,識別為結構化的收發件人資訊,返回姓名、電話號碼、省、市、區、鄉鎮、詳細地址、備註等分段資訊,能夠智慧補全地址中缺失的行政區域
2. 對於包含了不規範的行政區域名稱、過時的舊稱呼、已經撤銷或合併的行政區域名稱的地址,可以通過該介面解析為規範、最新、準確的行政區域名稱
額外說明
技術諮詢請加微信:kuaibao135
介面名稱
cloud.address.resolve
公共引數
請求地址
環境名稱
|
HTTPS請求地址
|
---|---|
正式地址 |
公共請求引數
名稱
|
型別
|
是否必須
|
描述
|
---|---|---|---|
method | string | 是 |
API介面名稱 |
app_id | string | 是 |
使用者ID(註冊開放平臺時分配,在控制檯中檢視) |
sign | string | 是 |
按照規則(md5(app_id + method + ts + api_key))生成的合法性驗證簽名(32位字串,字母小寫)如:10000cloud.print.do1524209949bdf3b5f50865ac813cbdfd6c9b572b79加密後5030cae3388ecdc2e686379753a0564c |
ts | string | 是 |
當前請求的時間戳(10位或13位) |
data | string | 是 |
JSON格式請求引數 |
公共響應引數
名稱
|
型別
|
是否必須
|
描述
|
---|---|---|---|
code | int | 是 |
響應狀態碼。0-成功,非0-失敗
下載並檢視詳情 |
msg | string | 是 |
返回結果說明 |
uid | string | 是 |
本次請求唯一業務流水號 |
data | string | 是 |
JSON格式響應資料 |
請求引數
名稱
|
型別
|
是否必須
|
描述
|
---|---|---|---|
multimode | bool | 否 |
是否為批量模式,false為非批量,此時整個text引數認為是一條聯絡人資訊;true為批量,此時根據text引數中的換行符區隔多條聯絡人資訊。預設為true |
text | string | 是 |
包含地址、姓名、電話等資訊的待解析文字,批量模式下多條記錄用回車或換行符(\r\n)分割 |
resolveTown | int | 否 |
是否從地址中解析鄉鎮、街道級別行政區域資訊。0:不解析,1:地址中包含有鄉鎮、街道名稱,則解析,否則不解析,2:不管地址中是否包含鄉鎮、街道名稱,都嘗試解析鄉鎮資訊。預設值為0。若值為1或2,返回結果中會包含town_name,town_id, town_code欄位,address欄位中將不再包含鄉鎮級別行政區域資訊 |
響應引數
名稱
|
型別
|
是否必須
|
描述
|
---|---|---|---|
original | string | 是 |
輸入的原始文字。響應體的data欄位為一陣列,每個陣列元素為一條解析結果,本節描述的是每個元素的欄位 |
mobile | string | 是 |
手機號碼 |
phone | string | 是 |
固定電話 |
name | string | 是 |
姓名 |
note | string | 是 |
備註 |
province_name | string | 是 |
省級名稱 |
province_shortname | string | 是 |
省級簡稱 |
province_id | string | 是 |
省級快寶內部ID |
province_code | string | 是 |
省級行政區劃程式碼 |
city_name | string | 是 |
市級名稱 |
city_shortname | string | 是 |
市級簡稱 |
city_id | string | 是 |
市級快寶內部ID |
county_name | string | 是 |
縣級名稱 |
county_shortname | string | 是 |
縣級簡稱 |
county_id | string | 否 |
縣級快寶內部ID |
county_code | string | 否 |
縣級行政區劃程式碼 |
town_name | string | 否 |
鄉鎮、街道名稱,僅在resolveTown為true時返回該值 |
town_id | string | 否 |
鄉鎮、街道級別快寶內部ID,僅在resolveTown為true時返回該值 |
town_code | string | 否 |
鄉鎮、街道級別行政區劃程式碼 |
detail | string | 是 |
詳細地址 |
province_confidence | int | 是 |
省級資訊解析準確度欄位,當返回值小於3時認為準確度相對較低有識別錯誤概率,該欄位可用於客戶端提示使用者檢查地址資訊時使用; |
city_confidence | int | 是 |
市級資訊解析準確度欄位,當返回值小於3時認為準確度相對較低有識別錯誤概率,該欄位可用於客戶端提示使用者檢查地址資訊時使用; |
county_confidence | int | 是 |
區級資訊解析準確度欄位,當返回值小於3時認為準確度相對較低有識別錯誤概率,該欄位可用於客戶端提示使用者檢查地址資訊時使用; |
請求示例
單條請條示例
響應示例
成功響應示例
異常響應示例
錯誤程式碼
錯誤碼
|
描述
|
---|---|
300101 | 快遞單號建立失敗 |
300102 | 獲取快遞單號失敗 |
300103 | 不合法的請求引數 |
300103 | 圖片格式錯誤 |
300104 | 簽名格式不正確 |
300105 | 請求方式錯誤 |
300105 | 請求方式錯誤 |
300106 | 請求的的資料格式錯誤 |
300107 | 缺少必要引數 |
300108 | 使用者app_id值不正確 |
300109 | 不存在的業務型別 |
300110 | 請求含有非法引數 |
300111 | 請求引數不能為空 |
300112 | 使用者app_key值不正確 |
300115 | 業務引數有誤,請檢查 |
400001 | 業務引數有誤 |
400002 | 超出批量解析最大數量限制 |
400003 | 輸入字元太少 |
400004 | 請求方式錯誤 |
400005 | 請求資料格式錯誤 |
400006 | 缺少必要的引數 |
400007 | 型別不合法 |
400008 | 不支援的快遞品牌 |
來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/70015616/viewspace-2882752/,如需轉載,請註明出處,否則將追究法律責任。
相關文章
- 快寶物流訂閱介面文件
- 快寶物流查詢API介面API
- 支付寶-API介面解析-轉賬到銀行API
- API文件API
- C#通用文件API介面整合示例-合同識別-智慧文件識別C#API
- api和api幫助文件API
- Laravel API 文件生成器生成指定的 API 文件LaravelAPI
- 前端學習文件寶典前端
- eosjs 文件(API)JSAPI
- 寶藏API:免費好用的api分享API
- 全國快遞物流 API 實現快遞單號自動識別的原理解析API
- 解析 API Blueprint 文件並自動化生成程式碼(可定製模板)API
- eosjs 文件(API介面)JSAPI
- jQuery 幫助文件 apijQueryAPI
- API文件使用方法API
- Swagger API 文件SwaggerAPI
- 前端API文件地址大全前端API
- java API 幫助文件JavaAPI
- OPENAI API應用文件OpenAIAPI
- 使用apidoc文件神器,快速生成api文件API
- 智慧運維大資料的終極寶典(附圖表解析)運維大資料
- 支付寶退款全解析
- Ocelot中文文件-快取快取
- Node.js API參考文件(關於文件)Node.jsAPI
- showdoc 自動生成 API 文件API
- Laravel API 文件生成器LaravelAPI
- Java API之查詢文件JavaAPI
- 【api寶庫】熱門免費的api介面彙總API
- RAG文件解析利器:Deepdoc
- DOM 常用 API 解析API
- ApiSetSchema/API集-解析API
- 用Python給我家寶寶寫個翻譯doc文件軟體Python
- 寶付大資料分析解析大資料
- 支付寶App支付全解析APP
- 常用快遞單號查詢api介面對接案例(快遞鳥api)API
- 用這款Naya智慧吸奶器讓寶寶喝到飽
- 武夷 | 搞定自動化 API 文件API
- Laravel Swagger 生成 API 文件LaravelSwaggerAPI