REST API -dokumentaatio

Hätäpuhelujen REST API:t

Rekisteröi numero ja palveluosoite, seuraa aktivoinnin tilaa ja pidä tietue ajan tasalla sijainnin muuttuessa.

Avaa tilikohtainen viite Kehittäjät ja automaatio

Valitse API ja tunnistetieto yhdessä

Hyväksytyt Kehittäjät ja automaatio-, Yritys- ja Viestintäpalveluntarjoajat-tilit voivat integroida käytössä olevia palveluja. Yksittäisen kehittäjän ei tarvitse esiintyä yrityksenä. Sovellusten SMS/MMS edellyttää soveltuvaa lähetyshyväksyntää ja rekisteröintiä. Henkilöt ja perheet -palvelulla ei ole asiakkaan käytettävissä olevaa viestien lähetyksen API-rajapintaa.

API-perhe	Perus-URL	Todennus ja tulos
Communications v3	`https://api.multitel.net/v3`	Hyväksytyt Basic-tunnistetiedot; oikeutetut provisionoidut tunnukset vain toimintoihin, jotka tukevat niitä. JSON-muotoiset `status` ja `response`.
Hätäpalvelun rekisteröinti	`https://api.multi.tel/emergency`	Hyväksytyt Basic-tunnistetiedot tai erikseen provisionoitu bearer-käyttöoikeus. JSON-muotoiset `code`, `message` ja `data`.
Portaalin REST-integraatiot	Isäntä ja toiminto on esitetty tilisi kehittäjäviitteessä	Käytä kyseisen toiminnon dokumentoitua tunnistetietoa, käyttöoikeuksia ja skeemaa. Selainistunnon pyynnöt ovat erillinen rajapinta.

Määritä MULTITEL_API_USERNAME ja MULTITEL_API_PASSWORD palvelimesi salaisuuksien hallinnan kautta ennen esimerkkien käyttöä. Älä koskaan upota niitä julkiseen selaimen JavaScript-koodiin, URL-osoitteisiin tai versionhallintaan. Erillisiä tunnistetietoja hallitaan kohdassa API-integraation asetukset.

Lue kattavuus rekisteröimättä numeroa

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 on myös tuettu. Kumpikaan hätäpalvelun perus-URL ei sisällä /v3-elementtiä. Kattavuus luettelee kansainvälisen palvelun tukemat maat, tuetut numerotyypit ja hinnat; Pohjois-Amerikan E911-kelpoisuus tarkistetaan rekisteröinnin yhteydessä.

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

Tämä havainnollistaa vain kehystä. Lue kunkin toiminnon data-skeema julkaistusta Emergency API -oppaasta.

Rekisteröi, seuraa tilaa ja määritä sitten puhelut

Yhdysvaltojen/Kanadan ja muiden tuettujen Pohjois-Amerikan E911-alueiden osalta anna numero, E911-osoite ja vaaditut suostumusvahvistukset. Pohjois-Amerikan E911 on vain tuotantokäytössä.
Tuetun omistetun kansainvälisen numeron osalta anna joko tallennettu Document-viittaus tai loppukäyttäjän henkilöllisyys ja osoite. Tutustu ensin maa- ja numerotyyppikohtaisiin vaatimuksiin.
Lähetä yksi POST /registrations-pyyntö. Valinnainen Idempotency-Key yksilöi loogisen muutoksen; säilytä se ja tarkka hyötykuorma uudelleenyritysten välillä.
Lue GET /registrations/:number. Tarkista elinkaari, pending ja actionRequired; tee vaaditut korjaukset. Hyväksyntä tai odottava tila ei ole aktiivista palvelua.
Määritä käyttöönoton jälkeen oikea hätäpuhelun soittajatunnus ja maakohtainen valintareitti. Käytä palvelun ei-hätäluonteista vahvistusmenettelyä.

Kansainväliset hiekkalaatikkorekisteröinnit ovat eristettyjä eivätkä aktivoi oikeita hätäpuheluita. Pohjois-Amerikan E911 edellyttää päätilin tunnistetietoja; opas selittää kansainvälisten alatilien rajoitetun tuen.

Portaalin käyttöönotto ja vahvistus Maakattavuus ja hätänumerot Täydellinen julkinen opas pyynnöistä, kentistä, tilasta ja uudelleenyrityksistä

Käsittele virheet ja uudelleenyritykset

Todennus- tai käyttöoikeusvirhe: Tarkista API-tunnistetiedon käytössäolotila, sallittu palvelu ja lähde-IP-rajoitus. Portaalin istuntoeväste ei ole integraation tunnistetieto.
Riittämätön saldo tai puuttuva hyväksyntä: Selvitä tilin saldo, lähetyshyväksyntä tai asiakirjavaatimus ennen toiminnon toistamista.
Ei tulosta: Käsittele tyhjää varastoa tai puuttuvaa soittajan nimeä tavallisena tuloksena. Älä oleta, että syntaktisesti kelvollisella numerolla on kaikki palvelut.
Verkon aikakatkaisu tai palveluvirhe: Käytä lukutoiminnoissa rajoitettuja uudelleenyrityksiä viiveen pidennyksellä. Tarkista oston, lähetyksen tai rekisteröinnin yhteydessä ensin toiminnon tila; hyväksytyn pyynnön uudelleenyritys voi monistaa laskutettavan toiminnon.

Idempotenssituki määräytyy API-perhekohtaisesti. Emergency API tukee uudelleenyritysavaimia; se ei tee mielivaltaisista v3-pyynnöistä idempotentteja. Säilytä aikaleimat, palautetut tunnukset ja sensuroidut vastaukset tukea varten.

Jatka tilisi viiteaineistoon

Kirjautuneen käyttäjän viiteaineisto näyttää toiminnot käyttöoikeuksien ja käytössä olevien palvelujen mukaan. Käytä siinä ilmoitettua tarkkaa isäntää, tunnistetietotyyppiä, pyyntökenttiä ja vastausskeemaa. Konsolit voivat suorittaa todellisia toimintoja, myös ostoja ja viestien lähetyksiä.

Tilikohtainen päätepisteluettelo Communications REST -konsoli Julkinen Communications OpenAPI -dokumentti OAuth-integraatiota koskeva opas