Number Lookup

Number Lookup

Get HLR lookup history

get

Retrieve the HLR lookup history for the authenticated user

Authorizations

bearerAuth

Query parameters

allbooleanOptional

Get all items without pagination

searchstringOptional

Search term for filtering items

per_pageintegerOptional

Number of items per page (default: 15)

pageintegerOptional

Page number

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: items

401

Unauthenticated

get

/api/SmsUsers/lookuphis

HTTPcURLJavaScriptPython

GET /api/SmsUsers/lookuphis HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "items",
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "number": "text",
      "live_status": "text",
      "country": "text",
      "telephone_number_type": "text",
      "network": "text",
      "roaming": "text",
      "currentDate": "2026-03-21T19:38:08.759Z"
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  }
}

Lookup phone numbers

get

Lookup details for a list of phone numbers

Authorizations

bearerAuth

Query parameters

numbersstringRequired

Comma-separated list of phone numbers to lookup (max 250)

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: response

401

Unauthenticated

422

Validation error

application/json

get

/api/SmsUsers/lookup

HTTPcURLJavaScriptPython

GET /api/SmsUsers/lookup?numbers=text HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "response",
  "data": [
    {
      "number": "text",
      "live_status": "text",
      "country": "text",
      "telephone_number_type": "text",
      "network": "text",
      "roaming": "text",
      "currentDate": "2026-03-21T19:38:08.759Z"
    }
  ]
}

Lookup numbers from Excel file

post

Upload an Excel file with numbers and perform HLR lookup

Authorizations

bearerAuth

Body

multipart/form-data

filefile · binaryOptional

Excel file containing numbers (xlsx or xls)

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: response

422

Validation error

application/json

post

/api/SmsUsers/lookup-from-excel

HTTPcURLJavaScriptPython

POST /api/SmsUsers/lookup-from-excel HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 13

{
  "file": null
}

{
  "success": true,
  "message": "response",
  "data": [
    {
      "number": "text",
      "live_status": "text",
      "country": "text",
      "telephone_number_type": "text",
      "currentDate": "2026-03-21T19:38:08.759Z",
      "user_id": 1
    }
  ]
}