REST API-dokumentasjon

REST API-er for nødanrop

Registrer et nummer og en tjenesteadresse, følg aktiveringsstatusen og hold oppføringen oppdatert når posisjonen endres.

Åpne kontospesifikk referanse Utvikler og automatisering

Velg API og legitimasjon sammen

Godkjente kontoer av typen Utvikler og automatisering, Bedrift og Kommunikasjonsleverandører kan integrere aktiverte tjenester. En individuell utvikler trenger ikke å utgi seg for å være et selskap. Applikasjons-SMS/MMS krever gjeldende sendingsgodkjenning og registrering. Tjenesten Privat og familie har ingen kundetilgjengelig API for å starte meldingssending.

API-familie	Basis-URL	Autentisering og resultat
Communications v3	`https://api.multitel.net/v3`	Godkjente Basic-legitimasjoner; kvalifiserte, klargjorte tokener bare for operasjoner som støtter dem. JSON `status` og `response`.
Registrering for nødanrop	`https://api.multi.tel/emergency`	Godkjente Basic-legitimasjoner eller spesifikt klargjort bearer-tilgang. JSON `code`, `message` og `data`.
Portal REST-integrasjoner	Vert og operasjon vises i kontoens utviklerreferanse	Bruk operasjonens dokumenterte legitimasjon, scopes og skjema. Forespørsler fra nettleserøkten er et separat grensesnitt.

Angi MULTITEL_API_USERNAME og MULTITEL_API_PASSWORD via serverens hemmelighetskonfigurasjon før du bruker eksemplene. Legg dem aldri inn i offentlig nettleser-JavaScript, URL-er eller kildekontroll. Dedikerte legitimasjoner administreres i API-integrasjonsinnstillinger.

Les dekning uten å registrere et nummer

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 støttes også. Ingen av basis-URL-ene for nødanrop inneholder /v3. Dekningen lister landene som støttes av den internasjonale tjenesten, støttede nummertyper og priser; nordamerikansk E911-berettigelse kontrolleres under registreringen.

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

Dette illustrerer kun konvolutten. Les hver operasjons data-skjema i den publiserte Emergency API-veiledningen.

Registrer, følg status, og konfigurer deretter anrop

For US/Canada og de andre støttede nordamerikanske E911-regionene må du oppgi nummeret, E911-adressen og nødvendige samtykkebekreftelser. Nordamerikansk E911 er kun for produksjon.
For et støttet eid internasjonalt nummer må du oppgi enten en lagret Document-referanse eller sluttbrukerens identitet og adresse. Gjennomgå kravene til land og nummertype først.
Send én POST /registrations-forespørsel. En valgfri Idempotency-Key identifiserer en logisk mutasjon; behold den og nøyaktig samme nyttelast ved nye forsøk.
Les GET /registrations/:number. Undersøk livssyklus, pending og actionRequired; utbedre nødvendige rettelser. Aksept eller ventende status er ikke aktiv tjeneste.
Etter aktivering må du konfigurere riktig caller-ID for nødanrop og landspesifikk oppringingsrute. Bruk tjenestens verifiseringsprosedyre for ikke-nødanrop.

Internasjonale sandkasseregistreringer er isolerte og aktiverer ikke ekte nødanrop. Hovedkontolegitimasjon kreves for nordamerikansk E911; veiledningen forklarer den begrensede internasjonale underkontostøtten.

Portaloppsett og verifisering Landsdekning og nødnumre Komplett veiledning for offentlige forespørsler, felt, status og nye forsøk

Håndter feil og nye forsøk

Autentiserings- eller tillatelsesfeil: Kontroller API-legitimasjonens aktiverte tilstand, tillatte tjeneste og kilde-IP-begrensning. En informasjonskapsel for portaløkten er ikke en integrasjonslegitimasjon.
Utilstrekkelig kreditt eller manglende godkjenning: Løs problemet med kontosaldo, sendingsgodkjenning eller dokumentkrav før du gjentar operasjonen.
Ingen resultater: Behandle tomt lager eller manglende innringernavn som et vanlig utfall. Ikke anta at et syntaktisk gyldig nummer har alle tjenester.
Nettverkstidsavbrudd eller tjenestefeil: Bruk begrensede nye forsøk med backoff for lesinger. For et kjøp, en sending eller en registrering må du først undersøke operasjonens tilstand; å prøve en akseptert forespørsel på nytt kan duplisere en fakturerbar handling.

Idempotensstøtte tilhører hver API-familie. Emergency API støtter nøkler for nye forsøk; det gjør ikke vilkårlige v3-forespørsler idempotente. Behold tidsstempler, returnerte ID-er og sladdede responser for brukerstøtte.

Fortsett med referansen for kontoen din

Den innloggede referansen filtrerer operasjoner etter tillatelsene dine og aktiverte tjenester. Bruk nøyaktig vert, legitimasjonstype, forespørselsfelt og responsskjema der. Konsollene kan utføre live-operasjoner, inkludert kjøp og meldinger.

Kontospesifikk endepunktkatalog REST-konsoll for kommunikasjon Offentlig OpenAPI-dokument for kommunikasjon Veiledning for OAuth-integrasjon