REST API-documentatie
REST-API’s voor noodoproepen
Registreer een nummer en dienstadres, volg de activeringsstatus en houd het record bij wanneer de locatie verandert.
Kies de API en de inloggegevens samen
Goedgekeurde accounts met het profiel Ontwikkelaars en automatisering, Zakelijk of Communicatieaanbieders kunnen ingeschakelde diensten integreren. Een individuele ontwikkelaar hoeft zich niet als bedrijf voor te doen. Applicatie-SMS/MMS vereist de toepasselijke verzendgoedkeuring en registratie. De dienst voor Particulieren en gezinnen heeft geen voor klanten toegankelijke API voor het verzenden van berichten.
| API-familie | Basis-URL | Authenticatie en resultaat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Goedgekeurde Basic-inloggegevens; in aanmerking komende geprovisioneerde tokens alleen voor bewerkingen die deze ondersteunen. JSON status en response. |
| Noodregistratie | https://api.multi.tel/emergency | Goedgekeurde Basic-inloggegevens of specifiek geprovisioneerde bearer-toegang. JSON code, message en data. |
| REST-integraties van de portal | Host en bewerking zoals getoond in de ontwikkelaarsreferentie van uw account | Gebruik de gedocumenteerde inloggegevens, scopes en het schema van die bewerking. Verzoeken vanuit een browsersessie vormen een afzonderlijke interface. |
Stel MULTITEL_API_USERNAME en MULTITEL_API_PASSWORD in via de geheime configuratie van uw server voordat u de voorbeelden gebruikt. Sluit ze nooit in in openbaar browser-JavaScript, URL’s of broncodebeheer. Specifieke inloggegevens beheert u in de instellingen voor API-integratie.
Dekking lezen zonder een nummer te registreren
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 wordt ook ondersteund. Geen van beide basis-URL’s voor noodoproepen bevat /v3. De dekking toont internationale landen, ondersteunde nummertypen en prijzen; de geschiktheid voor Noord-Amerikaanse E911 wordt tijdens de registratie gecontroleerd.
{
"code": 200,
"message": "",
"environment": "production",
"requestId": "EXAMPLE_REQUEST_ID",
"data": {}
}Dit illustreert alleen de envelop. Lees het data-schema van elke bewerking in de gepubliceerde Emergency API-gids.
Registreren, de status volgen en daarna het bellen configureren
- Geef voor de VS/Canada en de andere ondersteunde Noord-Amerikaanse E911-regio’s het nummer, het E911-adres en de vereiste toestemmingsverklaringen op. Noord-Amerikaanse E911 is uitsluitend voor productie.
- Geef voor een ondersteund internationaal nummer waarvan u eigenaar bent een opgeslagen Document-referentie op, of de identiteit en het adres van de eindgebruiker. Lees eerst de vereisten voor het land en het nummertype.
- Verstuur één
POST /registrations-verzoek. Een optioneleIdempotency-Keyidentificeert een logische mutatie; bewaar deze en de exacte payload bij nieuwe pogingen. - Lees
GET /registrations/:number. Controleer de levenscyclus,pendingenactionRequired; los vereiste correcties op. Acceptatie of in behandeling betekent niet dat de dienst actief is. - Configureer na activering de juiste beller-ID voor noodoproepen en de landspecifieke kiesroute. Gebruik de verificatieprocedure van de dienst waarbij geen noodoproep wordt geplaatst.
Internationale sandboxregistraties zijn geïsoleerd en activeren geen echte noodoproepen. Voor Noord-Amerikaanse E911 zijn inloggegevens van het hoofdaccount vereist; de gids legt de beperkte ondersteuning voor internationale subaccounts uit.
Fouten en nieuwe pogingen afhandelen
- Fout in authenticatie of machtiging
- Controleer of de API-inloggegevens zijn ingeschakeld, welke dienst is toegestaan en welke beperking voor het bron-IP-adres geldt. Een sessiecookie van het portaal is geen inloggegeven voor integratie.
- Onvoldoende tegoed of niet voldaan aan goedkeuring
- Los het accountsaldo, de verzendgoedkeuring of de documentvereiste op voordat u de handeling herhaalt.
- Geen resultaat
- Behandel een lege voorraad of een ontbrekende naam van de beller als een gewone uitkomst. Ga er niet van uit dat een syntactisch geldig nummer alle diensten heeft.
- Netwerktime-out of storing van de dienst
- Gebruik begrensde nieuwe pogingen met backoff voor leesopdrachten. Controleer bij een aankoop, verzending of registratie eerst de status van de bewerking; een geaccepteerd verzoek opnieuw proberen kan een factureerbare handeling dupliceren.
Ondersteuning voor idempotentie verschilt per API-familie. De Emergency API ondersteunt sleutels voor herhaalde pogingen; dat maakt willekeurige v3-verzoeken niet idempotent. Bewaar tijdstempels, geretourneerde ID’s en antwoorden waaruit gevoelige gegevens zijn verwijderd voor ondersteuning.
Ga verder met de referentie van uw account
De referentie voor ingelogde gebruikers filtert bewerkingen op basis van uw rechten en ingeschakelde diensten. Gebruik de exacte host, het credentialtype, de aanvraagvelden en het responsschema die daarin staan. De consoles kunnen live bewerkingen uitvoeren, waaronder aankopen en berichten.