REST API dokumentáció
LRN útvonal-keresési REST API
Kérdezze le egy észak-amerikai telefonszám útválasztási számát és az elérhető szolgáltatói információkat egységes áron.
Az API-t és a hitelesítő adatot együtt válassza ki
A jóváhagyott Fejlesztők és automatizálás, Üzleti és Kommunikációs szolgáltatók profilú fiókok integrálhatják az engedélyezett szolgáltatásokat. Egy magánfejlesztőnek nem kell cégnek kiadnia magát. Az alkalmazásból küldött SMS/MMS-hez a megfelelő küldési jóváhagyás és regisztráció szükséges. A Magánszemélyek és családok szolgáltatáshoz nem tartozik ügyfelek számára elérhető üzenetküldő API.
| API-család | Alap-URL | Hitelesítés és eredmény |
|---|---|---|
| Kommunikációs v3 | https://api.multitel.net/v3 | Jóváhagyott Basic hitelesítő adatok; jogosult, kiosztott tokenek csak az azokat támogató műveleteknél. JSON status és response. |
| Segélyhívási regisztráció | https://api.multi.tel/emergency | Jóváhagyott Basic hitelesítő adatok vagy kifejezetten kiosztott bearer hozzáférés. JSON code, message és data. |
| Portál REST-integrációk | A fiókja fejlesztői referenciájában látható gazdagép és művelet | Használja az adott művelet dokumentált hitelesítő adatát, hatóköreit és sémáját. A böngészős munkamenetkérések külön felületet jelentenek. |
A példák használata előtt állítsa be az MULTITEL_API_USERNAME és az MULTITEL_API_PASSWORD értékét a szervere titokkezelő konfigurációjában. Soha ne helyezze ezeket nyilvános böngészős JavaScriptbe, URL-ekbe vagy a verziókezelőbe. A külön hitelesítő adatokat az API-integráció beállításaiban kezelheti.
Szám lekérdezése
A GET /v3/lrn/{number} az URL útvonalában várja a célszámot. A hívó számától függő információhoz opcionálisan megadható a hívó száma az /v3/lrn/{number}/{ani} formában. Az észak-amerikai számokat csak számjegyekkel, ahol szükséges, országkóddal együtt adja meg; a példák erre fenntartott, kitalált számokat használnak.
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"Érvényes hitelesítő adatokkal végzett lekérdezés díjköteles. A díj 0,00025 USD lekérdezésenként: 0,25 USD 1000 lekérdezésenként, illetve 250 USD egymillió lekérdezésenként. Mennyiségi kedvezmény nincs. Ez egy útválasztási információ lekérdezése; nem kezdeményez telefonhívást.
Az eredmény értelmezése
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Ez a kitalált példa csak a válasz szerkezetét mutatja be; nem mért útválasztási eredmény. A response használata előtt ellenőrizze a status.code értékét. A cost mező pénznem-előtagos szöveg, nem JSON-szám.
| Mező | Jelentés |
|---|---|
lrn | Útválasztási szám (Location Routing Number), amely az útválasztási cél azonosítására szolgál. |
ported | A lekérdezés által megadott számhordozhatósági jelző: jellemzően 0 vagy 1. Ne használja a tulajdonjog vagy a szolgáltatásra való jogosultság bizonyítékaként. |
ocn | Szolgáltatói azonosítószám (Operating Company Number), ha meg van adva. |
lata | Helyi hozzáférési és átviteli terület (Local Access and Transport Area), ha meg van adva. |
rc | Díjszabási központ (rate center), ha meg van adva. |
city, state, lec, lectype, jurisdiction, local | További hely-, szolgáltató- vagy származással kapcsolatos részletek, ha elérhetők. Hiányozhatnak, vagy üresek lehetnek. |
Ne feltételezze, hogy minden útválasztási mező szerepel az eredményben. Különösen a hívó fél számára díjmentes számok eredményeiből hiányozhatnak a helyi díjszabási központra és a szolgáltatókódra vonatkozó részletek. A visszaadott LRN nem garantálja a szám pillanatnyi elérhetőségét, és nem hívásminőség-teszt.
Lekérdezések használata az útválasztási munkafolyamatban
- A kérés elküldése előtt ellenőrizze és normalizálja a lekérdezendő számot.
- Vizsgálja meg a HTTP- és az alkalmazásállapotot. Hibaelhárításhoz őrizzen meg egy kitakart nyilvántartást a számról, az időpontról és az eredményről.
- Csak az útválasztási szabályához releváns mezőket használja, és a hiányzó értékeket kezelje kifejezetten.
- Bizonytalan válasz után korlátozza az újrapróbálkozásokat. A lekérdezés megismétlése újabb díjat eredményezhet; ehhez a végponthoz nincs dokumentált idempotenciakulcs.
Tekintse meg az LRN-terméket és az egységes lekérdezési díjakat. A nyilvános OpenAPI-útvonal tartalmaz ANI-szegmenst; a működő LRN-megvalósítás az ANI nélküli rövidebb kérést is elfogadja. Az lrninfo külön művelet, ezért ne használja e végpont helyett.
Hibák és újrapróbálkozások kezelése
- Hitelesítési vagy jogosultsági hiba
- Ellenőrizze az API-hitelesítő adat engedélyezett állapotát, az engedélyezett szolgáltatást és a forrás-IP-korlátozást. A portál munkamenet-sütije nem integrációs hitelesítő adat.
- Elégtelen egyenleg vagy hiányzó jóváhagyás
- A művelet megismétlése előtt rendezze a fiók egyenlegét, a küldési jóváhagyást vagy a dokumentumkövetelményt.
- Nincs eredmény
- Az üres készletet vagy a hiányzó hívónevet kezelje szokásos kimenetelként. Ne feltételezze, hogy egy szintaktikailag érvényes számhoz minden szolgáltatás elérhető.
- Hálózati időtúllépés vagy szolgáltatáshiba
- Olvasási műveleteknél korlátozza az újrapróbálkozások számát, és alkalmazzon várakozást a próbálkozások között (backoff). Vásárlás, küldés vagy regisztráció esetén először vizsgálja meg a művelet állapotát; egy már elfogadott kérés megismétlése megkettőzheti a díjköteles műveletet.
Az idempotencia támogatása API-családonként eltérő. Az Emergency API támogatja az újrapróbálási kulcsokat, de ettől a tetszőleges v3-kérések még nem lesznek idempotensek. Az ügyfélszolgálat számára őrizze meg az időbélyegeket, a visszaadott azonosítókat és a kitakart válaszokat.
Folytassa a fiókjához tartozó referenciával
A bejelentkezett állapotban elérhető referencia a műveleteket a jogosultságai és az engedélyezett szolgáltatások szerint szűri. Használja annak pontos hosztját, hitelesítő adat típusát, kérésmezőit és válaszsémáját. A konzolok éles műveleteket is végrehajthatnak, beleértve a vásárlásokat és az üzenetküldést.