Developer Docs
Table of contents

Getting the information about the HLR request

GET /hlr/{id}

Endpoint URL: https://api.affiliate-sms.com/hlr/{id}

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

GET /hlr/reference/{reference}

Endpoint URL: https://api.affiliate-sms.com/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":"380932990000",
"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 – HLR internal ID
  • reference – HLR external ID
  • msisdn – the phone number for which the HLR request is performed
  • network – number’s mccmnc (for absent, active statuses)
  • status – the request status. Possible values: sent, absent, active, unknown, failed
  • details – HLR 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"
}