HLR

HLR number lookup with results going to a callback URL

Queue HLR lookups for one or more numbers. This endpoint is always asynchronous: the 200 response is only an acknowledgment of the batch (cost and any numbers that failed local format validation). Each number's actual lookup result is POSTed to the callback URL separately, as 'result=', whenever that lookup completes - there is no bound on how long after this response that happens. Served by the same script as /hlr/, selected by supplying cb

get/hlr-callback/

Request

  • Base URL: http://api.smsfusion.com.au
  • URL: http://api.smsfusion.com.au/hlr-callback/
  • Auth: API key in query parameter key

Query parameters

keystring required

API Key as generated from the <a href='https://www.smsfusion.com.au/admin/api/'>admin panel</a>

numstring[] required

Comma separated list of phone numbers or <a href='https://www.smsfusion.com.au/help/msisdn/'>MSDISDN</a>'s

cbstring required

HTTP or HTTPS callback URL for each result. The result will be sent as POST with a json object included in <b>result</b>. Timeout for callbacks is set to 30 seconds

ccstring string

2 character country code <a href='https://en.wikipedia.org/wiki/ISO_3166-2'>ISO 3166-2</a> for formatting local numbers internationally

Response

Batch accepted. This is an acknowledgment only, not the lookup result: each number's result is POSTed to the callback URL separately and asynchronously as it becomes available

statusstring
successinteger[]
failureinteger[]
costnumber float

Cost of the response

callbackstring

Callback URL provided

Example response

{
  "status": "success",
  "callback": "http://www.example.com/hlr-callback/"
}

Changes

No recorded changes to this operation across all 1 revision of this API.