Kom i gang

Den globale mobilnettverksinfrastrukturen opererer på et system kjent som SS7-signalnettverk. Dette nettverket legger til rette for utveksling av abonnentdata, samtalerutning, SMS-overføring og sanntidsoppdateringer av mobilkonnektivitetsstatus mellom operatører. Hvert mobilnettverk vedlikeholder et Home Location Register (HLR) - en sentral database som lagrer essensielle detaljer om abonnentene.

HLR Lookup-teknologi gjør det mulig for bedrifter å søke i disse registrene og hente live konnektivitets- og nettverksdetaljer for ethvert mobilnummer. Dette inkluderer om telefonen er påslått, hvilket nettverk den for øyeblikket er tilknyttet, om den har blitt portert, om nummeret er gyldig eller deaktivert, og om den er i roaming.

HLR Lookups API gir sømløs sanntidstilgang til disse dataene, slik at bedrifter kan verifisere mobilnumre, optimalisere rutning og forbedre kundekommunikasjon. Denne dokumentasjonen vil veilede deg gjennom integreringen av HLR Lookups i programvaren din, og muliggjøre automatisert henting av sanntids mobilintelligens.

Bruk av HLR Lookups API

Utføring av HLR Lookup-spørringer er raskt, sikkert og enkelt. Når du har registrert deg og fått din API-nøkkel, kan du autentisere og starte øyeblikkelige oppslag med enkle HTTP POST-forespørsler, via POST /hlr-lookup. Alternativt kan du behandle store datasett ved å velge raske asynkrone API-forespørsler med resultater som sendes tilbake til serveren din via webhook, som forklart i konsepter-seksjonen.

Eksempelforespørsel

curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookup' \
          -H "X-Digest-Key: YOUR_API_KEY" \
          -H "X-Digest-Signature: DIGEST_AUTH_SIGNATURE" \
          -H "X-Digest-Timestamp: UNIX_TIMESTAMP" \
          -d "@payload.json"

Autentisering leveres via HTTP-headere, og payload.json bør (som et minimum) inneholde følgende JSON-objekt:

Eksempel på nyttelast

{
   "msisdn": "+14156226819"
}

Ved vellykket utførelse vil du motta et svar som inneholder sanntids konnektivitetsdetaljer for det angitte mobilnummeret.

Vellykket respons application/json

{
   "id":"f94ef092cb53",
   "msisdn":"+14156226819",
   "connectivity_status":"CONNECTED",
   "mccmnc":"310260",
   "mcc":"310",
   "mnc":"260",
   "imsi":"***************",
   "msin":"**********",
   "msc":"************",
   "original_network_name":"Verizon Wireless",
   "original_country_name":"United States",
   "original_country_code":"US",
   "original_country_prefix":"+1",
   "is_ported":true,
   "ported_network_name":"T-Mobile US",
   "ported_country_name":"United States",
   "ported_country_code":"US",
   "ported_country_prefix":"+1",
   "is_roaming":false,
   "roaming_network_name":null,
   "roaming_country_name":null,
   "roaming_country_code":null,
   "roaming_country_prefix":null,
   "cost":"0.0100",
   "timestamp":"2020-08-07 19:16:17.676+0300",
   "storage":"SYNC-API-2020-08",
   "route":"IP1",
   "processing_status":"COMPLETED",
   "error_code":null,
   "error_description":null,
   "data_source":"LIVE_HLR",
   "routing_instruction":"STATIC:IP1"
}

For en fullstendig oversikt over forespørsels- og responsattributter og konnektivitetsstatuser, se POST /hlr-lookup.

Tilleggstjenester for oppslag

Nummerbærbarhet (MNP) oppslag

Bruk MNP-oppslag for å fastslå nettverkseierskap og bærbarhetsinformasjon uten å søke i sanntidskonnektivitet. Hvis du bare trenger MCCMNC for et nummer, se POST /mnp-lookup.

Nummertype-deteksjon (NT) oppslag

Fastslå om et telefonnummer tilhører fasttelefon, mobil, premium-tjeneste, VoIP, personsøker eller andre nummerplanområder med POST /nt-lookup.

Programvareutviklingssett (SDK-er)

HLR Lookups API fungerer med alle REST-klienter i alle programmeringsspråk, og vi har publisert SDK-er for PHP, Ruby og NodeJS på vår GitHub for å hjelpe deg raskt i gang.

Verktøy

For å sikre en sømløs utviklingsopplevelse tilbyr vi en omfattende verktøypakke, inkludert API-forespørsel og webhook-overvåking i nettleseren, hvitelisting av IP-adresser, robuste autentiseringsalternativer og et autentiseringstestendepunkt.

Ikke utvikler?

HLR Lookups og nummerbærbarhetsspørringer kan utføres uten programmering. Les mer om vår bedriftsklient for nettleser og nettleserbaserte rapporteringsfunksjoner.

Autentisering

For å sikre trygghet og korrekt tilgangskontroll krever de fleste forespørsler til HLR Lookups API autentisering. Endepunkter er kategorisert som enten offentlige eller beskyttede. Ved tilgang til et beskyttet endepunkt må forespørselen autentiseres med API-nøkkel og hemmelighet via enten Digest-Auth eller Basic-Auth metode. Digest-Auth er det sikreste alternativet og anbefales sterkt. Bruk GET /auth-test endepunktet for å verifisere autentiseringsoppsettet ditt.

API-nøkkel og API-hemmelighet

Hent API-nøkkel og hemmelighet fra API-innstillinger siden. Du kan også konfigurere foretrukket autentiseringsmetode og aktivere IP-adresse hvitelisting for økt sikkerhet. Hvis du mistenker at API-hemmeligheten din er kompromittert, kan du når som helst generere en ny.

Basic Auth Digest Auth IP-hvitelisting

Standard Basic Authentication er enkelt å implementere og bredt støttet. Du kan autentisere ved å sende API-nøkkel og hemmelighet som et user:pass par i HTTP-forespørselen.

HTTP Basic Auth

curl 'https://YOUR_API_KEY:YOUR_API_SECRET@www.hlr-lookups.com/api/v2/auth-test'

Dette sender en Authorization header:

Authorization: Basic BASE64(YOUR_API_KEY:YOUR_API_SECRET)

Anbefalt: X-Basic Header med SHA256

For forbedret sikkerhet kan du sende en SHA256-hash av påloggingsinformasjonen i stedet for å overføre den direkte som base64. For å bruke denne metoden, beregn hashen av YOUR_API_KEY:YOUR_API_SECRET paret og send det via X-Basic headeren:

Basic Auth forespørsel

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Basic: BASIC_AUTH_HASH"

Basic Authentication headere

Nøkkel	Type	Beskrivelse
`X-Basic`	string	SHA256-hash av `YOUR_API_KEY:YOUR_API_SECRET`. Inkluder kolonsymbolet (:) i hashen.	obligatorisk

Kodeeksempel

$key = 'YOUR_API_KEY';
$secret = 'YOUR_API_SECRET';

$basicAuthHash = hash('sha256', $key . ':' . $secret);

Digest-Auth er den anbefalte metoden for å sikre tilgang til beskyttede HLR Lookup API-endepunkter. Hver forespørsel må inkludere følgende headere: X-Digest-Key, X-Digest-Signature og X-Digest-Timestamp, som forklares nedenfor.

Forespørselseksempel

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Digest-Key: YOUR_API_KEY" \
  -H "X-Digest-Signature: DIGEST_AUTH_SIGNATURE" \
  -H "X-Digest-Timestamp: UNIX_TIMESTAMP"

Forespørselsheadere

Nøkkel	Type	Beskrivelse
`X-Digest-Key`	string	Din unike HLR Lookups API-nøkkel.	obligatorisk
`X-Digest-Signature`	string	En unik autentiseringssignatur (se nedenfor).	obligatorisk
`X-Digest-Timestamp`	integer	Gjeldende Unix-tidsstempel (se også `GET /time`).	obligatorisk

Konstruere signaturen

X-Digest-Signature opprettes ved hjelp av en SHA256 HMAC-hash, med API-hemmeligheten din som delt nøkkel.

Strengen som skal hashes er strukturert som følger:

ENDPOINT_PATH . UNIX_TIMESTAMP . REQUEST_METHOD . REQUEST_BODY

. symbolet representerer strengsammenkobling.

Digest signaturkomponenter

Komponent	Type	Beskrivelse
`ENDPOINT_PATH`	string	Det forespurte API-endepunktet, f.eks. `/auth-test` i små bokstaver.
`UNIX_TIMESTAMP`	integer	Gjeldende Unix-tidsstempel (må være innenfor 30 sekunder). Se `GET /time`.
`REQUEST_METHOD`	string	HTTP-metoden som brukes, f.eks. `POST` eller `GET`.
`REQUEST_BODY`	string	Forespørselens body-data. Sett til `null` for `GET` forespørsler.

Kodeeksempler

PHP

NodeJS

Ruby

$path = '/auth-test'
    $timestamp = time();
    $method = 'GET';
    $body = $method == 'GET' ? null : json_encode($params);
    $secret = 'YOUR_API_SECRET';

    $signature = hash_hmac('sha256', $path . $timestamp . $method . $body, $secret);

require('crypto');

    let path = '/auth-test'
    let timestamp = Date.now() / 1000 | 0;
    let method = 'GET'
    let body = method === 'GET' ? '' : JSON.stringify(params)
    let secret = 'YOUR_API_SECRET'

    let signature = crypto.createHmac('sha256', secret)
                    .update(path + timestamp + method + body)
                    .digest('hex');

require 'openssl'

path = '/auth-test'
timestamp = Time.now.to_i
method = 'GET'
body = method == 'GET' ? NIL : params.to_json
secret = 'YOUR_API_SECRET'

signature = OpenSSL::HMAC.hexdigest('sha256', secret, path + timestamp.to_s + method + body.to_s)

Rull opp

Konsepter

Implementering av HLR-oppslag i ethvert programmeringsspråk eller system via vårt HTTP REST API er enkelt og effektivt. Med en enkel integrasjonsprosess kan du begynne å forespørre mobilnettverk i sanntid for umiddelbar innsikt i telefonnummergyldighet, tilkoblingsstatus og rutingdetaljer.

Valg av riktig API avhenger av ditt spesifikke bruksområde. Hvis du trenger sanntidsresultater for applikasjoner som VoIP-telefoni, svindeldeteksjon eller SMS-ruting, er synkront API det beste valget. Hvis ditt bruksområde derimot involverer høyvolumbehandling, masseoppslag eller storskala datavalidering, tilbyr asynkront API optimalisert ytelse med båndbreddeeffektivitet og batch-oppslagsfunksjonalitet.

Konfigurer API-et til å bruke ett av våre tilpassede rutingsalternativer for å optimalisere hastighet, nøyaktighet og kostnadseffektivitet. Du kan også lagre oppslagsresultater i lagringsområder for enkel nedlasting av CSV- og JSON-rapporter, samt avansert analyse via webgrensesnittet.

Synkront HLR-oppslags-API

POST /hlr-lookup-endepunktet behandler ett mobiltelefonnummer (MSISDN) per forespørsel og returnerer resultater umiddelbart i HTTP-responskroppen. Resultatene er formatert som JSON og er ideelle for sanntidsapplikasjoner, inkludert mobilnummervalidering, anropsruting og SMS-meldingslevering.

Et synkront API-kall består av en direkte HTTP-forespørsel og -respons. Systemet ditt sender inn ett enkelt MSISDN (mobilnummer) per forespørsel og mottar en umiddelbar respons som inneholder sanntids HLR-oppslagsresultater i JSON-format. Dette API-et er optimalisert for bruksområder som krever umiddelbar verifisering og tilkoblingssjekker, som svindeldeteksjon, VoIP-anropsruting og SMS-gateway-optimalisering.

Asynkront HLR-oppslag API

POST /hlr-lookups-endepunktet er designet for masse- og høyvolumbehandling, og lar deg sende inn opptil 1,000 MSISDN-er per forespørsel. I stedet for å returnere resultater umiddelbart, bruker dette API-et automatiserte webhooks for å sende resultater progressivt til serveren din. Oppslagsresultater returneres som JSON-objekter via HTTP POST-tilbakekall.

