Ontwikkelaars

GET/v3/cnam/{number}

Soek 'n bellernaam op

Kry 'n beskikbare bellernaam en verstaan rekeningtariewe, terugvalwaardes en perke op herprobeerpogings.

Op hierdie bladsy
  1. Soek 'n bellernaam op
  2. Versoek
  3. Antwoord
  4. Koste en rekonsiliasie
  5. Foute en herprobeerpogings
  6. Ander nommerbewerkings

Soek 'n bellernaam op

Kry 'n beskikbare bellernaamresultaat vir 'n telefoonnommer. Hierdie opsoek word in die produksieomgewing uitgevoer en kan koste op jou rekening aangaan, ook wanneer die resultaat uit die diens se kasgeheue kom. Dit verander nie die naam wat by uitgaande oproepe vanaf 'n nommer wat jy besit, vertoon word nie.

'n Naam wat teruggestuur word, bevestig nie identiteit, eienaarskap of toestemming om te bel nie. Name kan ontbreek, verouderd of afgekort wees, geografiese benamings wees, of deur 'n telefoonnommer as terugvalwaarde vervang word.

Versoek

Gebruik jou geaktiveerde API-rekening vanaf die bron-IP-adres wat daarvoor toegelaat word. Hou aanmeldbesonderhede in 'n geheimebewaarplek aan die bedienerkant. Die voorbeeld gebruik omgewingsveranderlikes en 'n fiktiewe Noord-Amerikaanse nommer; moenie aanmeldbesonderhede in URL's of openbare blaaierkode plaas nie.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/cnam/12025550123

Verskaf die volledige nommer as syfers, met die landkode ingesluit, byvoorbeeld elf syfers wat met 1 begin vir Noord-Amerika. Moenie daarop staatmaak dat die versoekhanteerder leestekens of 'n plusteken sal normaliseer nie. Geen versoekliggaam of streekkeuse is nodig nie. Bevestig die ondersteunde dekking met MultiTEL vir jou beoogde gebruik.

Antwoord

Die waardes is slegs ter illustrasie; die koste is nie 'n pryskwotasie nie.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE NAME",
    "cost": 0.0037,
    "balance": 9.9963
  }
}
Velde vir die opsoek van bellername
VeldBetekenis
numberDie nommer waarvoor die versoek gedoen is.
nameDie beskikbare naam of terugvalteks. Dit is nie identiteitsverifikasie nie.
costDie opsoekprys wat vir die rekening/diens ingestel is en deur hierdie verwerkingspad gerapporteer word. Gebruik die rekening se huidige tarief, nie die illustratiewe waarde nie.
balanceDie saldo wat vir die antwoord bereken is. Dit is nie 'n nuwe transaksionele navraag na die rekeningsaldo nie.

Koste en rekonsiliasie

Resultate wat 'n naam bevat, word teen die rekening se ingestelde CNAM-prys gehef. 'n Herhaalde opsoek of een uit die kasgeheue kan nog 'n heffing veroorsaak; geen idempotensiesleutel word beskikbaar gestel nie. Gaan die huidige rekeningtarief na voordat jy outomatiese opsoeke aktiveer.

Daar is 'n bekende beperking in die antwoord wanneer 'n leë naam in die kasgeheue is: die versoekhanteerder kan API-kode 200 terugstuur met 'n leë naam, koste wat nie nul is nie en 'n verlaagde berekende saldo, al debiteer daardie vertakking nie die rekening nie. Moenie daardie antwoord alleen as bewys van 'n heffing beskou nie. Rekonsilieer met die rekening se faktureringsrekords en 'n nuwe saldo-opsoek, en kontak ondersteuning as die resultate onduidelik is.

Die voorafbetalingskontrole vereis tans 'n saldo van minstens 0.004 voordat die opsoek gedoen word, ongeag die ingestelde prys per navraag. 'n Rekening waarop aankope gedeaktiveer is, word ook geweier. Hierdie kontroles maak nie van die eindpunt 'n API vir pryskwotasies of bestedingsperke nie.

Foute en herprobeerpogings

Gaan sowel die HTTP-status as status.code/status.msg in JSON na. API-kode 403 kan dui op onvoldoende voorafbetaalde krediet, verbode aankope, 'n probleem met rekeningmagtiging of geen bellernaam wat gevind is nie. Die verwerkingspad vir 'n ontbrekende naam kan die kode as 'n string terugstuur. Lees die boodskap eerder as om elke 403 as foutiewe aanmeldbesonderhede te beskou. Konfigurasiekonflikte kan API-kode 500 terugstuur.

'n Tydverstryking kan ná 'n faktureerbare opsoek voorkom. Gebruik 'n beperkte aantal herprobeerpogings met toenemende wagtye slegs wanneer dit vir jou toepassing gepas is, en rekonsilieer eers pogings waarvan die uitkoms onseker is. Moenie 'n geweierde nommer of 'n versoek wat weens rekeningtoestemming of saldo misluk het, herhaaldelik probeer nie. 'n Antwoordkas in jou eie toepassing kan herhaalde versoeke verminder, onderhewig aan jou ooreenkoms en akkuraatheidsvereistes.

Ander nommerbewerkings

Hierdie leesbewerking staan los van 'n opdatering van die uitgaande oproepnaam/LIDB, 'n gidsinskrywing of bellerregistrasie. Daardie bewerkings het hul eie verpligte velde, magtiging en fooie. Gebruik toewysingsdekking om die voorvoegseltabel na te gaan, of nommersoektog vir nommers wat bestel kan word. Nie een hiervan bevestig dat 'n beller is wie hulle beweer hulle is nie.