Dokumentace REST API
REST API pro vyhledání směrování LRN
Vyhledejte směrovací číslo a dostupné informace o operátorovi pro severoamerické telefonní číslo za jednotnou cenu za vyhledání.
Vyberte API a přihlašovací údaje společně
Schválené účty v kategoriích Vývojáři a automatizace, Firemní a Poskytovatelé komunikačních služeb mohou integrovat povolené služby. Jednotlivý vývojář nemusí předstírat, že je firmou. Aplikační SMS/MMS vyžaduje příslušné schválení odesílání a registraci. Služba Pro jednotlivce a rodiny nemá žádné zákaznicky přístupné API pro zahájení odesílání zpráv.
| Rodina API | Základní URL | Ověření a výsledek |
|---|---|---|
| Komunikace v3 | https://api.multitel.net/v3 | Schválené přihlašovací údaje Basic; způsobilé poskytnuté tokeny pouze pro operace, které je podporují. JSON status a response. |
| Registrace tísňového volání | https://api.multi.tel/emergency | Schválené přihlašovací údaje Basic nebo specificky poskytnutý přístup bearer. JSON code, message a data. |
| Portálové integrace REST | Hostitel a operace jsou uvedeny ve vývojářské referenční dokumentaci vašeho účtu | Použijte zdokumentované přihlašovací údaje, rozsahy a schéma dané operace. Požadavky relace prohlížeče představují samostatné rozhraní. |
Před použitím příkladů nastavte MULTITEL_API_USERNAME a MULTITEL_API_PASSWORD prostřednictvím konfigurace tajných údajů vašeho serveru. Nikdy je nevkládejte do veřejného kódu JavaScript v prohlížeči, do adres URL ani do správy zdrojového kódu. Vyhrazené přihlašovací údaje se spravují v nastavení integrace API.
Vyhledejte číslo
GET /v3/lrn/{number} přijímá cílové číslo v cestě. Volitelné číslo volajícího lze zadat jako /v3/lrn/{number}/{ani} pro informace závislé na původu hovoru. Severoamerická telefonní čísla zadávejte pouze číslicemi a tam, kde je to relevantní, včetně kódu země; příklady používají vyhrazená fiktivní čísla.
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"Spuštění vyhledávání s platnými přihlašovacími údaji je zpoplatněno. Sazba činí 0,00025 US$ za vyhledání: 0,25 US$ za 1 000 nebo 250 US$ za milion. Neposkytují se žádné množstevní slevy. Jedná se o vyhledání směrovacích informací; nezahajuje telefonní hovor.
Přečtěte si výsledek
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Tento vymyšlený příklad ukazuje pouze tvar odpovědi; nejedná se o naměřený výsledek směrování. Zkontrolujte status.code před použitím response. Pole cost je řetězec s předponou měny, nikoli číslo JSON.
| Pole | Význam |
|---|---|
lrn | Location Routing Number používané k identifikaci směrovacího cíle. |
ported | Indikátor, zda bylo číslo přeneseno, poskytovaný tímto vyhledáváním: obvykle 0 nebo 1. Nepoužívejte jej jako důkaz vlastnictví ani způsobilosti služby. |
ocn | Operating Company Number, je-li uvedeno. |
lata | Local Access and Transport Area, je-li uvedeno. |
rc | Rate center, je-li uvedeno. |
city, state, lec, lectype, jurisdiction, local | Další údaje o poloze, operátorovi nebo původu, jsou-li k dispozici. Mohou chybět nebo být prázdné. |
Nevyžadujte přítomnost všech směrovacích polí. Zejména výsledky pro toll-free čísla mohou vynechat údaje o místním středisku sazeb a kódu operátora. Vrácené LRN není zárukou dosažitelnosti v reálném čase ani testem kvality hovoru.
Používejte vyhledávání ve svém směrovacím postupu
- Před odesláním požadované číslo ověřte a normalizujte.
- Zkontrolujte stav HTTP a aplikační stav. Pro řešení problémů uchovávejte záznam čísla, času a výsledku po odstranění citlivých údajů.
- Používejte pouze pole relevantní pro vaše směrovací pravidlo a chybějící hodnoty zpracujte výslovně.
- Po nejisté odpovědi omezte opakované pokusy. Opakování vyhledávání může vést k dalšímu poplatku; tento koncový bod nemá zdokumentovaný klíč idempotence.
Viz produkt LRN a jednotná cena za vyhledání. Veřejná cesta OpenAPI obsahuje segment ANI; nasazená implementace LRN přijímá také kratší požadavek bez ANI. Operace lrninfo je samostatná a neměla by se za tento koncový bod zaměňovat.
Řešení chyb a opakovaných pokusů
- Selhání ověření nebo nedostatečná oprávnění
- Zkontrolujte stav povolení přihlašovacích údajů API, povolenou službu a omezení zdrojové IP adresy. Soubor cookie portálové relace není integračním přihlašovacím údajem.
- Nedostatečný kredit nebo nesplněné schválení
- Před opakováním operace vyřešte zůstatek účtu, schválení odesílání nebo požadavek na dokumenty.
- Žádný výsledek
- Prázdný inventář nebo chybějící jméno volajícího považujte za běžný výsledek. Nepředpokládejte, že syntakticky platné číslo má všechny služby.
- Vypršení síťového časového limitu nebo selhání služby
- Pro čtení používejte omezený počet opakovaných pokusů s prodlužováním čekací doby. U nákupu, odeslání nebo registrace nejprve zkontrolujte stav operace; opakování přijatého požadavku může duplikovat zpoplatněnou akci.
Podpora idempotence náleží každé rodině API. Rozhraní Emergency API podporuje klíče pro opakování; to však nečiní libovolné požadavky v3 idempotentními. Pro podporu uchovávejte časová razítka, vrácená ID a odpovědi po odstranění citlivých údajů.
Pokračujte referencí svého účtu
Referenční dokumentace po přihlášení filtruje operace podle vašich oprávnění a povolených služeb. Použijte v ní uvedeného přesného hostitele, typ přihlašovacích údajů, pole požadavku a schéma odpovědi. Konzole mohou provádět ostré operace, včetně nákupů a odesílání zpráv.