REST API dokumentáció

Segélyhívási REST API-k

Regisztráljon egy számot és szolgáltatási címet, kövesse nyomon az aktiválási állapotot, és tartsa karban a bejegyzést a helyszín változásakor.

Fiókspecifikus referencia megnyitása Fejlesztők és automatizálás

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.

Lefedettség olvasása szám regisztrálása nélkül

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

Az https://api.multitel.net/emergency is támogatott. Egyik segélyhívási alap-URL sem tartalmazza a /v3 részt. A lefedettség felsorolja a nemzetközi országokat, a támogatott számtípusokat és az árakat; az észak-amerikai E911-jogosultságot a regisztráció során ellenőrzik.

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

Ez csak a válaszburkolatot szemlélteti. Az egyes műveletek data sémáját az közzétett Emergency API útmutatóban olvashatja.

Regisztráció, állapotkövetés, majd a hívás konfigurálása

Az USA-ban/Kanadában és a többi támogatott észak-amerikai E911-régióban adja meg a számot, az E911-címet és a szükséges hozzájárulási nyilatkozatokat. Az észak-amerikai E911 kizárólag éles környezetben működik.
Támogatott, saját tulajdonú nemzetközi számhoz adjon meg egy mentett dokumentumhivatkozást vagy a végfelhasználó személyazonosságát és címét. Előbb tekintse át az ország és a számtípus követelményeit.
Küldjön egy POST /registrations kérést. Egy opcionális Idempotency-Key egy logikai módosítást azonosít; őrizze meg azt és a pontos adattartalmat az újrapróbálkozások során.
Kérdezze le az állapotot: GET /registrations/:number. Vizsgálja meg az életciklus-állapotot, valamint a pending és az actionRequired értékét; végezze el a szükséges javításokat. Az elfogadás vagy a függőben lévő állapot nem jelent aktív szolgáltatást.
Az aktiválás után állítsa be a megfelelő segélyhívó hívóazonosítót és az országspecifikus tárcsázási útvonalat. Használja a szolgáltatás segélyhívást nem igénylő ellenőrzési eljárását.

A nemzetközi sandbox-regisztrációk elszigeteltek, és nem aktiválnak valódi segélyhívást. Az észak-amerikai E911-hez a főfiók hitelesítő adatai szükségesek; az útmutató ismerteti a nemzetközi alfiókok korlátozott támogatását.

Portálbeállítás és ellenőrzés Országok lefedettsége és segélyhívó számok Teljes nyilvános útmutató a kérésekről, mezőkről, állapotról és újrapróbálkozásról

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.

Fiókspecifikus végpontkatalógus Kommunikációs REST konzol Nyilvános kommunikációs OpenAPI-dokumentum OAuth integrációs útmutató