Dokumentace REST API

REST API pro tísňová volání

Zaregistrujte číslo a adresu služby, sledujte stav jeho aktivace a udržujte záznam aktuální při změně polohy.

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 APIZákladní URLOvěření a výsledek
Komunikace v3https://api.multitel.net/v3Schvá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/emergencySchválené přihlašovací údaje Basic nebo specificky poskytnutý přístup bearer. JSON code, message a data.
Portálové integrace RESTHostitel a operace jsou uvedeny ve vývojářské referenční dokumentaci vašeho účtuPouž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.

Přečtěte si pokrytí bez registrace čísla

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

https://api.multitel.net/emergency je rovněž podporována. Žádná základní URL tísňové služby neobsahuje /v3. Pokrytí uvádí země podporované mezinárodní službou, podporované typy čísel a ceny; způsobilost pro severoamerickou službu E911 se kontroluje během registrace.

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

Toto ilustruje pouze obálku. Schéma data každé operace si přečtěte v publikovaném průvodci Emergency API.

Registrujte se, sledujte stav a poté nakonfigurujte volání

  1. Pro USA/Kanadu a ostatní podporované severoamerické regiony E911 uveďte číslo, adresu E911 a požadovaná potvrzení souhlasu. Severoamerická služba E911 je pouze produkční.
  2. Pro podporované vlastněné mezinárodní číslo uveďte buď uložený odkaz Document, nebo totožnost a adresu koncového uživatele. Nejprve si prostudujte požadavky země a typu čísla.
  3. Odešlete jeden požadavek POST /registrations. Volitelný Idempotency-Key identifikuje logickou mutaci; zachovejte jej a přesné tělo požadavku napříč opakovanými pokusy.
  4. Přečtěte GET /registrations/:number. Zkontrolujte životní cyklus, pending a actionRequired; vyřešte požadované opravy. Přijetí ani čekání neznamená aktivní službu.
  5. Po aktivaci nakonfigurujte správné nouzové ID volajícího a vytáčecí trasu specifickou pro danou zemi. Použijte ověřovací postup služby pro netísňová volání.

Mezinárodní registrace v sandboxu jsou izolované a neaktivují skutečné tísňové volání. Pro severoamerickou službu E911 jsou vyžadovány přihlašovací údaje hlavního účtu; průvodce vysvětluje omezenou podporu mezinárodních podúčtů.

Ř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.