HLR

HLR number lookup

Queue an HLR lookup for a single number with no callback URL. This endpoint is always asynchronous and never returns the lookup result inline. On acceptance it responds 390 with a Location header naming an internal nchan channel (hlr{batchId}) that the result is published to once the lookup completes; the caller must subscribe to that channel to receive it. A number that fails local format validation is rejected inline with 200 instead of being queued

get/hlr/

Request

Base URL: http://api.smsfusion.com.au
URL: http://api.smsfusion.com.au/hlr/
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

A single phone number or <a href='https://www.smsfusion.com.au/help/msisdn/'>MSDISDN</a>

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

The number failed local format validation and was rejected without being queued; body is the HLR result shape with status set to invalid

idstring

Unique ID for response

batchidinteger

HLR queue batch ID this result belongs to

msisdninteger

The MSISDN of the number queried

status'valid' | 'invalid' | 'unknown'

Short status code of the response

countrystring

ISO 3166-2 country code

operatorstring

The operator attached to the MSISDN

mccmncinteger

MCC and MNC of MSDISDN

duration'perm' | 'temp'

If the response code is temporary or permenant

messagestring

Full status code of the response

extendedstring

Extended explanation of the status code

Example response

{
  "id": "13Cy205d697R",
  "country": "AU",
  "operator": "(AUSTRALIA)OPTUS",
  "message": "subscriber preset",
  "extended": "Subscriber present"
}

Changes

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