Extract information from logistics waybills
Extracts names, locations, and phone numbers from logistics waybills.
Test
You can run an API test in the Address Purification console.
Request parameters
Name | Type | Required | Example value | Description |
Action | String | Yes | ExtractExpress | A required parameter. Set the value to ExtractExpress. |
AppKey | String | Yes | Axqwerasdf1a | The AppKey of the project. |
ServiceCode | String | Yes | addrp | A static field. The value is addrp. |
Text | String | Yes | Recipient: Mr. Zhang; Phone number: 1338888****; Region: ** Province ** City **** District ** Street; Detailed address: *** Village, Building 16, **** | The text content. |
DefaultProvince | String | No | Zhejiang Province | The default province. |
DefaultCity | String | No | Hangzhou City | The default city. |
DefaultDistrict | String | No | Yuhang District | The default administrative region. |
Response data
Name | Type | Example value | Description |
Data | String | {"express_extract":{"house_info":"Building 16****","poi_info":"*** Village","town":"** Street","city":"** City","district":"*** District","tel":"1338888****","addr_info":"*** Village, Building 16****","per":"Mr. Zhang","prov":"** Province"},"status":"OK","time_used":{"rt":{"express_extract":0.0001595020294189453,"structure":0.029137134552001953},"start":1619321964.6946392}} |
|
RequestId | String | E0627DDE-28D7-4C00-A611-E047DF81AF05 | The request ID. |
Examples
Request example
http(s)://[Endpoint]/?Action=ExtractExpress
&AppKey=Axqwerasdf1a
&ServiceCode=addrp
&Text=Recipient: Mr. Zhang; Phone number: 1338888****; Region:** Province ** City *** District ** Street; Detailed address:*** Village, Building 16, ****
&<Common request parameters>Success response example
XML format
<RequestId>5047DAC3-475F-4361-B8B8-B2A9F4D33247</RequestId>
<Data>
<express_extract>
<house_info>Building 16****</house_info>
<poi_info>** New Village</poi_info>
<town>** Street</town>
<city>** City</city>
<district>*** District</district>
<tel>1888888****</tel>
<addr_info>*** Village, Building 16****</addr_info>
<per>Mr. Zhang</per>
<prov>** Province</prov>
</express_extract>
<status>OK</status>
<time_used>
<rt>
<express_extract>0.0001595020294189453</express_extract>
<structure>0.029137134552001953</structure>
</rt>
<start>1619321964.6946392</start>
</time_used>
</Data>JSON format
{
"RequestId":"5047DAC3-475F-4361-B8B8-B2A9F4D33247",
"Data":{
"express_extract":{
"house_info":"Building 16****",
"poi_info":"*** Village",
"town":"** Street",
"city":"** City",
"district":"*** District",
"tel":"1338888****",
"addr_info":"*** Village, Building 16****",
"per":"Mr. Zhang",
"prov":"** Province"
},
"status":"OK",
"time_used":{
"rt":{
"express_extract":0.0001595020294189453,
"structure":0.029137134552001953
},
"start":1619321964.6946392
}
}
}Error codes
HTTP code | Error code | Error message | Description |
403 | Forbidden.NoAuth | Failed to perform user authentication. | User authentication failed. |
500 | InternalError | A service error occurred. | An internal service error occurred. |
400 | InvalidParameter | The parameter is invalid. | The parameter is invalid. |
404 | ResourceDoesNotExist | The resource does not exist. | The resource does not exist. |
429 | Throttling.User | Flow control has been triggered. | Throttling was triggered. |
400 | UserStatusInvalid | The user status is invalid. | The user status is invalid. |
For more information about error codes, see the Error Center.