Developer Docs

Table of contents

Retrieving the information about the Number Verifier request

GET /hlr/{id}

Endpoint URL: https://api.bsg.hk/hlr/{id}

Where {id} – ID of the entry received from the method /hlr/create

GET /hlr/reference/{reference}

Endpoint URL: https://api.bsg.hk/hlr/{reference}

Where {reference} – the message external ID

In the response, a JSON will be received having approximately the following structure:

{
"id":"34298934543",
"reference":"1234567",
"msisdn":"85267202829",
"network":"unknown",
"status":"unknown",
"details":{"ported":"0","roaming":"0"},
"createdDatetime":"2015-08-04T06:50:19+00:00",
"statusDatetime":"2015-08-04T06:50:19+00:00"
}
  • id – Number Verifier internal ID
  • reference – Number Verifier external ID
  • msisdn – the phone number for which the Number Verifier request is performed
  • network – number’s mccmnc (for absent, active statuses)
  • status – the request status. Possible values: sent, absent, active, unknown, failed
  • details – Number Verifier request details (complete information is available if the status is active)
  • ported – an attribute, whether the phone is ported or not (1 – ported, 0 – not)
  • roaming – an attribute, whether the phone is in roaming or not (1 – in roaming, 0 – not)

Or, in case of error:

{
"error":"10",
"errorDescription":"HLR not found"
}

We use cookies (and other similar technologies) to collect data to improve your experience on our site. By using our website, you’re agreeing to the collection of data as described in our Website Data Collection Policy.