REST API dokumentācija
LRN maršrutēšanas meklēšanas REST API
Noskaidrojiet Ziemeļamerikas tālruņa numura maršrutēšanas numuru un pieejamo informāciju par operatoru par vienotu maksu par uzziņu.
Izvēlieties API un akreditācijas datus kopā
Apstiprināti konti kategorijās Izstrādātājiem un automatizācijai, Bizness un Sakaru pakalpojumu sniedzēji var integrēt iespējotus pakalpojumus. Individuālam izstrādātājam nav jāizliekas par uzņēmumu. Lietojumprogrammu SMS/MMS nepieciešams atbilstošs sūtīšanas apstiprinājums un reģistrācija. Pakalpojumam Privātpersonām un ģimenēm nav klientiem pieejama API ziņojumu sūtīšanas sākšanai.
| API saime | Bāzes URL | Autentifikācija un rezultāts |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Apstiprināti Basic akreditācijas dati; atbilstoši nodrošināti pilnvarojumi tikai darbībām, kas tos atbalsta. JSON status un response. |
| Reģistrācija ārkārtas zvanu pakalpojumam | https://api.multi.tel/emergency | Apstiprināti Basic akreditācijas dati vai īpaši nodrošināta bearer piekļuve. JSON code, message un data. |
| Portāla REST integrācijas | Resursdators un darbība ir norādīta jūsu konta izstrādātāju uzziņā | Izmantojiet šīs darbības dokumentētos akreditācijas datus, tvērumus un shēmu. Pārlūkprogrammas sesijas pieprasījumi ir atsevišķa saskarne. |
Pirms piemēru izmantošanas iestatiet MULTITEL_API_USERNAME un MULTITEL_API_PASSWORD, izmantojot sava servera slepeno konfigurāciju. Nekad neieguliet tos publiskā pārlūkprogrammas JavaScript kodā, URL vai pirmkoda kontrolē. Speciālie akreditācijas dati tiek pārvaldīti sadaļā API integrācijas iestatījumi.
Meklējiet numuru
GET /v3/lrn/{number} ceļā pieņem galamērķa numuru. Neobligātu zvanītāja numuru var norādīt kā /v3/lrn/{number}/{ani}, lai iegūtu no zvana izcelsmes atkarīgu informāciju. Ziemeļamerikas tālruņa numurus rakstiet tikai ar cipariem, attiecīgos gadījumos iekļaujot valsts kodu; piemēros tiek izmantoti rezervēti izdomāti numuri.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123"curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123/12025550124"Uzziņas izpilde ar derīgiem akreditācijas datiem ir apmaksājama. Likme ir 0,00025 $ par uzziņu: 0,25 $ par 1000 vai 250 $ par miljonu. Nav apjoma atlaides. Šī ir maršrutēšanas informācijas uzziņa; tā neveic telefona zvanu.
Nolasiet rezultātu
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Šis izdomātais piemērs parāda tikai atbildes formu; tas nav izmērīts maršrutēšanas rezultāts. Pārbaudiet status.code pirms response izmantošanas. Lauks cost ir virkne ar valūtas prefiksu, nevis JSON skaitlis.
| Lauks | Nozīme |
|---|---|
lrn | Atrašanās vietas maršrutēšanas numurs, ko izmanto maršrutēšanas galamērķa identificēšanai. |
ported | Šīs uzziņas sniegtais rādītājs, vai numurs ir pārnests: parasti 0 vai 1. Neizmantojiet to kā īpašumtiesību vai pakalpojuma atbilstības pierādījumu. |
ocn | Operējošās kompānijas numurs, ja tas ir norādīts. |
lata | Vietējās piekļuves un transporta apgabals, ja tas ir norādīts. |
rc | Tarifa centrs, ja tas ir norādīts. |
city, state, lec, lectype, jurisdiction, local | Papildu atrašanās vietas, operatora vai ar izcelsmi saistīta informācija, ja pieejama. Tā var nebūt vai būt tukša. |
Nepieprasiet, lai būtu aizpildīti visi maršrutēšanas lauki. Jo īpaši rezultātos par numuriem, uz kuriem zvanītājs var zvanīt bez maksas, var nebūt vietējā tarifa centra un operatora koda informācijas. Atgrieztais LRN nav reāllaika sasniedzamības garantija vai zvanu kvalitātes tests.
Izmantojiet uzziņas savā maršrutēšanas darbplūsmā
- Pirms nosūtīšanas pārbaudiet un normalizējiet pieprasīto numuru.
- Pārbaudiet HTTP un lietojumprogrammas statusu. Traucējummeklēšanai saglabājiet ierakstu par numuru, laiku un rezultātu, izņemot no tā sensitīvos datus.
- Izmantojiet tikai jūsu maršrutēšanas kārtulai atbilstošos laukus un nepārprotami apstrādājiet trūkstošās vērtības.
- Ierobežojiet atkārtojumus pēc nenoteiktas atbildes. Uzziņas atkārtošana var radīt vēl vienu maksu; šim galapunktam nav dokumentētas idempotences atslēgas.
Skatiet LRN produktu un vienoto cenu. Publiskais OpenAPI ceļš ietver ANI segmentu; izvietotā LRN implementācija pieņem arī īsāko pieprasījumu bez ANI. lrninfo ir atsevišķa darbība, un to nedrīkst izmantot šī galapunkta vietā.
Apstrādājiet kļūdas un atkārtojumus
- Autentifikācijas vai atļaujas kļūme
- Pārbaudiet API akreditācijas datu iespējoto stāvokli, atļauto pakalpojumu un avota IP ierobežojumu. Portāla sesijas sīkfails nav integrācijas akreditācijas dati.
- Nepietiekams kredīts vai neizpildīts apstiprinājums
- Pirms darbības atkārtošanas sakārtojiet konta bilanci, sūtīšanas apstiprinājumu vai dokumentu prasību.
- Nav rezultāta
- Tukšu krājumu vai trūkstošu zvanītāja vārdu uzskatiet par parastu iznākumu. Nepieņemiet, ka sintaktiski derīgam numuram ir visi pakalpojumi.
- Tīkla noildze vai pakalpojuma kļūme
- Lasīšanai izmantojiet ierobežotus atkārtojumus ar aizkavi. Pirkumam, sūtīšanai vai reģistrācijai vispirms pārbaudiet darbības stāvokli; pieņemta pieprasījuma atkārtošana var dublēt apmaksājamu darbību.
Idempotences atbalsts ir atkarīgs no API saimes. Emergency API atbalsta atkārtošanas atslēgas; tas nepadara patvaļīgus v3 pieprasījumus par idempotentiem. Atbalstam saglabājiet laikspiedolus, atgrieztos ID un atbildes, no kurām izņemti sensitīvie dati.
Turpiniet ar sava konta atsauci
Pēc pierakstīšanās pieejamā dokumentācija filtrē darbības atbilstoši jūsu atļaujām un iespējotajiem pakalpojumiem. Izmantojiet tajā norādīto precīzo resursdatoru, akreditācijas datu veidu, pieprasījuma laukus un atbildes shēmu. Konsoles var veikt reālas darbības, tostarp pirkumus un ziņojumu sūtīšanu.