Det asynkrone API-et er optimalisert for hastighet, effektivitet og skalerbarhet. Det eliminerer nettverksforsinkelsesproblemer forbundet med synkrone kall, noe som gjør det ideelt for virksomheter som trenger høykapasitetsoppslag. Systemet ditt sender inn opptil 1,000 MSISDN-er per forespørsel, og plattformen vår behandler dem parallelt og leverer resultater tilbake til serveren din via HTTP-webhooks i batcher på opptil 1,000 resultater per tilbakekall.

SDK-er (Software Development Kits)

Våre Software Development Kits (SDK-er) for PHP, NodeJS og Ruby forenkler integrasjonsprosessen, og gjør det mulig å koble til HLR Lookups API effektivt og med minimal innsats.

Disse SDK-ene tilbyr ferdigbygde funksjoner, autentiseringshåndtering og strukturerte API-forespørselsmaler, noe som reduserer utviklingstiden og sikrer beste praksis.

Utforsk vår komplette liste over tilgjengelige SDK-er på GitHub og start integreringen i dag.

PHP

NodeJS

Ruby

1   include('HLRLookupClient.class.php');
2
3   $client = new HLRLookupClient(
4       'YOUR-API-KEY',
5       'YOUR-API-SECRET',
6       '/var/log/hlr-lookups.log'
7   );
8
9   $params = array('msisdn' => '+14156226819');
10  $response = $client->post('/hlr-lookup', $params);

Se på GitHub README.md

1   require('node-hlr-client');
2
3   let response = await client.post('/hlr-lookup', {msisdn: '+491788735000'});
4
5   if (response.status === 200) {
6      // lookup was successful
7      let data = response.data;
8   }

Se på GitHub README.md

1   require 'ruby_hlr_client/client'
2
3   client = HlrLookupsSDK::Client.new(
4       'YOUR-API-KEY',
5       'YOUR-API-SECRET',
6       '/var/log/hlr-lookups.log'
7   )
8
9   params = { :msisdn => '+14156226819' }
10  response = client.get('/hlr-lookup', params)

Se på GitHub README.md

Rull opp

POST/hlr-lookupbeskyttet

Utfører et synkront HLR-oppslag som leverer sanntidsdata om mobiltelefontilkobling og porterbarhet direkte fra nettverksoperatører. Dette endepunktet er ideelt for direktetrafikk-scenarier hvor tidskritiske applikasjoner krever umiddelbar verifisering av om et telefonnummer er tilgjengelig (tilkoblet) eller utilgjengelig (avslått). I tillegg hjelper det med å skille aktive numre fra ugyldige, ukjente eller falske.

For bulkbehandling av store datasett som ikke krever umiddelbare resultater, bør du vurdere å bruke det asynkrone POST /hlr-lookups, som er optimalisert for høyhastighets batch-prosessering.

Hvis ditt primære fokus er å hente data om mobilnummerportering (MCCMNC) og du ikke trenger sanntidsstatus for tilkobling, tilbyr POST /mnp-lookup et kostnadseffektivt alternativ for spørringer om mobilnummerportering.

Forespørsel Vellykket respons Feilrespons Statusreferanse

curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookup' \
          -d "@payload.json"

Nyttelast

{
   "msisdn":"+14156226819",
   "route":null,
   "storage":null
}

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`msisdn`	string	Mobiltelefonnummeret (MSISDN) som skal søkes opp, oppgitt i internasjonalt format (f.eks. +14156226819 eller 0014156226819). Landkoder må inkluderes.	null	obligatorisk
`route`	string(3)	En valgfri tre-tegns identifikator som spesifiserer ruten for dette oppslaget. Sett til `null` eller utelat denne parameteren for å anvende ditt tilpassede rutekart eller la systemet vårt automatisk bestemme den beste ruten for dette oppslaget.	null	valgfritt
`storage`	string	En valgfri lagringsidentifikator som spesifiserer rapporten hvor resultater vil lagres for manuell gjennomgang, analyse og rapportering. Systemet legger automatisk til et tidsstempel med gjeldende måned. Hvis utelatt eller satt til `null`, vil systemet automatisk gruppere resultater etter måned for rapporteringsformål.	null	valgfritt

{
   "id":"f94ef092cb53",
   "msisdn":"+14156226819",
   "connectivity_status":"CONNECTED",
   "mccmnc":"310260",
   "mcc":"310",
   "mnc":"260",
   "imsi":"***************",
   "msin":"**********",
   "msc":"************",
   "original_network_name":"Verizon Wireless",
   "original_country_name":"United States",
   "original_country_code":"US",
   "original_country_prefix":"+1",
   "is_ported":true,
   "ported_network_name":"T-Mobile US",
   "ported_country_name":"United States",
   "ported_country_code":"US",
   "ported_country_prefix":"+1",
   "is_roaming":false,
   "roaming_network_name":null,
   "roaming_country_name":null,
   "roaming_country_code":null,
   "roaming_country_prefix":null,
   "cost":"0.0100",
   "timestamp":"2020-08-07 19:16:17.676+0300",
   "storage":"SYNC-API-2020-08",
   "route":"IP1",
   "processing_status":"COMPLETED",
   "error_code":null,
   "error_description":null,
   "data_source":"LIVE_HLR",
   "routing_instruction":"STATIC:IP1"
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`id`	string(12)	En unik identifikator tildelt denne oppslags-forespørselen.	false
`msisdn`	string	Mobiltelefonnummeret som spørres, formatert i internasjonalt format (f.eks. +14156226819 eller 0014156226819).	false
`connectivity_status`	string	Angir om tilkoblingsstatus for nummeret ble hentet. Mulige verdier: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` eller `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	En fem- eller sekssifret Mobile Country Code (MCC) og Mobile Network Code (MNC) som identifiserer nettverket som for øyeblikket er tilknyttet telefonnummeret.	true
`mcc`	string(3)	En tresifret Mobile Country Code (MCC) som identifiserer landet der telefonnummeret er registrert.	true
`mnc`	string(2\|3)	En to- eller tresifret Mobile Network Code (MNC) som identifiserer det spesifikke nettverket telefonnummeret tilhører.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), en unik identifikator for SIM-kortet tilknyttet dette nummeret. Tilgjengelighet avhenger av nettverkskonfigurasjon.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) i mobiloperatørens database. Tilgjengelighet avhenger av nettverkskonfigurasjon.	true
`msc`	string(12)	Mobile Switching Center (MSC) som for øyeblikket håndterer denne abonnentens kommunikasjon. Tilgjengelighet avhenger av nettverkskonfigurasjon.	true
`original_network_name`	string	Den opprinnelige (native) nettverksoperatørens navn tilknyttet dette nummeret.	true
`original_country_name`	string	Det fulle navnet på landet der mobiltelefonnummeret opprinnelig ble registrert, oppgitt på engelsk.	true
`original_country_code`	string(2)	Den to-tegns ISO-landkoden som representerer landet der telefonnummeret først ble tildelt.	true
`original_country_prefix`	string	Den internasjonale retningskoden (landets retningsnummer) som tilsvarer det opprinnelige landet for mobiltelefonnummeret.	true
`is_ported`	boolean	Angir om mobilnummeret har blitt portert fra sitt opprinnelige nettverk til en annen operatør.	true
`ported_network_name`	string	Navnet på nettverksoperatøren som mobilnummeret har blitt portert til, hvis aktuelt.	true
`ported_country_name`	string	Navnet på landet mobilnummeret ble portert til, hvis aktuelt.	true
`ported_country_code`	string(2)	Den to-tegns ISO-landkoden som representerer landet mobilnummeret ble portert til, hvis aktuelt.	true
`ported_country_prefix`	string	Den internasjonale retningskoden (landets retningsnummer) for landet mobilnummeret ble portert til, hvis aktuelt.	true
`is_roaming`	boolean	Angir om mobilnummeret for øyeblikket roamer på et utenlandsk nettverk. Tilgjengelighet av roamingstatus avhenger av mobilnettverksoperatøren.	true
`roaming_network_name`	string	Navnet på nettverket mobilnummeret for øyeblikket roamer på, hvis aktuelt.	true
`roaming_country_name`	string	Navnet på landet der mobilnummeret for øyeblikket roamer, hvis aktuelt.	true
`roaming_country_code`	string(2)	Den to-tegns ISO-landkoden for landet der mobilnummeret for øyeblikket roamer, hvis aktuelt.	true
`roaming_country_prefix`	string	Den internasjonale retningskoden (landets retningsnummer) for landet der mobilnummeret for øyeblikket roamer, hvis aktuelt.	true
`cost`	string	En desimalverdi representert som en streng, som angir oppslags-kostnaden i EUR.	true
`timestamp`	string	Et W3C-formatert tidsstempel inkludert tidssone, som spesifiserer når oppslaget ble fullført.	true
`storage`	string	Navnet på lagringsplassen der oppslags-resultatene ble lagret. Dette tilsvarer rapportnavn og CSV-nedlastinger tilgjengelig via webgrensesnittet.	true
`route`	string(3)	En tre-tegns identifikator som angir rutingsmetoden brukt for denne oppslags-forespørselen.	true
`processing_status`	string	Behandlingsresultatet for oppslaget. Mulige verdier: `COMPLETED` (vellykket), `REJECTED` (nettverk utilgjengelig, ingen kostnad påløpt) eller `FAILED` (feil oppstod under behandling).	false
`error_code`	integer	En valgfri intern feilkode som gir ytterligere diagnostikkinformasjon for kundesupport.	true
`error_description`	string	En kort forklaring av den angitte feilkoden (hvis aktuelt) i klartekst på engelsk.	true
`data_source`	string	Datakilden brukt for denne forespørselen. Mulige verdier: `LIVE_HLR` (sanntids HLR-spørring) eller `MNP_DB` (statisk database for mobilnummerportabilitet). Se rutingsalternativer for detaljer.	false
`routing_instruction`	string	En kolon-delt streng som beskriver rutingsinstruksjonen brukt i forespørselen. Den første komponenten er `STATIC` når du spesifiserte en rute eller `AUTO` for automatisk ruting; den andre komponenten er ruteidentifikatoren, og for automatiske rutingsforespørsler viser en tredje komponent opprinnelsen som rutingsbeslutningen er basert på (dvs. `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`).	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Status	Beskrivelse
CONNECTED	Nummeret er gyldig, og målenheten er for øyeblikket tilkoblet mobilnettet. Anrop, SMS og andre tjenester skal nå mottakeren uten problemer.
ABSENT	Nummeret er gyldig, men målenheten er enten slått av eller midlertidig utenfor nettverksdekning. Meldinger eller anrop vil muligens ikke bli levert før enheten kobles til nettet igjen.
INVALID_MSISDN	Nummeret er ugyldig eller ikke tildelt noen abonnent på mobilnettet. Anrop og meldinger til dette nummeret vil mislykkes.
UNDETERMINED	Tilkoblingsstatusen for nummeret kunne ikke fastslås. Dette kan skyldes et ugyldig nummer, SS7-feilrespons eller manglende tilkobling til målnettverksoperatøren. Undersøk feilkoden og beskrivelsesfeltet for ytterligere diagnostikk.

Rull opp

POST/hlr-lookupsbeskyttet

Starter en batch med asynkrone HLR-oppslag som henter direkte data om mobiltelefonkonnektivitet og porterbarhet fra nettverksoperatører. Resultater leveres via webhooks til din server. Denne metoden er optimalisert for behandling av store volumer med numre som ikke krever umiddelbare svar, for eksempel databaserensing og verifisering. For sanntidsapplikasjoner som samtalerutning eller SMS-levering bør du vurdere å bruke POST /hlr-lookup-endepunktet i stedet.

Dette endepunktet er ideelt for bulkbehandling når målet er å identifisere telefonnumre som for øyeblikket er tilgjengelige (tilkoblet) eller utilgjengelige (telefon slått av), samtidig som ugyldige, ikke-tildelte eller falske numre filtreres bort. I tillegg gir det direkte porterbarhetsstatus (MCCMNC) sammen med konnektivitetsdetaljer.

Før du bruker dette endepunktet, må du sørge for at en webhook-URL er konfigurert for å motta oppslagsresultater asynkront. Du kan konfigurere dette i dine API-innstillinger.

Forespørsel Vellykket respons Feilrespons Webhooks Statusreferanse

