Slå upp namnet på en uppringare
Hämta ett tillgängligt namnresultat för ett telefonnummer. Uppslagningen görs i produktionsmiljön och kan medföra en debitering av ditt konto, även när resultatet kommer från tjänstens cache. Den ändrar inte det namn som visas vid utgående samtal från ett nummer du äger.
Ett returnerat namn verifierar varken identitet, ägande eller tillåtelse att ringa. Namn kan saknas, vara inaktuella eller förkortade, vara geografiska beteckningar eller ersättas med ett telefonnummer som reservvärde.
Begäran
Använd ditt aktiverade API-konto från den käll-IP-adress som är tillåten för kontot. Förvara autentiseringsuppgifter i en lagring för hemligheter på serversidan. Exemplet använder miljövariabler och ett fiktivt nordamerikanskt nummer; lägg inte autentiseringsuppgifter i URL:er eller offentligt tillgänglig webbläsarkod.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
https://api.multitel.net/v3/cnam/12025550123Ange hela numret med siffror, inklusive landskod, till exempel elva siffror som börjar med 1 för Nordamerika. Förlita dig inte på att hanteraren normaliserar skiljetecken eller ett plustecken. Ingen begärandekropp eller regionväljare krävs. Kontrollera med MultiTEL vilken täckning som stöds för din avsedda användning.
Svar
Värdena är endast exempel; kostnaden är inte en prisoffert.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"number": "12025550123",
"name": "EXAMPLE NAME",
"cost": 0.0037,
"balance": 9.9963
}
}| Fält | Betydelse |
|---|---|
| number | Det efterfrågade numret. |
| name | Det tillgängliga namnet eller reservtexten. Detta är inte en identitetsverifiering. |
| cost | Det konfigurerade uppslagningspriset för kontot eller tjänsten som rapporteras av detta flöde. Använd kontots aktuella pris, inte exempelvärdet. |
| balance | Det saldo som beräknats för svaret. Det är inte en ny transaktionell fråga om kontots saldo. |
Debitering och avstämning
Resultat med namn debiteras enligt kontots konfigurerade CNAM-pris. En upprepad uppslagning eller en uppslagning från cache kan medföra ytterligare en debitering; ingen idempotensnyckel tillhandahålls. Kontrollera kontots aktuella pris innan du aktiverar automatiserade uppslagningar.
Det finns en känd begränsning i svaret när ett cachat namn är tomt: hanteraren kan returnera API-kod 200 med ett tomt namn, en kostnad som inte är noll och ett minskat beräknat saldo, trots att den grenen inte debiterar kontot. Betrakta inte enbart det svaret som bevis på en debitering. Stäm av mot kontots faktureringsunderlag och en ny saldouppslagning, och kontakta supporten vid oklara resultat.
Kontrollen av förbetalt saldo kräver för närvarande ett saldo på minst 0.004 före uppslagningen, oberoende av det konfigurerade priset per fråga. Även ett konto där köp har inaktiverats avvisas. Dessa kontroller gör inte denna slutpunkt till ett API för prisofferter eller utgiftsgränser.
Fel och återförsök
Kontrollera både HTTP-statusen och status.code/status.msg i JSON-svaret. API-kod 403 kan innebära otillräckligt förbetalt saldo, förbjudna köp, ett problem med kontots behörighet eller att inget namn på uppringaren hittades. Flödet där namn saknas kan returnera koden som en sträng. Läs meddelandet i stället för att tolka varje 403 som felaktiga autentiseringsuppgifter. Konfigurationskonflikter kan ge API-kod 500.
En tidsgräns kan överskridas efter en debiterbar uppslagning. Använd ett begränsat antal återförsök med ökande väntetid endast när det är lämpligt för din applikation, och stäm först av försök med osäkert utfall. Gör inte upprepade återförsök för ett avvisat nummer eller vid fel som gäller kontots behörighet eller saldo. En svarscache i din egen applikation kan minska antalet upprepade begäranden, i enlighet med ditt avtal och dina krav på riktighet.
Andra nummeråtgärder
Denna läsåtgärd är separat från en uppdatering av namnet för utgående samtal/LIDB, en katalogpost eller registrering av uppringare. Dessa åtgärder har egna obligatoriska fält, behörighetskrav och avgifter. Använd tilldelningstäckning för att kontrollera prefixtabellen eller nummersökning för att se vilka nummer som kan beställas. Inget av detta fastställer att en uppringare är den som personen utger sig för att vara.