REST API-dokumentation
REST API'er til nødopkald
Registrer et nummer og en serviceadresse, følg aktiveringsstatussen, og vedligehold registreringen, når placeringen ændres.
Vælg API og legitimation sammen
Godkendte konti med profilerne Udvikler og automatisering, Erhverv og Kommunikationsudbydere kan integrere aktiverede tjenester. En individuel udvikler behøver ikke give sig ud for at være en virksomhed. SMS/MMS fra applikationer kræver den relevante afsendelsesgodkendelse og registrering. Tjenesten for Privatpersoner og familier har ingen API tilgængelig for kunder til afsendelse af beskeder.
| API-familie | Basis-URL | Autentificering og resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkendt Basic-legitimation; kvalificerede tildelte tokens kun til handlinger, der understøtter dem. JSON status og response. |
| Nødopkaldsregistrering | https://api.multi.tel/emergency | Godkendt Basic-legitimation eller specifikt tildelt bearer-adgang. JSON code, message og data. |
| Portal-REST-integrationer | Vært og handling vist i din kontos udviklerreference | Brug den pågældende handlings dokumenterede legitimation, scopes og skema. Anmodninger fra browsersessioner bruger en separat grænseflade. |
Angiv MULTITEL_API_USERNAME og MULTITEL_API_PASSWORD via din servers konfiguration af hemmeligheder, før du bruger eksemplerne. Indlejr dem aldrig i offentlig JavaScript i browseren, i URL’er eller i kildekodestyring. Dedikerede legitimationsoplysninger administreres i indstillinger for API-integration.
Læs dækning uden at 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 understøttes også. Ingen af nødopkaldenes basis-URL’er indeholder /v3. Dækningen viser internationale lande, understøttede nummertyper og priser; berettigelse til nordamerikansk E911 kontrolleres under registreringen.
{
"code": 200,
"message": "",
"environment": "production",
"requestId": "EXAMPLE_REQUEST_ID",
"data": {}
}Dette illustrerer kun konvolutten. Læs hver handlings data-skema i den offentliggjorte guide til Emergency API.
Registrér, følg status, og konfigurér derefter opkald
- For USA/Canada og de øvrige understøttede nordamerikanske E911-regioner skal du angive nummeret, E911-adressen og de krævede samtykkebekræftelser. Nordamerikansk E911 findes kun i produktion.
- For et understøttet internationalt nummer, som du ejer, skal du angive enten en gemt Document-reference eller slutbrugerens identitet og adresse. Gennemgå først kravene for land og nummertype.
- Send én
POST /registrations-anmodning. En valgfriIdempotency-Keyidentificerer en logisk ændring; bevar den og den præcise payload ved nye forsøg. - Læs
GET /registrations/:number. Kontrollér livscyklus,pendingogactionRequired; ret de krævede fejl. Accept eller afventende status er ikke aktiv tjeneste. - Efter aktivering skal du konfigurere det korrekte opkaldernummer til nødopkald og den landespecifikke opkaldsrute. Brug tjenestens verifikationsprocedure, som ikke foretager et nødopkald.
Internationale sandbox-registreringer er isolerede og aktiverer ikke rigtige nødopkald. Legitimationsoplysninger til hovedkontoen er påkrævet for nordamerikansk E911; guiden forklarer den begrænsede understøttelse af internationale underkonti.
Håndtering af fejl og nye forsøg
- Fejl i autentificering eller tilladelser
- Kontrollér, om API-legitimationen er aktiveret, hvilken tjeneste den har tilladelse til, og hvilke begrænsninger der gælder for kilde-IP. En portalsessions-cookie er ikke en integrationslegitimation.
- Utilstrækkelig saldo eller manglende godkendelse
- Løs problemet med kontosaldoen, afsendelsesgodkendelsen eller dokumentkravet, før du gentager handlingen.
- Intet resultat
- Behandl et tomt lager eller et manglende opkaldsnavn som et almindeligt udfald. Antag ikke, at et syntaktisk gyldigt nummer har alle tjenester.
- Netværkstimeout eller tjenestefejl
- Brug begrænsede nye forsøg med backoff ved læsninger. Ved et køb, en afsendelse eller en registrering skal du først kontrollere handlingens tilstand; et nyt forsøg på en accepteret anmodning kan duplikere en handling, der medfører betaling.
Understøttelse af idempotens gælder for den enkelte API-familie. Emergency API’et understøtter nøgler til nye forsøg; det gør ikke vilkårlige v3-anmodninger idempotente. Gem tidsstempler, returnerede ID’er og svar, hvor følsomme oplysninger er fjernet, til support.
Fortsæt med din kontos reference
Den indloggede reference filtrerer operationer efter dine rettigheder og aktiverede tjenester. Brug dens præcise host, legitimationstype, forespørgselsfelter og svarskema. Konsollerne kan udføre live-operationer, herunder køb og beskeder.