curl -X POST 'https://www.hlr-lookups.com/api/v2/hlr-lookups' \
          -d "@payload.json"

Nyttelast

{
   "msisdns":["+14156226819","+491788735000","+905536939460"],
   "route":null,
   "storage":null
}

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`msisdns`	array	En liste med mobiltelefonnumre (MSISDN-er) i internasjonalt format (f.eks. +14156226819 eller 0014156226819). Du kan inkludere opptil 1000 numre per forespørsel.	null	obligatorisk
`route`	string(3)	En valgfri tre-tegns identifikator som spesifiserer ruten for dette oppslaget. Sett til `null` eller utelat denne parameteren for å anvende ditt tilpassede rutekart eller la systemet vårt automatisk bestemme den beste ruten for dette oppslaget.	null	valgfritt
`storage`	string	En valgfri lagringsidentifikator som spesifiserer rapporten hvor resultater vil lagres for manuell gjennomgang, analyse og rapportering. Systemet legger automatisk til et tidsstempel med gjeldende måned. Hvis utelatt eller satt til `null`, vil systemet automatisk gruppere resultater etter måned for rapporteringsformål.	null	valgfritt

{
   "accepted":[
      {
         "id":"0424928f332e",
         "msisdn":"+491788735000"
      }
   ],
   "accepted_count":1,
   "rejected":[
      {
         "id":null,
         "msisdn":"+31"
      }
   ],
   "rejected_count":1,
   "total_count":2,
   "cost":"0.01",
   "storage":"ASYNC-API-2020-08",
   "route":"IP1",
   "webhook_urls":[
      "https://your-server.com/endpoint"
   ]
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`accepted`	array	En liste med objekter som inneholder unike identifikatorer og MSISDN-er som er akseptert for behandling.	false
`accepted_count`	integer	Det totale antallet MSISDN-er som er akseptert for behandling.	false
`rejected`	array	En liste med objekter som inneholder unike identifikatorer og MSISDN-er som er avvist for behandling, vanligvis på grunn av ugyldige numre. Ingen kostnad påløper for avviste oppføringer.	false
`rejected_count`	integer	Det totale antallet MSISDN-er avvist på grunn av valideringsfeil.	false
`total_count`	integer	Det totale antallet aksepterte og avviste MSISDN-er som ble sendt inn for behandling.	false
`cost`	string	En desimalverdi representert som en streng som angir den totale kostnaden i EUR for de aksepterte oppslagene.	false
`storage`	string	Navnet på lagringsstedet hvor oppslagsresultatene legges til, brukt for rapportering og CSV-nedlastinger via webgrensesnittet.	false
`route`	string(3\|4)	En tre- eller firetegns identifikator som spesifiserer ruten som brukes for denne oppslagsforespørselen. Inneholder AUTO hvis nummerbasert automatisk ruting ble forespurt.	false
`webhook_urls`	array	Webhook-URL-ene konfigurert i dine API-innstillinger. Resultater sendes tilbake hit.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Behandling av webhooks

Når forespørselen er sendt, begynner plattformen vår å behandle de oppgitte telefonnumrene og sender resultatene til den tidligere angitte webhook-URL-en på serveren din. Resultatene overføres som en HTTP POST-forespørsel med et JSON-objekt i forespørselskroppen.

Autentisering

Autentiser webhooken ved å inspisere HTTP-headeren X-Signatures.

Headeren X-Signatures inneholder en semikolonseparert liste med signaturer. Hver signatur i listen genereres ved hjelp av en av API-hemmelighetene som er konfigurert i kontoen din. For å verifisere webhooken genererer du en SHA-256-hash ved hjelp av API-nøkkelen din, hemmeligheten og den rå HTTP-kroppen - deretter sammenligner du den med signaturene i listen.

Et treff bekrefter at forespørselen er autentisk og signert med en hemmelighet du kontrollerer.

Kodeeksempel

$signaturesHeader = (getallheaders() ?? [])['X-Signatures'] ?? ''; // list of signatures
$key = getenv('AUTH_KEY'); // Your API Key
$secret = getenv('AUTH_SECRET'); // Your API Secret
$payload = file_get_contents('php://input'); // The HTTP body of the incoming POST request

// Generate the expected signature
$expectedSignature = hash('sha256', $key . $secret . $payload);

// Split the header into individual signatures
$providedSignatures = explode(';', $signaturesHeader);

// Check if any signature matches
$valid = false;
foreach ($providedSignatures as $sig) {
    if (hash_equals($expectedSignature, $sig)) {
        $valid = true;
        break;
    }
}

Forespørselen er gyldig hvis noen av signaturene i headeren er lik en SHA256-hash beregnet over den sammenslåtte strengen av API-nøkkelen din, hemmeligheten og HTTP-kroppen.

Bekreftelse av mottak

Serveren din forventes å svare med HTTP-statuskode 200 OK for å bekrefte vellykket mottak. Hvis en annen responskode returneres, det oppstår en timeout (10 sekunder), eller andre leveringsproblemer oppstår, vil systemet automatisk forsøke webhooken på nytt etter ett minutt. Hvis forespørselen fortsetter å feile, vil nye forsøk følge en eksponentiell backoff-strategi, med påfølgende forsøk etter 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minutter.

Denne gjentakelsesmekanismen sikrer maksimal pålitelighet ved levering av oppslag-resultater til infrastrukturen din. Den minimerer risikoen for datatap på grunn av midlertidige nettverksproblemer eller nedetid på serveren.

Webhook-payload

{
   "type":"HLR",
   "results":[
      {
         "id":"3b4ac4b6ed1b",
         "msisdn":"+905536939460",
         "connectivity_status":"CONNECTED",
         "mccmnc":"28603",
         "mcc":"286",
         "mnc":"03",
         "imsi":"28603XXXXXXXXXX",
         "msin":"XXXXXXXXXX",
         "msc":"XXXXXXXXXX",
         "original_network_name":"Turk Telekom (AVEA)",
         "original_country_name":"Turkey",
         "original_country_code":"TR",
         "original_country_prefix":"+90",
         "is_ported":false,
         "ported_network_name":null,
         "ported_country_name":null,
         "ported_country_code":null,
         "ported_country_prefix":null,
         "is_roaming":false,
         "roaming_network_name":null,
         "roaming_country_name":null,
         "roaming_country_code":null,
         "roaming_country_prefix":null,
         "cost":"0.0100",
         "timestamp":"2020-08-13 00:04:38.261+0300",
         "storage":"ASYNC-API-2020-08",
         "route":"IP1",
         "processing_status":"COMPLETED",
         "error_code":null,
         "error_description":null,
         "data_source":"LIVE_HLR",
         "routing_instruction":"STATIC:IP1"
      }
   ]
}

Webhook-nyttelastattributter

JSON-objektet inneholder et attributt type => HLR sammen med et attributt results som inkluderer en liste med oppslagsobjekter, som dokumentert nedenfor.

Navn	Type	Beskrivelse	Kan være null
`id`	string(12)	En unik identifikator tildelt denne oppslags-forespørselen.	false
`msisdn`	string	Mobiltelefonnummeret som spørres, formatert i internasjonalt format (f.eks. +14156226819 eller 0014156226819).	false
`connectivity_status`	string	Angir om tilkoblingsstatus for nummeret ble hentet. Mulige verdier: `CONNECTED` , `ABSENT` , `INVALID_MSISDN` eller `UNDETERMINED` .	false
`mccmnc`	string(5\|6)	En fem- eller sekssifret Mobile Country Code (MCC) og Mobile Network Code (MNC) som identifiserer nettverket som for øyeblikket er tilknyttet telefonnummeret.	true
`mcc`	string(3)	En tresifret Mobile Country Code (MCC) som identifiserer landet der telefonnummeret er registrert.	true
`mnc`	string(2\|3)	En to- eller tresifret Mobile Network Code (MNC) som identifiserer det spesifikke nettverket telefonnummeret tilhører.	true
`imsi`	string	International Mobile Subscriber Identity (IMSI), en unik identifikator for SIM-kortet tilknyttet dette nummeret. Tilgjengelighet avhenger av nettverkskonfigurasjon.	true
`msin`	string(10)	Mobile Subscription Identification Number (MSIN) i mobiloperatørens database. Tilgjengelighet avhenger av nettverkskonfigurasjon.	true
`msc`	string(12)	Mobile Switching Center (MSC) som for øyeblikket håndterer denne abonnentens kommunikasjon. Tilgjengelighet avhenger av nettverkskonfigurasjon.	true
`original_network_name`	string	Den opprinnelige (native) nettverksoperatørens navn tilknyttet dette nummeret.	true
`original_country_name`	string	Det fulle navnet på landet der mobiltelefonnummeret opprinnelig ble registrert, oppgitt på engelsk.	true
`original_country_code`	string(2)	Den to-tegns ISO-landkoden som representerer landet der telefonnummeret først ble tildelt.	true
`original_country_prefix`	string	Den internasjonale retningskoden (landets retningsnummer) som tilsvarer det opprinnelige landet for mobiltelefonnummeret.	true
`is_ported`	boolean	Angir om mobilnummeret har blitt portert fra sitt opprinnelige nettverk til en annen operatør.	true
`ported_network_name`	string	Navnet på nettverksoperatøren som mobilnummeret har blitt portert til, hvis aktuelt.	true
`ported_country_name`	string	Navnet på landet mobilnummeret ble portert til, hvis aktuelt.	true
`ported_country_code`	string(2)	Den to-tegns ISO-landkoden som representerer landet mobilnummeret ble portert til, hvis aktuelt.	true
`ported_country_prefix`	string	Den internasjonale retningskoden (landets retningsnummer) for landet mobilnummeret ble portert til, hvis aktuelt.	true
`is_roaming`	boolean	Angir om mobilnummeret for øyeblikket roamer på et utenlandsk nettverk. Tilgjengelighet av roamingstatus avhenger av mobilnettverksoperatøren.	true
`roaming_network_name`	string	Navnet på nettverket mobilnummeret for øyeblikket roamer på, hvis aktuelt.	true
`roaming_country_name`	string	Navnet på landet der mobilnummeret for øyeblikket roamer, hvis aktuelt.	true
`roaming_country_code`	string(2)	Den to-tegns ISO-landkoden for landet der mobilnummeret for øyeblikket roamer, hvis aktuelt.	true
`roaming_country_prefix`	string	Den internasjonale retningskoden (landets retningsnummer) for landet der mobilnummeret for øyeblikket roamer, hvis aktuelt.	true
`cost`	string	En desimalverdi representert som en streng, som angir oppslags-kostnaden i EUR.	true
`timestamp`	string	Et W3C-formatert tidsstempel inkludert tidssone, som spesifiserer når oppslaget ble fullført.	true
`storage`	string	Navnet på lagringsplassen der oppslags-resultatene ble lagret. Dette tilsvarer rapportnavn og CSV-nedlastinger tilgjengelig via webgrensesnittet.	true
`route`	string(3)	En tre-tegns identifikator som angir rutingsmetoden brukt for denne oppslags-forespørselen.	true
`processing_status`	string	Behandlingsresultatet for oppslaget. Mulige verdier: `COMPLETED` (vellykket), `REJECTED` (nettverk utilgjengelig, ingen kostnad påløpt) eller `FAILED` (feil oppstod under behandling).	false
`error_code`	integer	En valgfri intern feilkode som gir ytterligere diagnostikkinformasjon for kundesupport.	true
`error_description`	string	En kort forklaring av den angitte feilkoden (hvis aktuelt) i klartekst på engelsk.	true
`data_source`	string	Datakilden brukt for denne forespørselen. Mulige verdier: `LIVE_HLR` (sanntids HLR-spørring) eller `MNP_DB` (statisk database for mobilnummerportabilitet). Se rutingsalternativer for detaljer.	false
`routing_instruction`	string	En kolon-delt streng som beskriver rutingsinstruksjonen brukt i forespørselen. Den første komponenten er `STATIC` når du spesifiserte en rute eller `AUTO` for automatisk ruting; den andre komponenten er ruteidentifikatoren, og for automatiske rutingsforespørsler viser en tredje komponent opprinnelsen som rutingsbeslutningen er basert på (dvs. `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`).	false

Status	Beskrivelse
CONNECTED	Nummeret er gyldig, og målenheten er for øyeblikket tilkoblet mobilnettet. Anrop, SMS og andre tjenester skal nå mottakeren uten problemer.
ABSENT	Nummeret er gyldig, men målenheten er enten slått av eller midlertidig utenfor nettverksdekning. Meldinger eller anrop vil muligens ikke bli levert før enheten kobles til nettet igjen.
INVALID_MSISDN	Nummeret er ugyldig eller ikke tildelt noen abonnent på mobilnettet. Anrop og meldinger til dette nummeret vil mislykkes.
UNDETERMINED	Tilkoblingsstatusen for nummeret kunne ikke fastslås. Dette kan skyldes et ugyldig nummer, SS7-feilrespons eller manglende tilkobling til målnettverksoperatøren. Undersøk feilkoden og beskrivelsesfeltet for ytterligere diagnostikk.

Rull opp

POST/mnp-lookupbeskyttet

Utfører et synkront MNP-oppslag og gir informasjon om nummerportabilitet og nettverk. Dette endepunktet er egnet dersom ditt primære mål er å hente ut gjeldende MCCMNC for et gitt mobilnummer og identifisere opprinnelig og nåværende nettverk i sanntid.

For bulkbehandling av store datasett som ikke krever umiddelbare resultater, bør du vurdere å bruke det asynkrone POST /mnp-lookups, som er optimalisert for høyhastighets batch-prosessering.

MNP-spørringer fastslår pålitelig portabilitet og nettverksinformasjon, men indikerer ikke om mobiltelefonen er tilkoblet et nettverk og kan nås for øyeblikket. For å hente ut live tilkoblingsinformasjon, vennligst bruk POST /hlr-lookup-endepunktet i stedet.

Forespørsel Vellykket respons Feilrespons

curl -X POST 'https://www.hlr-lookups.com/api/v2/mnp-lookup' \
          -d "@payload.json"

Nyttelast

{
   "msisdn":"+14156226819",
   "route":null,
   "storage":null
}

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`msisdn`	string	Mobiltelefonnummeret (MSISDN) som skal søkes opp, oppgitt i internasjonalt format (f.eks. +14156226819 eller 0014156226819). Landkoder må inkluderes.	null	obligatorisk
`route`	string(3)	En valgfri tre-tegns identifikator som spesifiserer ruten for dette oppslaget. Sett til `null` eller utelat denne parameteren for å anvende ditt tilpassede rutekart eller la systemet vårt automatisk bestemme den beste ruten for dette oppslaget.	null	valgfritt
`storage`	string	En valgfri lagringsidentifikator som spesifiserer rapporten hvor resultater vil lagres for manuell gjennomgang, analyse og rapportering. Systemet legger automatisk til et tidsstempel med gjeldende måned. Hvis utelatt eller satt til `null`, vil systemet automatisk gruppere resultater etter måned for rapporteringsformål.	null	valgfritt

{
   "id":"e428acb1c0ae",
   "msisdn":"+14156226819",
   "query_status":"OK",
   "mccmnc":"310260",
   "mcc":"310",
   "mnc":"260",
   "is_ported":true,
   "original_network_name":"Verizon Wireless:6006 - SVR/2",
   "original_country_name":"United States",
   "original_country_code":"US",
   "original_country_prefix":"+1415",
   "ported_network_name":"T-Mobile US:6529 - SVR/2",
   "ported_country_name":"United States",
   "ported_country_code":"US",
   "ported_country_prefix":"+1",
   "extra":"LRN:4154250000",
   "cost":"0.0050",
   "timestamp":"2020-08-05 21:21:33.490+0300",
   "storage":"WEB-CLIENT-SOLO-MNP-2020-08",
   "route":"PTX",
   "error_code":null
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`id`	string(12)	En unik 12-tegns identifikator for dette oppslaget.	false
`msisdn`	string	Mobilnummeret som ble evaluert i denne oppslagsforespørselen.	false
`query_status`	string	Indikerer om henting av portabilitet og nettverksinformasjon var vellykket. Mulige verdier er `OK` eller `FAILED`.	false
`mccmnc`	string(5\|6)	En fem- eller sekstegns MCCMNC (mobillandskode og mobilnettverkskode) som identifiserer nettverket mobilnummeret tilhører.	true
`mcc`	string(3)	En tretegns MCC (mobillandskode) som representerer landet tilknyttet mobilnummerets nåværende nettverk.	true
`mnc`	string(2\|3)	En to- eller tretegns MNC (mobilnettverkskode) som identifiserer nåværende nettverksoperatør for mobilnummeret.	true
`is_ported`	boolean	Indikerer om telefonnummeret har blitt portert fra sitt opprinnelige nettverk til en ny operatør.	true
`original_network_name`	string	En vilkårlig streng (på engelsk) som spesifiserer det opprinnelige nettverksoperatørnavnet til det undersøkte mobilnummeret.	true
`original_country_name`	string	En vilkårlig streng (på engelsk) som indikerer det opprinnelige landet til det undersøkte mobilnummeret.	true
`original_country_code`	string(2)	En totegns ISO-landskode som representerer det opprinnelige landet til det undersøkte mobilnummeret.	true
`original_country_prefix`	string	Retningsnummeret til det opprinnelige landet tilknyttet det undersøkte mobilnummeret.	true
`ported_network_name`	string	Spesifiserer nettverksoperatøren som det undersøkte mobilnummeret har blitt portert til, hvis aktuelt.	true
`ported_country_name`	string	Spesifiserer landet som det undersøkte mobilnummeret har blitt portert til, hvis aktuelt.	true
`ported_country_code`	string(2)	En totegns ISO-landskode som representerer landet som det undersøkte mobilnummeret har blitt portert til, hvis aktuelt.	true
`ported_country_prefix`	string	Retningsnummeret for landet som det undersøkte mobilnummeret har blitt portert til, hvis aktuelt.	true
`extra`	string	En vilkårlig streng som gir valgfrie tilleggsdetaljer om telefonnummeret.	true
`cost`	string	En desimalverdi, representert som en streng, som indikerer kostnaden i EUR for dette oppslaget.	true
`timestamp`	string	Et W3C-formatert tidsstempel, inkludert tidssoneinformasjon, som indikerer når oppslaget ble fullført.	true
`storage`	string	Lagringsnavnet (eller rapportnavnet) som oppslagsresultatene ble lagt til. Dette brukes for CSV-nedlastinger og rapportering via webgrensesnittet.	true
`route`	string(3)	En tretegns identifikator som spesifiserer ruten som ble brukt for denne oppslagsforespørselen.	true
`error_code`	integer	En valgfri intern feilkode som gir tilleggskontekst for kundesupportdiagnostikk.	true

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

POST/mnp-lookupsbeskyttet

Starter en batch med asynkrone MNP-oppslag (mobilnummerportabilitet), henter gjeldende MCCMNC og identifiserer det opprinnelige og nåværende nettverket i sanntid. Resultater leveres via webhooks til din server. Denne metoden er optimalisert for behandling av store volumer med numre som ikke krever umiddelbare svar, for eksempel databaserensing og verifisering. For sanntidsapplikasjoner som samtalerutning eller SMS-levering bør du vurdere å bruke POST /mnp-lookup-endepunktet i stedet.

MNP-spørringer fastslår pålitelig portabilitet og nettverksinformasjon, men indikerer ikke om mobiltelefonen er tilkoblet et nettverk og kan nås for øyeblikket. For å hente ut live tilkoblingsinformasjon, vennligst bruk POST /hlr-lookups-endepunktet i stedet.

Før du bruker dette endepunktet, må du sørge for at en webhook-URL er konfigurert for å motta oppslagsresultater asynkront. Du kan konfigurere dette i dine API-innstillinger.

Forespørsel Vellykket respons Feilrespons Webhooks

curl -X POST 'https://www.hlr-lookups.com/api/v2/mnp-lookups' \
          -d "@payload.json"

Nyttelast

{
   "msisdns":["+14156226819","+491788735000","+905536939460"],
   "route":null,
   "storage":null
}

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`msisdns`	array	En liste med mobiltelefonnumre (MSISDN-er) i internasjonalt format (f.eks. +14156226819 eller 0014156226819). Du kan inkludere opptil 1000 numre per forespørsel.	null	obligatorisk
`route`	string(3)	En valgfri tre-tegns identifikator som spesifiserer ruten for dette oppslaget. Sett til `null` eller utelat denne parameteren for å bruke ditt tilpassede rutekart eller la systemet vårt automatisk bestemme de beste rutene for denne forespørselen.	null	valgfritt
`storage`	string	En valgfri lagringsidentifikator som spesifiserer rapporten hvor resultater vil lagres for manuell gjennomgang, analyse og rapportering. Systemet legger automatisk til et tidsstempel med gjeldende måned. Hvis utelatt eller satt til `null`, vil systemet automatisk gruppere resultater etter måned for rapporteringsformål.	null	valgfritt

{
   "accepted":[
      {
         "id":"0424928f332e",
         "msisdn":"+491788735000"
      }
   ],
   "accepted_count":1,
   "rejected":[
      {
         "id":null,
         "msisdn":"+31"
      }
   ],
   "rejected_count":1,
   "total_count":2,
   "cost":"0.01",
   "storage":"ASYNC-API-2020-08",
   "route":"IP1",
   "webhook_urls":[
      "https://your-server.com/endpoint"
   ]
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`accepted`	array	En liste med objekter som inneholder unike identifikatorer og MSISDN-er som er akseptert for behandling.	false
`accepted_count`	integer	Det totale antallet MSISDN-er som er akseptert for behandling.	false
`rejected`	array	En liste med objekter som inneholder unike identifikatorer og MSISDN-er som er avvist for behandling, vanligvis på grunn av ugyldige numre. Ingen kostnad påløper for avviste oppføringer.	false
`rejected_count`	integer	Det totale antallet MSISDN-er avvist på grunn av valideringsfeil.	false
`total_count`	integer	Det totale antallet aksepterte og avviste MSISDN-er som ble sendt inn for behandling.	false
`cost`	string	En desimalverdi representert som en streng som angir den totale kostnaden i EUR for de aksepterte oppslagene.	false
`storage`	string	Navnet på lagringsstedet hvor oppslagsresultatene legges til, brukt for rapportering og CSV-nedlastinger via webgrensesnittet.	false
`route`	string(3)	En tretegns identifikator som spesifiserer ruten som ble brukt for denne oppslagsforespørselen.	false
`webhook_urls`	array	Webhook-URL-ene konfigurert i dine API-innstillinger. Resultater sendes tilbake hit.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Behandling av webhooks

Når forespørselen er sendt, begynner plattformen vår å behandle de oppgitte telefonnumrene og sender resultatene til den tidligere angitte webhook-URL-en på serveren din. Resultatene overføres som en HTTP POST-forespørsel med et JSON-objekt i forespørselskroppen.

Autentisering

Autentiser webhooken ved å inspisere HTTP-headeren X-Signatures.

Headeren X-Signatures inneholder en semikolonseparert liste med signaturer. Hver signatur i listen genereres ved hjelp av en av API-hemmelighetene som er konfigurert i kontoen din. For å verifisere webhooken genererer du en SHA-256-hash ved hjelp av API-nøkkelen din, hemmeligheten og den rå HTTP-kroppen - deretter sammenligner du den med signaturene i listen.

Et treff bekrefter at forespørselen er autentisk og signert med en hemmelighet du kontrollerer.

Kodeeksempel

$signaturesHeader = (getallheaders() ?? [])['X-Signatures'] ?? ''; // list of signatures
$key = getenv('AUTH_KEY'); // Your API Key
$secret = getenv('AUTH_SECRET'); // Your API Secret
$payload = file_get_contents('php://input'); // The HTTP body of the incoming POST request

// Generate the expected signature
$expectedSignature = hash('sha256', $key . $secret . $payload);

// Split the header into individual signatures
$providedSignatures = explode(';', $signaturesHeader);

// Check if any signature matches
$valid = false;
foreach ($providedSignatures as $sig) {
    if (hash_equals($expectedSignature, $sig)) {
        $valid = true;
        break;
    }
}

Forespørselen er gyldig hvis noen av signaturene i headeren er lik en SHA256-hash beregnet over den sammenslåtte strengen av API-nøkkelen din, hemmeligheten og HTTP-kroppen.

Bekreftelse av mottak

Serveren din forventes å svare med HTTP-statuskode 200 OK for å bekrefte vellykket mottak. Hvis en annen responskode returneres, det oppstår en timeout (10 sekunder), eller andre leveringsproblemer oppstår, vil systemet automatisk forsøke webhooken på nytt etter ett minutt. Hvis forespørselen fortsetter å feile, vil nye forsøk følge en eksponentiell backoff-strategi, med påfølgende forsøk etter 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minutter.

Denne gjentakelsesmekanismen sikrer maksimal pålitelighet ved levering av oppslag-resultater til infrastrukturen din. Den minimerer risikoen for datatap på grunn av midlertidige nettverksproblemer eller nedetid på serveren.

Webhook-payload

{
    "type":"MNP",
    "results":[
        {
           "id":"e428acb1c0ae",
           "msisdn":"+14156226819",
           "query_status":"OK",
           "mccmnc":"310260",
           "mcc":"310",
           "mnc":"260",
           "is_ported":true,
           "original_network_name":"Verizon Wireless:6006 - SVR/2",
           "original_country_name":"United States",
           "original_country_code":"US",
           "original_country_prefix":"+1415",
           "ported_network_name":"T-Mobile US:6529 - SVR/2",
           "ported_country_name":"United States",
           "ported_country_code":"US",
           "ported_country_prefix":"+1",
           "extra":"LRN:4154250000",
           "cost":"0.0050",
           "timestamp":"2020-08-05 21:21:33.490+0300",
           "storage":"WEB-CLIENT-SOLO-MNP-2020-08",
           "route":"PTX",
           "error_code":null
        }
    ]
}

Webhook-nyttelastattributter

JSON-objektet inneholder et attributt type => MNP sammen med et attributt results som inkluderer en liste med oppslagsobjekter, som dokumentert nedenfor.

Navn	Type	Beskrivelse	Kan være null
`id`	string(12)	En unik 12-tegns identifikator for dette oppslaget.	false
`msisdn`	string	Mobilnummeret som ble evaluert i denne oppslagsforespørselen.	false
`query_status`	string	Indikerer om henting av portabilitet og nettverksinformasjon var vellykket. Mulige verdier er `OK` eller `FAILED`.	false
`mccmnc`	string(5\|6)	En fem- eller sekstegns MCCMNC (mobillandskode og mobilnettverkskode) som identifiserer nettverket mobilnummeret tilhører.	true
`mcc`	string(3)	En tretegns MCC (mobillandskode) som representerer landet tilknyttet mobilnummerets nåværende nettverk.	true
`mnc`	string(2\|3)	En to- eller tretegns MNC (mobilnettverkskode) som identifiserer nåværende nettverksoperatør for mobilnummeret.	true
`is_ported`	boolean	Indikerer om telefonnummeret har blitt portert fra sitt opprinnelige nettverk til en ny operatør.	true
`original_network_name`	string	En vilkårlig streng (på engelsk) som spesifiserer det opprinnelige nettverksoperatørnavnet til det undersøkte mobilnummeret.	true
`original_country_name`	string	En vilkårlig streng (på engelsk) som indikerer det opprinnelige landet til det undersøkte mobilnummeret.	true
`original_country_code`	string(2)	En totegns ISO-landskode som representerer det opprinnelige landet til det undersøkte mobilnummeret.	true
`original_country_prefix`	string	Retningsnummeret til det opprinnelige landet tilknyttet det undersøkte mobilnummeret.	true
`ported_network_name`	string	Spesifiserer nettverksoperatøren som det undersøkte mobilnummeret har blitt portert til, hvis aktuelt.	true
`ported_country_name`	string	Spesifiserer landet som det undersøkte mobilnummeret har blitt portert til, hvis aktuelt.	true
`ported_country_code`	string(2)	En totegns ISO-landskode som representerer landet som det undersøkte mobilnummeret har blitt portert til, hvis aktuelt.	true
`ported_country_prefix`	string	Retningsnummeret for landet som det undersøkte mobilnummeret har blitt portert til, hvis aktuelt.	true
`extra`	string	En vilkårlig streng som gir valgfrie tilleggsdetaljer om telefonnummeret.	true
`cost`	string	En desimalverdi, representert som en streng, som indikerer kostnaden i EUR for dette oppslaget.	true
`timestamp`	string	Et W3C-formatert tidsstempel, inkludert tidssoneinformasjon, som indikerer når oppslaget ble fullført.	true
`storage`	string	Lagringsnavnet (eller rapportnavnet) som oppslagsresultatene ble lagt til. Dette brukes for CSV-nedlastinger og rapportering via webgrensesnittet.	true
`route`	string(3)	En tretegns identifikator som spesifiserer ruten som ble brukt for denne oppslagsforespørselen.	true
`error_code`	integer	En valgfri intern feilkode som gir tilleggskontekst for kundesupportdiagnostikk.	true

Rull opp

POST/nt-lookupbeskyttet

Utfører et synkront nummertype (NT) oppslag. Dette endepunktet er ideelt hvis ditt primære mål er å avgjøre om de angitte telefonnumrene tilhører fasttelefon, mobil, premium rate, VoIP, personsøker eller andre nummerplan-områder i sanntid.

NT-spørringer detekterer pålitelig telefonnummertypen, men de indikerer ikke om målnummeret for øyeblikket er tilkoblet et nettverk og nåbart. For å hente live tilkoblingsinformasjon, vennligst bruk POST /hlr-lookup endepunktet.

Hvis din brukssituasjon krever nøyaktig nettverks- og portabilitetsinformasjon (MCCMNC) men ikke live tilkoblingsstatus, vennligst bruk POST /mnp-lookup endepunktet for mobilnummer portabilitetsspørringer.

Forespørsel Vellykket respons Feilrespons Typereferanse

curl -X POST 'https://www.hlr-lookups.com/api/v2/nt-lookup' \
          -d "@payload.json"

Nyttelast

{
   "number":"+14156226819",
   "route":null,
   "storage":null
}

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`number`	string	Et telefonnummer i internasjonalt format (f.eks. +4989702626 eller 004989702626).	null	mandatory
`route`	string(3)	En valgfri tre-tegns identifikator som spesifiserer ruten for dette oppslaget. Sett til `null` eller utelat denne parameteren for å anvende ditt tilpassede rutingskart eller la systemet vårt automatisk bestemme de beste rutene for denne forespørselen.	null	valgfritt
`storage`	string	En valgfri lagringsidentifikator som spesifiserer rapporten hvor resultater vil lagres for manuell gjennomgang, analyse og rapportering. Systemet legger automatisk til et tidsstempel med gjeldende måned. Hvis utelatt eller satt til `null`, vil systemet automatisk gruppere resultater etter måned for rapporteringsformål.	null	valgfritt

{
     "id":"2ed0788379c6",
     "number":"+4989702626",
     "number_type":"LANDLINE",
     "query_status":"OK",
     "is_valid":true,
     "invalid_reason":null,
     "is_possibly_ported":false,
     "is_vanity_number":false,
     "qualifies_for_hlr_lookup":false,
     "mccmnc":null,
     "mcc":null,
     "mnc":null,
     "original_network_name":null,
     "original_country_name":"Germany",
     "original_country_code":"DE",
     "regions":[
        "Munich"
     ],
     "timezones":[
        "Europe/Berlin"
     ],
     "info_text":"This is a landline number.",
     "cost":"0.0050",
     "timestamp":"2015-12-04 10:36:41.866283+00",
     "storage":"SYNC-API-NT-2015-12",
     "route":"LC1"
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`id`	string(12)	En unik identifikator tildelt denne oppslags-forespørselen.	false
`number`	string	Telefonnummeret som ble evaluert under denne oppslaget.	false
`number_type`	string	Den detekterte nummertypen. Mulige verdier inkluderer: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Indikerer om informasjon om nummertype ble hentet. Returnerer `OK` ved suksess, eller `FAILED` hvis oppslaget mislyktes.	false
`is_valid`	boolean	Indikerer om telefonnummeret er syntaktisk gyldig.	true
`invalid_reason`	string	En tekstmelding på engelsk som spesifiserer hvorfor telefonnummeret anses som ugyldig (f.eks. "too short" eller "invalid prefix"), eller `null` hvis nummeret er gyldig.	true
`is_possibly_ported`	boolean	Indikerer om telefonnummeret kan ha blitt portet fra sin opprinnelige operatør til en annen leverandør. For definitiv porteringsinformasjon, bruk MNP-oppslag.	true
`is_vanity_number`	boolean	Indikerer om telefonnummeret er et vanitynummer, det vil si at det inneholder alfabetiske tegn.	true
`qualifies_for_hlr_lookup`	boolean	Indikerer om telefonnummeret er kvalifisert for ytterligere oppslag via HLR-oppslag.	true
`mccmnc`	string(5\|6)	En fem- eller sekstegns streng som representerer MCCMNC-tupelen (mobillandkode og mobilnettverkskode) som identifiserer det opprinnelige nettverket til mobilnummeret.	true
`mcc`	string(3)	En tretegns streng som representerer MCC (mobillandkode) som identifiserer landet assosiert med det opprinnelige mobilnettverket til telefonnummeret.	true
`mnc`	string(2\|3)	En to- eller tretegns streng som representerer MNC (mobilnettverkskode) som identifiserer den opprinnelige mobilnettverksoperatøren til telefonnummeret.	true
`original_network_name`	string	En vilkårlig tekststreng på engelsk som spesifiserer navnet på den opprinnelige nettverksoperatøren for det undersøkte mobilnummeret.	true
`original_country_name`	string	En vilkårlig tekststreng på engelsk som spesifiserer det opprinnelige landet assosiert med det undersøkte mobilnummeret.	true
`original_country_code`	string(2)	En totegns ISO-landkode som indikerer det opprinnelige landet til det undersøkte mobilnummeret.	true
`regions`	array	En liste over lesbare strenger på engelsk som spesifiserer den geografiske regionen(e) assosiert med dette telefonnummeret.	true
`timezones`	array	En liste over tidssoner (i Olson-format) assosiert med dette telefonnummeret.	true
`info_text`	string	En vilkårlig streng som kan inneholde tilleggsinformasjon om telefonnummeret.	true
`cost`	string	En desimalverdi representert som en streng, som indikerer kostnaden (i EUR) for dette oppslaget.	true
`timestamp`	string	Et W3C-formatert tidsstempel (inkludert tidssone) som indikerer når oppslaget ble fullført.	true
`storage`	string	Spesifiserer lagringsnavnet hvor oppslagsresultatene er lagret. Dette tilsvarer rapportnavnet som brukes for CSV-nedlastinger og analyser via webgrensesnittet.	true
`route`	string(3)	En tretegns identifikator som spesifiserer ruten som ble brukt for denne oppslagsforespørselen.	true

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Type	Beskrivelse
LANDLINE	Fasttelefonnummer.
MOBILE	Mobiltelefonnummer. Kvalifiserer for HLR-oppslag for å innhente tilleggsinformasjon om tilkoblingsstatus, nettverk, porterbarhet og roaming.
MOBILE_OR_LANDLINE	Fasttelefon- eller mobiltelefonnummer. Kan kvalifisere for HLR-oppslag.
TOLL_FREE	Gratisnummer.
PREMIUM_RATE	Betalingsnummer med tilleggskostnader.
SHARED_COST	Nummer med delt kostnad. Vanligvis rimeligere enn betalingsnummer.
VOIP	Voice over IP-telefonnummer. Inkluderer TSoIP-telefonnummer (Telephony Service over IP).
PAGER	Personsøkernummer. Vanligvis ingen talefunksjonalitet.
UAN	Universelt tilgangsnummer (sentralbordnummer). Kan rutes til spesifikke kontorer, men gir ett nummer for hele selskapet.
VOICEMAIL	Talepostnummer.
UNKNOWN	Nummertype kunne ikke fastslås.

Rull opp

POST/nt-lookups beskyttet

Dette endepunktet utfører en serie asynkrone nummertype-oppslag med resultater som sendes tilbake til serveren din via webhook. Det er egnet hvis hovedmålet ditt er å avgjøre om gitte telefonnumre tilhører fasttelefon, mobil, premium rate, VoIP, personsøker eller andre nummerserieområder. Optimalisert for rask behandling av store volumer med numre, dette endepunktet er ideelt for bulkoperasjoner (f.eks. databasesanering). For sanntidstrafikk og tidskritiske bruksområder, vennligst bruk POST /nt-lookup-endepunktet i stedet.

Du må angi en webhook-URL i dine API-innstillinger som en forutsetning for å bruke dette endepunktet.

Forespørsel Vellykket respons Feilrespons Webhooks Typereferanse

curl -X POST 'https://www.hlr-lookups.com/api/v2/nt-lookups' \
          -d "@payload.json"

Nyttelast

{
   "numbers":["+14156226819","+4989702626"],
   "route":null,
   "storage":null
}

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`numbers`	array	En liste med telefonnumre i internasjonalt format (f.eks. +14156226819 eller 004989702626). Maksimalt 1000 numre kan inkluderes per forespørsel.	null	obligatorisk
`route`	string(3)	En valgfri tre-tegns identifikator som spesifiserer ruten for dette oppslaget. Sett til `null` eller utelat denne parameteren for å anvende ditt tilpassede rutekart eller la systemet vårt automatisk bestemme den beste ruten for denne forespørselen.	null	valgfritt
`storage`	string	En valgfri lagringsidentifikator som spesifiserer rapporten hvor resultater vil lagres for manuell gjennomgang, analyse og rapportering. Systemet legger automatisk til et tidsstempel med gjeldende måned. Hvis utelatt eller satt til `null`, vil systemet automatisk gruppere resultater etter måned for rapporteringsformål.	null	valgfritt

{
   "accepted":[
      {
         "id":"9f8a52cfa7d2",
         "number":"+905536939460"
      }
   ],
   "accepted_count":1,
   "rejected":[
      {
         "id":null,
         "number":"+31"
      }
   ],
   "rejected_count":2,
   "total_count":3,
   "cost":0.005,
   "storage":"ASYNC-API-NT-2020-08",
   "route":"LC1",
   "webhook_urls":[
      "https://your-server.com/endpoint"
   ]
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`accepted`	array	En liste med objekter, hver inneholdende en unik identifikator og et telefonnummer som er akseptert for behandling.	false
`accepted_count`	integer	Totalt antall telefonnumre akseptert for behandling.	false
`rejected`	array	En liste med objekter, hver inneholdende en unik identifikator og et telefonnummer som ble avvist for behandling. Vanligvis er disse numrene ugyldige, og ingen kostnad påløper.	false
`rejected_count`	integer	Totalt antall telefonnumre som ble avvist for behandling.	false
`total_count`	integer	Totalt antall aksepterte og avviste telefonnumre som ble sendt inn for behandling.	false
`cost`	string	En streng som representerer en desimalverdi som angir kostnaden i EUR for disse oppslagene.	false
`storage`	string	Navnet på lagringen (rapporten) hvor oppslagsresultatene er lagt til. Dette navnet brukes for CSV-nedlastinger og analyser via webgrensesnittet.	false
`route`	string(3)	En tre-tegns identifikator som spesifiserer ruten som brukes for denne oppslagsforespørselen.	false
`webhook_urls`	array	Webhook-URL-ene konfigurert i dine API-innstillinger. Resultater sendes tilbake hit.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Behandling av webhooks

Når forespørselen er sendt, begynner plattformen vår å behandle de oppgitte telefonnumrene og sender resultatene til den tidligere angitte webhook-URL-en på serveren din. Resultatene overføres som en HTTP POST-forespørsel med et JSON-objekt i forespørselskroppen.

Autentisering

Autentiser webhooken ved å inspisere HTTP-headeren X-Signatures.

Headeren X-Signatures inneholder en semikolonseparert liste med signaturer. Hver signatur i listen genereres ved hjelp av en av API-hemmelighetene som er konfigurert i kontoen din. For å verifisere webhooken genererer du en SHA-256-hash ved hjelp av API-nøkkelen din, hemmeligheten og den rå HTTP-kroppen - deretter sammenligner du den med signaturene i listen.

Et treff bekrefter at forespørselen er autentisk og signert med en hemmelighet du kontrollerer.

Kodeeksempel

$signaturesHeader = (getallheaders() ?? [])['X-Signatures'] ?? ''; // list of signatures
$key = getenv('AUTH_KEY'); // Your API Key
$secret = getenv('AUTH_SECRET'); // Your API Secret
$payload = file_get_contents('php://input'); // The HTTP body of the incoming POST request

// Generate the expected signature
$expectedSignature = hash('sha256', $key . $secret . $payload);

// Split the header into individual signatures
$providedSignatures = explode(';', $signaturesHeader);

// Check if any signature matches
$valid = false;
foreach ($providedSignatures as $sig) {
    if (hash_equals($expectedSignature, $sig)) {
        $valid = true;
        break;
    }
}

Forespørselen er gyldig hvis noen av signaturene i headeren er lik en SHA256-hash beregnet over den sammenslåtte strengen av API-nøkkelen din, hemmeligheten og HTTP-kroppen.

Bekreftelse av mottak

Serveren din forventes å svare med HTTP-statuskode 200 OK for å bekrefte vellykket mottak. Hvis en annen responskode returneres, det oppstår en timeout (10 sekunder), eller andre leveringsproblemer oppstår, vil systemet automatisk forsøke webhooken på nytt etter ett minutt. Hvis forespørselen fortsetter å feile, vil nye forsøk følge en eksponentiell backoff-strategi, med påfølgende forsøk etter 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 minutter.

Denne gjentakelsesmekanismen sikrer maksimal pålitelighet ved levering av oppslag-resultater til infrastrukturen din. Den minimerer risikoen for datatap på grunn av midlertidige nettverksproblemer eller nedetid på serveren.

Webhook-payload

{
   "type":"NT",
   "results":[
      {
         "id":"9f8a52cfa7d2",
         "number":"+905536939460",
         "numbertype":"MOBILE",
         "state":"COMPLETED",
         "isvalid":"Yes",
         "invalidreason":null,
         "ispossiblyported":"Yes",
         "isvanitynumber":"No",
         "qualifiesforhlrlookup":"Yes",
         "originalcarrier":"Turk Telekom (AVEA)",
         "mccmnc":"28603",
         "mcc":"286",
         "mnc":"03",
         "countrycode":"TR",
         "regions":[
            "Turkey"
         ],
         "timezones":[
            "Europe\/Istanbul"
         ],
         "infotext":"This number qualifies for HLR lookups. Determine if this subscriber number is connected, absent or invalid by running an HLR lookup. This is a mobile number and might be in roaming state. Run an HLR lookup to obtain roaming information (if available). This number is possibly ported and the carrier information might be inaccurate. To obtain portability information run an HLR lookup.",
         "usercharge":"0.0050",
         "inserttime":"2020-08-13 01:57:15.897+0300",
         "storage":"ASYNC-API-NT-2020-08",
         "route":"LC1",
         "interface":"Async API"
      }
   ]
}

Webhook-nyttelastattributter

JSON-objektet inneholder et attributt type => NT sammen med et attributt results som inkluderer en liste med oppslagsobjekter, som dokumentert nedenfor.

Navn	Type	Beskrivelse	Kan være null
`id`	string(12)	En unik identifikator tildelt denne oppslags-forespørselen.	false
`number`	string	Telefonnummeret som ble evaluert under denne oppslaget.	false
`number_type`	string	Den detekterte nummertypen. Mulige verdier inkluderer: `LANDLINE` , `MOBILE` , `MOBILE_OR_LANDLINE` , `TOLL_FREE` , `PREMIUM_RATE` , `SHARED_COST` , `VOIP` , `PAGER` , `UAN` , `VOICEMAIL` , `UNKNOWN` .	false
`query_status`	string	Indikerer om informasjon om nummertype ble hentet. Returnerer `OK` ved suksess, eller `FAILED` hvis oppslaget mislyktes.	false
`is_valid`	boolean	Indikerer om telefonnummeret er syntaktisk gyldig.	true
`invalid_reason`	string	En tekstmelding på engelsk som spesifiserer hvorfor telefonnummeret anses som ugyldig (f.eks. "too short" eller "invalid prefix"), eller `null` hvis nummeret er gyldig.	true
`is_possibly_ported`	boolean	Indikerer om telefonnummeret kan ha blitt portet fra sin opprinnelige operatør til en annen leverandør. For definitiv porteringsinformasjon, bruk MNP-oppslag.	true
`is_vanity_number`	boolean	Indikerer om telefonnummeret er et vanitynummer, det vil si at det inneholder alfabetiske tegn.	true
`qualifies_for_hlr_lookup`	boolean	Indikerer om telefonnummeret er kvalifisert for ytterligere oppslag via HLR-oppslag.	true
`mccmnc`	string(5\|6)	En fem- eller sekstegns streng som representerer MCCMNC-tupelen (mobillandkode og mobilnettverkskode) som identifiserer det opprinnelige nettverket til mobilnummeret.	true
`mcc`	string(3)	En tretegns streng som representerer MCC (mobillandkode) som identifiserer landet assosiert med det opprinnelige mobilnettverket til telefonnummeret.	true
`mnc`	string(2\|3)	En to- eller tretegns streng som representerer MNC (mobilnettverkskode) som identifiserer den opprinnelige mobilnettverksoperatøren til telefonnummeret.	true
`original_network_name`	string	En vilkårlig tekststreng på engelsk som spesifiserer navnet på den opprinnelige nettverksoperatøren for det undersøkte mobilnummeret.	true
`original_country_name`	string	En vilkårlig tekststreng på engelsk som spesifiserer det opprinnelige landet assosiert med det undersøkte mobilnummeret.	true
`original_country_code`	string(2)	En totegns ISO-landkode som indikerer det opprinnelige landet til det undersøkte mobilnummeret.	true
`regions`	array	En liste over lesbare strenger på engelsk som spesifiserer den geografiske regionen(e) assosiert med dette telefonnummeret.	true
`timezones`	array	En liste over tidssoner (i Olson-format) assosiert med dette telefonnummeret.	true
`info_text`	string	En vilkårlig streng som kan inneholde tilleggsinformasjon om telefonnummeret.	true
`cost`	string	En desimalverdi representert som en streng, som indikerer kostnaden (i EUR) for dette oppslaget.	true
`timestamp`	string	Et W3C-formatert tidsstempel (inkludert tidssone) som indikerer når oppslaget ble fullført.	true
`storage`	string	Spesifiserer lagringsnavnet hvor oppslagsresultatene er lagret. Dette tilsvarer rapportnavnet som brukes for CSV-nedlastinger og analyser via webgrensesnittet.	true
`route`	string(3)	En tretegns identifikator som spesifiserer ruten som ble brukt for denne oppslagsforespørselen.	true

Type	Beskrivelse
LANDLINE	Fasttelefonnummer.
MOBILE	Mobiltelefonnummer. Kvalifiserer for HLR-oppslag for å innhente tilleggsinformasjon om tilkoblingsstatus, nettverk, porterbarhet og roaming.
MOBILE_OR_LANDLINE	Fasttelefon- eller mobiltelefonnummer. Kan kvalifisere for HLR-oppslag.
TOLL_FREE	Gratisnummer.
PREMIUM_RATE	Betalingsnummer med tilleggskostnader.
SHARED_COST	Nummer med delt kostnad. Vanligvis rimeligere enn betalingsnummer.
VOIP	Voice over IP-telefonnummer. Inkluderer TSoIP-telefonnummer (Telephony Service over IP).
PAGER	Personsøkernummer. Vanligvis ingen talefunksjonalitet.
UAN	Universelt tilgangsnummer (sentralbordnummer). Kan rutes til spesifikke kontorer, men gir ett nummer for hele selskapet.
VOICEMAIL	Talepostnummer.
UNKNOWN	Nummertype kunne ikke fastslås.

Rull opp

GET/routebeskyttet

Henter ruten som automatisk velges når du kjører et HLR-oppslag uten å spesifisere route-parameteren.

Automatisk rutevalg er basert på rutingkartet som kan hentes med GET /hlr-coverage-endepunktet, som primært er avledet fra GET /routing-map. Du kan tilpasse rutingkartet ditt og definere egendefinerte regler i dine kontoinnstillinger.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/route?msisdn=+491788735000'

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`msisdn`	string	MSISDN som det skal hentes automatisk valgt rutingsinformasjon for.	null	obligatorisk

{
   "route":"V11",
   "confidence_level":"HIGH",
   "mccmnc":"26203",
   "origin":"SCORE"
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`route`	string	Den anbefalte ruten.	false
`confidence_level`	string	Konfidensnivået som denne ruten ble valgt med, dvs. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`.	false
`mccmnc`	string	Nummereringsplanbasert MCCMNC for dette nummeret.	false
`origin`	string	Opprinnelsen som rutingsbeslutningen er basert på, dvs. `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/routesbeskyttet

Dette endepunktet returnerer en liste over tilgjengelige HLR-, MNP- og NT-ruter. Hver rute, sammen med dens funksjoner og begrensninger, er forklart på siden rutingdetaljer.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/routes'

{
   "routes":{
      "HLR":[
         "V11",
         "E10",
         "MS9",
         "DV8",
         "SV3",
         "IP1"
      ],
      "MNP":[
         "PTX",
         "IP4"
      ],
      "NT":[
         "LC1"
      ]
   }
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`routes`	object	Et objekt med ruter gruppert etter rutetype.	false
`HLR\|MNP\|NT`	string[]	Inneholder en liste over ruteidentifikatorer.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/routing-mapbeskyttet

Henter den automatiske rutingkonfigurasjonen som for øyeblikket er anvendt på HLR-oppslag for din konto. Denne standardkonfigurasjonen brukes når du sender inn HLR-oppslag uten å spesifisere en route-parameter. Du kan tilpasse rutingkartet ditt og opprette egendefinerte regler i dine kontoinnstillinger.

Konfigurasjonshierarkiet går fra landsbaserte regler til MCCMNC-baserte regler, og til slutt til individuelle telefonnummerprefiks-tilordninger. I praksis betyr dette at individuelle telefonnummerprefiks-tilordninger har forrang over motstridende MCCMNC-tildelinger, som igjen overstyrer landsbaserte regler. Vær oppmerksom på at MNP-fallback overstyrer eventuelle motstridende egendefinerte regler når den er aktivert.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/routing-map'

{
   "routing":{
      "map":{
         "defaultRoute":"V11",
         "mnpFallback":true,
         "mccmncs":[
            {
               "mccmnc":20201,
               "countrycode":"GR",
               "route":"E10",
               "mno":"Cosmote",
               "confidence":"HIGH",
               "origin":"SCORE"
            }
         ],
         "prefixes":[
            {
               "countrycode":"DE",
               "cns":"+4917821",
               "route":"DV8",
               "mccmnc":"26203",
               "mno":"O2"
            }
         ],
         "countries":[
            {
               "countrycode":"US",
               "route":"DV8"
            }
         ]
      }
   }
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`default_route`	string	Standardruten som brukes når ingen foretrukket rutingsalternativ kan bestemmes for et MSISDN og ingen egendefinerte rutingsregler gjelder.	false
`mnp_fallback`	boolean	Angir om MNP-fallback er aktivert. Når aktivert og HLR-spørringer ikke støttes av et nettverk (tilkoblingsstatus utilgjengelig), vil systemet utføre et MNP-oppslag i stedet.	false
`mccmncs`	array	En tilordning av MCCMNC-koder til deres automatisk valgte ruter. Ved utførelse av et HLR-oppslag for et nummer i en gitt MCCMNC, brukes den tilsvarende ruten.	false
`mccmnc`	string(5\|6)	En fem- eller seks-tegns MCCMNC (kombinasjon av mobillandkode og mobilnettkode) som identifiserer mobiloperatøren.	false
`countrycode`	string(2)	En ISO-landkode på to tegn som identifiserer nettverkets land.	false
`route`	string(3)	Den valgte ruten for nettverket.	false
`mno`	string	Det forbrukerrettede merkenavnet som dette nettverket opererer under.	false
`confidence`	string	Konfidensnivået som valget ble gjort med. Mulige verdier er: HIGH, NORMAL, LOW, MNP_REDIRECT. I tilfelle sistnevnte, omdirigerer systemet trafikk til dette nettverket til MNP, hvis denne funksjonen er aktivert i din konto. Ellers brukes standardruten i kontoen.	false
`origin`	string	Opprinnelsen som valget er basert på. Mulige verdier er: `SCORE`, `CUSTOM_GLOBAL_COUNTRY`, `CUSTOM_GLOBAL_MCCMNC`, `CUSTOM_GLOBAL_PREFIX`, `CUSTOM_USER_COUNTRY`, `CUSTOM_USER_MCCMNC`, `CUSTOM_USER_PREFIX`, `MNP_FALLBACK`, `PLATFORM_DEFAULT`, `USER_DEFAULT`	false
`prefixes`	array	En liste over egendefinerte prefiksbaserte rutingsregler konfigurert i din konto, hvis noen.	false
`countrycode`	string(2)	En ISO-landkode på to tegn som identifiserer prefiksets land.	false
`cns`	string	Prefikset som rutingsregelen gjelder for.	false
`route`	string(3)	Den valgte ruten for prefikset.	false
`mccmnc`	string(5\|6)	En fem- eller seks-tegns MCCMNC (kombinasjon av mobillandkode og mobilnettkode) som identifiserer mobiloperatøren.	true
`mno`	string	Det forbrukerrettede merkenavnet som dette nettverket opererer under.	true
`countries`	array	En liste over egendefinerte landsbaserte regler konfigurert i din konto, hvis noen.	false
`countrycode`	string(2)	En ISO-landkode på to tegn som identifiserer landet.	false
`route`	string(3)	Den valgte ruten for landet.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/hlr-coverage beskyttet

Returnerer HLR-dekningsinnsikt for å støtte datadrevet beslutningstaking. Dette endepunktet hjelper deg med å analysere sanntids HLR-rutingsalternativer på tvers av mobilnettverk, identifisere de mest effektive veiene for dine målregioner og konfigurere automatisk ruting.

Anbefalte ruter fra GET /route er basert på dekningsdataene som hentes her. Dekningsdata er også tilgjengelig på siden for nettverksdekning. Du kan tilpasse rutingskartet ditt ytterligere og definere regler i dine kontoinnstillinger.

Vi anbefaler at du gjør deg kjent med denne veiledningen for å tolke resultatene.

Forespørsel Vellykket respons Feilrespons Statusreferanse

curl 'https://www.hlr-lookups.com/api/v2/hlr-coverage?countrycode=XX'

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`countrycode`	string(2)	En obligatorisk ISO-landskode med to bokstaver som brukes til å filtrere resultater, og returnerer kun poster knyttet til det angitte landet.	null	obligatorisk
`sample_size`	string	En valgfri parameter som angir en utvalgsstørrelse. Mulige verdier er `LARGE`, `MEDIUM`, `SMALL`. Større utvalg dekker en lengre tidsperiode, mindre utvalg dekker en svært ny tidsperiode.	LARGE	valgfritt

{
   "name":"Germany",
   "countrycode":"DE",
   "prefix":"+49",
   "mccs":[
      "262"
   ],
   "carriers":[
      {
         "mno":"Telekom",
         "mccmnc":"26201",
         "mcc":"262",
         "mnc":"01 ",
         "routes":[
            {
               "route":"V11",
               "selected":true,
               "selection_confidence":"HIGH",
               "n":361579,
               "CONNECTED":275273,
               "CONNECTED_PCT":76.13,
               "ABSENT":21529,
               "ABSENT_PCT":5.95,
               "INVALID_MSISDN":62582,
               "INVALID_MSISDN_PCT":17.3,
               "UNDETERMINED":2195,
               "UNDETERMINED_PCT":0.6
            },
            {
               "route":"E10",
               "selected":false,
               "selection_confidence":null,
               "n":122600,
               "CONNECTED":13721,
               "CONNECTED_PCT":11.19,
               "ABSENT":133,
               "ABSENT_PCT":0.1,
               "INVALID_MSISDN":55,
               "INVALID_MSISDN_PCT":0.04,
               "UNDETERMINED":108691,
               "UNDETERMINED_PCT":88.65
            }
         ]
      }
   ]
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`name`	string	Det valgte landnavnet på engelsk i ren tekst.	false
`countrycode`	string(2)	ISO-landskoden med to tegn for det valgte landet.	false
`prefix`	string	Det internasjonale oppringingsprefikset for det valgte landet.	false
`mccs`	string[]	En liste over MCC-er (mobile country codes) knyttet til det valgte landet.	false
`carriers`	object[]	En liste over operatørobjekter med rutespesifikke tilkoblingsmålinger.	false
`mno`	string	Mobilnettoperatørens navn på engelsk i ren tekst.	false
`mccmnc`	string	Mobilnettoperatørens MCCMNC.	false
`mcc`	string	Mobilnettoperatørens MCC (mobile country code).	false
`mnc`	string	Mobilnettoperatørens MNC (mobile network code).	false
`routes`	object[]	En liste over rutespesifikke tilkoblingsresultater.	false
`route`	string	Ruten som tilkoblingsinformasjonen gjelder for.	false
`selected`	bool	Indikerer om dette er den valgte ruten for automatisert ruting.	false
`selection_confidence`	string	Konfidensnivået som denne ruten ble valgt med, dvs. `LOW`, `NORMAL`, `HIGH`, `MNP_FALLBACK`. Inneholder null hvis dette ikke er den valgte ruten.	true
`n`	int	Det totale antallet oppslag i dette utvalget.	false
`CONNECTED`	int	Antall HLR-oppslag som returnerte en CONNECTED-status.	false
`CONNECTED_PCT`	float	Prosentandelen av HLR-oppslag som returnerte en CONNECTED-status.	false
`ABSENT`	int	Antall HLR-oppslag som returnerte en ABSENT-status.	false
`ABSENT_PCT`	float	Prosentandelen av HLR-oppslag som returnerte en ABSENT-status.	false
`INVALID_MSISDN`	int	Antall HLR-oppslag som returnerte en INVALID_MSISDN-status.	false
`INVALID_MSISDN_PCT`	float	Prosentandelen av HLR-oppslag som returnerte en INVALID_MSISDN-status.	false
`UNDETERMINED`	int	Antall HLR-oppslag som returnerte en UNDETERMINED-status.	false
`UNDETERMINED_PCT`	float	Prosentandelen av HLR-oppslag som returnerte en UNDETERMINED-status.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Status	Beskrivelse
CONNECTED	Nummeret er gyldig, og målenheten er for øyeblikket tilkoblet mobilnettet. Anrop, SMS og andre tjenester skal nå mottakeren uten problemer.
ABSENT	Nummeret er gyldig, men målenheten er enten slått av eller midlertidig utenfor nettverksdekning. Meldinger eller anrop vil muligens ikke bli levert før enheten kobles til nettet igjen.
INVALID_MSISDN	Nummeret er ugyldig eller ikke tildelt noen abonnent på mobilnettet. Anrop og meldinger til dette nummeret vil mislykkes.
UNDETERMINED	Tilkoblingsstatusen for nummeret kunne ikke fastslås. Dette kan skyldes et ugyldig nummer, SS7-feilrespons eller manglende tilkobling til målnettverksoperatøren. Undersøk feilkoden og beskrivelsesfeltet for ytterligere diagnostikk.

Rull opp

GET/mnp-coveragebeskyttet

Dette endepunktet returnerer en liste over mobiloperatører, sammen med deres tilhørende MCCMNC-identifikatorer, som for øyeblikket støttes for nummerbærbarhetoppslag.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/mnp-coverage?countrycode=XX'

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`countrycode`	string(2)	En valgfri to-bokstavers ISO-landkode som brukes til å filtrere MCCMNC-resultatene, og returnerer kun data som er relevant for det angitte landet.	null	valgfritt

{
   "items":[
      {
         "country_name":"Germany",
         "country_code":"DE",
         "mccmnc":"26201",
         "mcc":"262",
         "mnc":"01 ",
         "brand":"Telekom",
         "operator":"Telekom Deutschland GmbH"
      },
      {
         "country_name":"Germany",
         "country_code":"DE",
         "mccmnc":"26202",
         "mcc":"262",
         "mnc":"02 ",
         "brand":"Vodafone",
         "operator":"Vodafone D2 GmbH"
      }
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`items[]`	array	En liste over mobilnettoperatører.	false
`country_name`	string	Landnavnet på engelsk.	false
`country_code`	string(2)	En to-bokstavers ISO-landkode.	false
`mccmnc`	string(5\|6)	En fem- eller seks-tegns MCCMNC (kombinasjon av mobillandkode og mobilnettkode) som identifiserer mobiloperatøren.	false
`mcc`	string(3)	En tre-tegns MCC (mobillandkode) som representerer nettverkets land.	false
`mnc`	string(2\|3)	En to- eller tre-tegns MNC (mobilnettkode) som representerer den spesifikke mobiloperatøren.	false
`brand`	string	Det forbrukerrettede merkenavnet som dette nettverket opererer under.	true
`operator`	string	Det juridiske navnet til mobiloperatøren.	true

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/price-listbeskyttet

Dette endepunktet returnerer en liste over land hvor kun MNP-oppslag støttes, og HLR-spørringer er utilgjengelige for disse destinasjonene.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/mnp-countries'

{
   "countries":[
      "AG",
      "AI",
      "AR",
      "AS",
      "AW",
      "BB",
      "BM",
      ...
      "US",
      "UY",
      "VC",
      "VE",
      "VG",
      "VN"
   ]
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`countries`	string[]	En liste over to-tegns ISO-landkoder.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/mccmncsbeskyttet

Dette endepunktet returnerer en omfattende liste over mobilnettoperatører sammen med tilhørende MCCMNC-identifikatorer og ytterligere kontekstuell informasjon.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/mccmncs?countrycode=XX'

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`countrycode`	string(2)	En valgfri ISO-landkode med to bokstaver som brukes til å filtrere MCCMNC-resultater, og returnerer kun poster tilknyttet det angitte landet.	null	valgfritt

{
   "items":[
      {
         "country_name":"Germany",
         "country_code":"DE",
         "mccmnc":"26201",
         "mcc":"262",
         "mnc":"01 ",
         "brand":"Telekom",
         "operator":"Telekom Deutschland GmbH"
      },
      {
         "country_name":"Germany",
         "country_code":"DE",
         "mccmnc":"26202",
         "mcc":"262",
         "mnc":"02 ",
         "brand":"Vodafone",
         "operator":"Vodafone D2 GmbH"
      }
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`items`	object[]	En liste over mobilnettoperatører.	false
`country_name`	string	Det fullstendige landnavnet på engelsk.	false
`country_code`	string(2)	En ISO-landkode med to bokstaver som representerer landet til mobiloperatøren.	false
`mccmnc`	string(5\|6)	En streng på fem eller seks tegn som representerer MCCMNC, og som unikt identifiserer mobilnettoperatøren.	false
`mcc`	string(3)	En Mobile Country Code (MCC) på tre tegn som identifiserer landet der mobilnettverket opererer.	false
`mnc`	string(2\|3)	En Mobile Network Code (MNC) på to eller tre tegn som spesifiserer mobilnettverket innenfor den angitte MCC.	false
`brand`	string	Det kommersielle merkenavnet som nettverket opererer under og er kjent for blant forbrukere.	true
`operator`	string	Det offisielle navnet på mobilnettoperatøren, typisk den juridiske enheten som administrerer nettverket.	true
`parent_mccmnc`	string(5\|6)	En streng på fem eller seks tegn som representerer MCCMNC til overordnet mobilnettoperatør, hvis aktuelt.	true

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/pricebeskyttet

Dette endepunktet returnerer prisen for et HLR-, MNP- eller NT-oppslag.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/price?msisdn=+491788735000&route_type=HLR'

Forespørselsparametre

Nøkkel	Type	Beskrivelse	Standard	Obligatorisk
`msisdn`	string	Telefonnummeret som prisen skal hentes for. I internasjonalt format.	null	obligatorisk
`route_type`	string	Rutetype, dvs. `HLR`, `MNP`, `NT`.	null	obligatorisk
`route`	string(3)	Ruten som prisen skal beregnes for. Standard er ruten bestemt av automatisk ruting.	null	valgfritt

{
   "price":{
      "amount":"0.01000",
      "msisdn":"+491788735000",
      "route_type":"HLR",
      "route":"DV8"
   }
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`price`	object	Et objekt med prisdetaljer.	false
`amount`	string	Beløpet i EUR.	false
`msisdn`	string	MSISDN som denne prisen gjelder for.	false
`route_type`	string(2\|3)	Rutetype som denne prisen gjelder for.	false
`route`	string(3)	Ruten som denne prisen gjelder for.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/price-listbeskyttet

Dette endepunktet returnerer prisene i din konto.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/price-list'

{
   "pricing":[
      {
         "route":"V11",
         "countrycode":null,
         "countryname":null,
         "mccmnc":null,
         "cns":null,
         "route_type":"HLR",
         "price":"0.0090"
      },
      {
         "route":"V11",
         "countrycode":"DE",
         "countryname":"Germany",
         "mccmnc":"26201",
         "cns":null,
         "route_type":"HLR",
         "price":"0.0070"
      },
      {
         "route":"V11",
         "countrycode":"DE",
         "countryname":"Germany",
         "mccmnc":"26203",
         "cns":"4917821",
         "route_type":"HLR",
         "price":"0.0070"
      },
      {
         "route":"V11",
         "countrycode":"DE",
         "countryname":"Germany",
         "mccmnc":null,
         "cns":null,
         "route_type":"HLR",
         "price":"0.0070"
      },
      {
         "route":"PTX",
         "countrycode":null,
         "countryname":null,
         "mccmnc":null,
         "cns":null,
         "route_type":"MNP",
         "price":"0.00500"
      },
      ...
      {
         "route":"IP1",
         "countrycode":null,
         "countryname":null,
         "mccmnc":null,
         "cns":null,
         "route_type":"MIX",
         "price":"0.01000"
      },
      {
         "route":"LC1",
         "countrycode":null,
         "countryname":null,
         "mccmnc":null,
         "cns":null,
         "route_type":"NT",
         "price":"0.00500"
      }
   ]
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`pricing`	object[]	En liste med objekter som inneholder prisinformasjon.	false
`route`	string	Ruten som denne prisen gjelder for.	false
`countrycode`	string	Den totegns ISO-landskoden som denne prisen gjelder for den tilsvarende ruten, hvis aktuelt.	true
`countryname`	string	Det engelske landnavnet som tilsvarer landskoden, hvis aktuelt.	true
`mccmnc`	string	MCCMNC som denne prisen gjelder for den tilsvarende ruten, hvis aktuelt. Overstyrer priser på landnivå.	true
`cns`	string	Ringeprefikset som denne prisen gjelder for den tilsvarende ruten, hvis aktuelt. Overstyrer priser på landnivå og MCCMNC-nivå.	true
`route_type`	string	Den tilsvarende rutetypen, dvs. `HLR`, `MNP`, `NT`.	false
`route_type`	string	Den tilsvarende prisen i EUR.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/balancebeskyttet

Dette endepunktet henter din nåværende kontosaldo, slik at du kan automatisere prosesser basert på din kredittstatus. Det fungerer sømløst sammen med varsler om lav kreditt som du kan konfigurere på din betalingsside.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/balance'

{
    "balance":"1002.90"
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`balance`	string	Din nåværende kontosaldo i EUR. En desimalverdi av typen string.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/pingoffentlig

Dette endepunktet sender en ping-forespørsel til API-et, og gir en enkel metode for å teste tilkoblingen din til HLR Lookups API.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/ping'

{
    "success":true
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`success`	boolean	Indikerer at forespørselen ble behandlet vellykket.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/timeoffentlig

Dette endepunktet returnerer et Unix-tidsstempel som representerer gjeldende tid på HLR Lookups-serveren. Bruk det til å synkronisere serverens klokke når du genererer Digest-Auth-signaturen for autentisering, slik at eventuelle avvik mellom servertiden din og HLR Lookups-serverens tid blir korrigert.

Forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/time'

{
    "time":1525898643
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`time`	integer	Unix-tidsstempel som representerer gjeldende HLR Lookups-servertid.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

GET/auth-testbeskyttet

Dette endepunktet fungerer som en innledende test for din Basic-Auth eller, fortrinnsvis, Digest-Auth implementering.

Basic Auth forespørsel Digest Auth-forespørsel Vellykket respons Feilrespons

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Basic: YOUR_API_KEY"

Forespørselsheadere

Nøkkel	Type	Beskrivelse
`X-Basic`	string	SHA256-hash av `YOUR_API_KEY:YOUR_API_SECRET`. Inkluder kolonsymbolet (:) i hashen.

curl 'https://www.hlr-lookups.com/api/v2/auth-test' \
  -H "X-Digest-Key: YOUR_API_KEY" \
  -H "X-Digest-Signature: DIGEST_AUTH_SIGNATURE" \
  -H "X-Digest-Timestamp: UNIX_TIMESTAMP"

Forespørselsheadere

Nøkkel	Type	Beskrivelse
`X-Digest-Key`	string	Din HLR Lookups API-nøkkel
`X-Digest-Signature`	string	Unik Digest-Auth signatur (se autentisering)
`X-Digest-Timestamp`	integer	Gjeldende Unix-tidsstempel (se også `GET /time`)

{
    "success":true
}

Attributter for vellykket respons

Navn	Type	Beskrivelse	Kan være null
`success`	boolean	Indikerer at forespørselen ble behandlet vellykket.	false

{
    "errors":[
        "Service unavailable."
    ]
}

Feilrespons-parametere

Navn	Type	Beskrivelse	Kan være null
`errors[]`	string[]	En liste med strenger som forklarer feilen.	false

Rull opp

Dokumentasjon for utfaset API

Vær oppmerksom på at det utfasede API-et er avskrevet og planlegges avviklet i fremtiden. Vi anbefaler sterkt at du oppgraderer til nyeste versjon så snart som mulig.

Hvis du implementerte vårt HLR Lookups API mellom 2013 og tidlig 2020, bruker du vårt utfasede API. Vennligst se vår dokumentasjon for utfaset API i så fall.

Dokumentasjon for utfaset API

API-dokumentasjon

Kom i gang

HLR-oppslag

MNP-oppslag

NT-oppslag

Ruting

Priser

Verktøy

Kom i gang

Bruk av HLR Lookups API

Eksempelforespørsel

Eksempel på nyttelast

Vellykket respons application/json

Tilleggstjenester for oppslag

Nummerbærbarhet (MNP) oppslag

Nummertype-deteksjon (NT) oppslag

Programvareutviklingssett (SDK-er)

Verktøy

Ikke utvikler?

Autentisering

API-nøkkel og API-hemmelighet

HTTP Basic Auth

Anbefalt: X-Basic Header med SHA256

Basic Auth forespørsel

Basic Authentication headere

Kodeeksempel

Forespørselseksempel

Forespørselsheadere

Konstruere signaturen

Digest signaturkomponenter

Kodeeksempler

Konsepter

Synkront HLR-oppslags-API

Asynkront HLR-oppslag API

SDK-er (Software Development Kits)

PHP SDK

NodeJS SDK

Ruby SDK

POST/hlr-lookupbeskyttet

Nyttelast

Forespørselsparametre

Attributter for vellykket respons

Feilrespons-parametere

POST/hlr-lookupsbeskyttet

Nyttelast

Forespørselsparametre

Attributter for vellykket respons

Feilrespons-parametere

Behandling av webhooks

Autentisering

Kodeeksempel

Bekreftelse av mottak

Webhook-payload

Webhook-nyttelastattributter

POST/mnp-lookupbeskyttet

Nyttelast

Forespørselsparametre

Attributter for vellykket respons

Feilrespons-parametere

POST/mnp-lookupsbeskyttet

Nyttelast

Forespørselsparametre

Attributter for vellykket respons

Feilrespons-parametere

Behandling av webhooks

Autentisering

Kodeeksempel

Bekreftelse av mottak

Webhook-payload

Webhook-nyttelastattributter

POST/nt-lookupbeskyttet

Nyttelast

Forespørselsparametre

Attributter for vellykket respons

Feilrespons-parametere

POST/nt-lookups beskyttet

Nyttelast

Forespørselsparametre

Attributter for vellykket respons

Feilrespons-parametere