Soek roete-inligting op
Vra roete-inligting vir 'n Noord-Amerikaanse telefoonnommer aan. Gebruik dit om beskikbare roete- en diensverskafferdata te interpreteer, nie as bewys van die intekenaar se identiteit, eienaarskap van die nommer, bereikbaarheid of beskikbaarheid vir aankoop nie. 'n Opsoekversoek kan 'n heffing op jou rekening veroorsaak.
Versoek
Gebruik jou geaktiveerde API-rekening en die bron-IP-adres wat daarvoor toegelaat word. Verskaf die volledige nommer as syfers, met die landkode 1 ingesluit. Die voorbeeld gebruik omgewingsveranderlikes en 'n fiktiewe nommer. Die hanteerder normaliseer nie leestekens nie; kontroleer die invoer voordat jy dit indien.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
https://api.multitel.net/v3/lrn/12025550123Antwoord
Slegs uitgesoekte velde word ter illustrasie getoon; beskikbaarheid hang van die bron en die tipe nommer af.
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ocn": "0000",
"local": 1,
"ported": 0,
"cost": "$0.00025"
}
}Die standaardopsoekversoek skakel die name van die teruggestuurde velde na kleinletters om. Velde vir die diensverskaffer, tariefsentrum, ligging en jurisdiksie kan na gelang van die bron teenwoordig wees. Die antwoord is nie 'n vaste, volledige intekenaarrekord nie. Die local-vlag kan die numeriese waarde 1 of die stringwaarde 0 hê. Die hanteerder bereken ported deur die teruggestuurde roetenommer met die verskafte telefoonnommer te vergelyk; moenie dit as 'n geverifieerde volledige geskiedenis van nommeroordragte interpreteer nie.
Prys en herprobeerpogings
Die nagegane hanteerder debiteer die rekening met $0.00025 wanneer dit sy voltooiingspad bereik en die opsoekversoek aanteken. Die teruggestuurde koste is gewoonlik 'n string wat die dollarteken insluit, eerder as bloot 'n numeriese bedrag. Geen idempotensiesleutel word beskikbaar gestel nie. As jy 'n versoek herhaal, kan nog 'n heffing ontstaan.
Vir voorafbetaalde rekeninge kontroleer die kode of daar 'n saldo van minstens 0.00025 is. Die boodskap oor 'n onvoldoende saldo noem tans $5, wat nie met daardie drempel ooreenstem nie. Interpreteer die mislukking as 'n weiering weens die saldo en bevestig dat daar geld in die rekening is voordat jy weer probeer.
Mislukkings en onvolledige sukses
Lees sowel die HTTP-status as JSON se status.code/status.msg. 'n Leë resultaat van 'n standaardopsoekversoek gee API-kode 404 terug. API-kode 403 kan op 'n onvoldoende voorafbetaalde saldo dui.
'n Huidige foutpad vir tolvrye nommers kan steeds die opsoekbedrag debiteer en API-kode 200 rapporteer sonder bruikbare roetevelde; die koste-inligting kan onvolledig wees. 'n Kode 200 alleen bevestig dus nie dat die opsoekresultaat bruikbaar is nie. Kontroleer die velde wat jou toepassing nodig het, vergelyk onsekere heffings met die rekening se faktureringsrekords en kontak ondersteuning oor onvolledige resultate.
In die nagegane implementering verskil die hantering van tolvrye nommers volgens die lengte van die invoer. Gebruik verkieslik die volledige internasionale nommer in syfers en bevestig met ondersteuning dat die vereiste tolvrye nommers gedek word. Moenie outomaties weer probeer wanneer 'n resultaat verkeerd geformateer of onvolledig is nie, en moenie op 'n roete-opsoekversoek staatmaak om te besluit dat dit veilig is om 'n nommer te bel of dat jy gemagtig is om dit te bel nie.