v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Requests

Search Results

post/search_results

Request body

collection_uuidstring

countrystring

is_portedstring

is_roamingstring

job_idsstring[]

keystring

key_containsstring

key_startstring

keysstring[]

limitstring

number_typestring

portal_idstring

request_typestring

resultstring

search_datestring

search_fromstring

search_tillstring

skipstring

user_tokensstring

validstring

with_totalsnumber

Example request

{
  "collection_uuid": "<string>",
  "country": "<string>",
  "is_ported": "<boolean>",
  "is_roaming": "<boolean>",
  "job_ids": [
    "<string>",
    "<string>"
  ],
  "key": "<string>",
  "key_contains": "<string>",
  "key_start": "<string>",
  "keys": [
    "<string>",
    "<string>"
  ],
  "limit": "<integer>",
  "number_type": "<string>",
  "portal_id": "<integer>",
  "request_type": "<integer>",
  "result": "<string>",
  "search_date": "<string>",
  "search_from": "<string>",
  "search_till": "<string>",
  "skip": "<integer>",
  "user_tokens": "<string>",
  "valid": "<boolean>"
}

Response

Successful Response

invalidstring

mobilestring

totalstring

uniquestring

Example response

{
  "invalid": "<integer>",
  "mobile": "<integer>",
  "results": [
    {
      "extended": {},
      "hlr": {
        "country_name": "<string>",
        "description": "<string>",
        "hlr_status": "<string>",
        "is_ported": "<boolean>",
        "is_roaming": "<boolean>",
        "mcc": "<string>",
        "mnc": "<string>",
        "network_name": "<string>"
      },
      "meta": {},
      "portal_id": "<integer>",
      "request_key": "<string>",
      "request_time": "<dateTime>",
      "request_type": "<string>",
      "request_uuid": "<string>",
      "validation": {
        "corrections": [
          {
            "country_iso2": "<string>",
            "e164": "<string>",
            "number_type": "<string>"
          },
          {
            "country_iso2": "<string>",
            "e164": "<string>",
            "number_type": "<string>"
          }
        ],
        "country_code": "<string>",
        "country_iso2": "<string>",
        "dnc": "<boolean>",
        "dno": "<string>",
        "dno_description": "<string>",
        "e164": "<string>",
        "international": "<string>",
        "lerg": {},
        "lrn": "<string>",
        "mobile": "<boolean>",
        "national": "<string>",
        "number_type": "<string>",
        "possible": "<boolean>",
        "reason": "<string>",
        "valid": "<boolean>"
      }
    },
    {
      "extended": {},
      "hlr": {
        "country_name": "<string>",
        "description": "<string>",
        "hlr_status": "<string>",
        "is_ported": "<boolean>",
        "is_roaming": "<boolean>",
        "mcc": "<string>",
        "mnc": "<string>",
        "network_name": "<string>"
      },
      "meta": {},
      "portal_id": "<integer>",
      "request_key": "<string>",
      "request_time": "<dateTime>",
      "request_type": "<string>",
      "request_uuid": "<string>",
      "validation": {
        "corrections": [
          {
            "country_iso2": "<string>",
            "e164": "<string>",
            "number_type": "<string>"
          },
          {
            "country_iso2": "<string>",
            "e164": "<string>",
            "number_type": "<string>"
          }
        ],
        "country_code": "<string>",
        "country_iso2": "<string>",
        "dnc": "<boolean>",
        "dno": "<string>",
        "dno_description": "<string>",
        "e164": "<string>",
        "international": "<string>",
        "lerg": {},
        "lrn": "<string>",
        "mobile": "<boolean>",
        "national": "<string>",
        "number_type": "<string>",
        "possible": "<boolean>",
        "reason": "<string>",
        "valid": "<boolean>"
      }
    }
  ],
  "total": "<integer>",
  "unique": "<integer>"
}