Optional Parameters
Overview
Within your API request you can also dictate the Cache Levels you wish to utilise.
Adding these parameters to your request will override the Default Cache Settings found on your Account Setting page.
If no Cache Parameters are used then the default levels you have set in your Account Settings will be used.
Add the following parameters to your GET request to use the Cache
Cache Parameters
HEADER | INFORMATION |
|---|---|
personalcache | A value between 0 and 30 that relates to the number of days you want to check against your Personal Cache |
sharedcache | A value between 0 and 30 that relates to the number of days you want to check against the Global Cache |
savetoshared | Set to 'on' to save this result to the Global Cache of results. Set to 0 or 'off' to not save your result |
Example Request
Here's an example request utilising the cache parameters:
https://hlrlookup.com/api/hlr/?apikey=$key&password=$password&msisdn=$msisdn&personalcache=10&sharedcache=10&savetoshared=onThis will perform a HLR lookup of one number, first checking if you have previously had a result for that number within 10 days.
If no result was found in your Personal Cache we will then check the Global Cache to see if the number has been checked by another user of HLR Lookup who have allowed their results to be added to the Global Cache in the last 10 days.
If the number is still not found we will look the number up with the appropriate network and add the returned result to the Global Cache.