HLR Lookup

Get information about any number like its validity, wether it is currently active in a mobile network, and if so, wich one. You can also know if the number is in roaming mode, or if it is ported to another operator.

POST

/lookup

Body Parameters

to
required
 This field must be an array of phone numbers

Examples


POST /lookup HTTP/1.1
Host: api.smsup.ch
Authorization: Bearer your.token
Accept: application/json

{
  "lookup": {
    "to": ["41781234567", "41781234566"]
  }
}
          
        

<?xml version="1.0" encoding="UTF-8"?>
<lookup>
  <to>41781234567</to>
  <to>41781234566</to>
</lookup>

Result Format


{
  "status": 1,
  "message": "OK",
  "cost": 2,
  "credits": 642,
  "response": {
    "lookup": [
      {
        "to": "41781234567",
        "mccMnc": "20801",
        "imsi": "208019900000000",
        "originalNetwork": {
          "networkName": "Orange",
          "networkPrefix": "671",
          "countryName": "France",
          "countryPrefix": "33"
        },
        "ported": false,
        "roaming": false,
        "status": {
          "name": "DELIVERED",
          "description": "Message delivered to handset",
          "detailed": "DELIVERED_TO_HANDSET"
        },
        "error": {
          "id": 0,
          "description": "No Error",
          "permanent": false
        }
      },
      {
        "to": "41781234566",
        "mccMnc": "20801",
        "originalNetwork": {
          "networkName": "Orange",
          "networkPrefix": "671",
          "countryName": "France",
          "countryPrefix": "33"
        },
        "ported": false,
        "roaming": false,
        "status": {
          "name": "UNDELIVERABLE",
          "description": "Message sent not delivered",
          "detailed": "UNDELIVERABLE_NOT_DELIVERED"
        },
        "error": {
          "id": 27,
          "description": "Absent Subscriber",
          "permanent": false
        }
      }
    ]
  }
}
          
        

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>1</status>
  <message>OK</message>
  <cost>2</cost>
  <credits>25</credits>
  <response>
    <lookup>
      <to>41781234567</to>
      <mccMnc>20801</mccMnc>
      <originalNetwork>
          <networkName>Orange</networkName>
          <networkPrefix>671</networkPrefix>
          <countryName>France</countryName>
          <countryPrefix>33</countryPrefix>
      </originalNetwork>
      <ported>false</ported>
      <roaming>false</roaming>
      <status>
          <name>UNDELIVERABLE</name>
          <description>Message sent not delivered</description>
          <detailed>UNDELIVERABLE_NOT_DELIVERED</detailed>
      </status>
      <error>
          <id>27</id>
          <description>Absent Subscriber</description>
          <permanent>false</permanent>
      </error>
    </lookup>
    <lookup>
      <to>41781234566</to>
      <mccMnc>20801</mccMnc>
      <imsi>208019900000000</imsi>
      <originalNetwork>
          <networkName>Orange</networkName>
          <networkPrefix>671</networkPrefix>
          <countryName>France</countryName>
          <countryPrefix>33</countryPrefix>
      </originalNetwork>
      <ported>false</ported>
      <roaming>false</roaming>
      <status>
          <name>DELIVERED</name>
          <description>Message delivered to handset</description>
          <detailed>DELIVERED_TO_HANDSET</detailed>
      </status>
      <error>
          <id>0</id>
          <description>No Error</description>
          <permanent>false</permanent>
      </error>
    </lookup>
  </response>
</response>