REST API-dokumentation
REST API:er för nödsamtal
Registrera ett nummer och en tjänsteadress, följ aktiveringsstatusen och håll posten uppdaterad när platsen ändras.
Välj API och autentiseringsuppgift tillsammans
Godkända konton av typen Utvecklare & Automation, Företag och Kommunikationsleverantörer kan integrera aktiverade tjänster. En enskild utvecklare behöver inte utge sig för att vara ett företag. SMS/MMS för applikationer kräver tillämpligt sändningsgodkännande och tillämplig registrering. Tjänsten Privat & Familj har inget kundtillgängligt API för att initiera meddelandesändning.
| API-familj | Bas-URL | Autentisering och resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkända Basic-autentiseringsuppgifter; berättigade provisionerade token endast för åtgärder som stöder dem. JSON status och response. |
| Nödsamtalsregistrering | https://api.multi.tel/emergency | Godkända Basic-autentiseringsuppgifter eller specifikt provisionerad bearer-åtkomst. JSON code, message och data. |
| Portal-REST-integrationer | Värd och åtgärd visas i ditt kontos utvecklarreferens | Använd åtgärdens dokumenterade autentiseringsuppgift, behörighetsomfattning och schema. Begäranden från webbläsarsessioner använder ett separat gränssnitt. |
Ange MULTITEL_API_USERNAME och MULTITEL_API_PASSWORD via din servers konfiguration för hemligheter innan du använder exemplen. Bädda aldrig in dem i offentlig webbläsar-JavaScript, URL:er eller källkodshantering. Dedikerade autentiseringsuppgifter hanteras i inställningarna för API-integration.
Läs täckning utan att registrera ett 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öds också. Ingen av bas-URL:erna för nödsamtal innehåller /v3. Täckningen listar länder som stöds av den internationella tjänsten, nummertyper som stöds samt priser; nordamerikansk E911-behörighet kontrolleras vid registreringen.
{
"code": 200,
"message": "",
"environment": "production",
"requestId": "EXAMPLE_REQUEST_ID",
"data": {}
}Detta illustrerar endast svarskuvertet. Läs varje åtgärds data-schema i den publicerade Emergency API-guiden.
Registrera, följ status och konfigurera sedan samtal
- För USA/Kanada och övriga nordamerikanska E911-regioner som stöds ska du ange numret, E911-adressen och nödvändiga samtyckesbekräftelser. Nordamerikansk E911 är endast för produktion.
- För ett internationellt nummer som stöds och ägs av kontot ska du ange antingen en sparad Document-referens eller slutanvändarens identitet och adress. Granska först landets och nummertypens krav.
- Skicka en
POST /registrations-begäran. En valfriIdempotency-Keyidentifierar en logisk mutation; bevara den och den exakta nyttolasten vid återförsök. - Läs
GET /registrations/:number. Granska livscykel,pendingochactionRequiredoch gör de korrigeringar som krävs. Att registreringen har accepterats eller är väntande betyder inte att tjänsten är aktiv. - Efter aktivering ska du konfigurera korrekt uppringar-ID för nödsamtal och landsspecifik uppringningsrutt. Använd tjänstens verifieringsprocedur för icke-nödsituationer.
Internationella sandlåderegistreringar är isolerade och aktiverar inte verkliga nödsamtal. Huvudkontots autentiseringsuppgifter krävs för nordamerikansk E911; guiden förklarar det begränsade internationella underkontostödet.
Hantera fel och återförsök
- Autentiserings- eller behörighetsfel
- Kontrollera API-autentiseringsuppgiftens aktiveringsstatus, tillåtna tjänst och käll-IP-begränsning. En portalsessionskaka är inte en integrationsautentiseringsuppgift.
- Otillräckligt saldo eller saknat godkännande
- Åtgärda kontosaldot, sändningsgodkännandet eller dokumentkravet innan du upprepar åtgärden.
- Inget resultat
- Hantera tomt lager eller ett saknat uppringarnamn som ett normalt utfall. Anta inte att ett syntaktiskt giltigt nummer har alla tjänster.
- Nätverkstimeout eller tjänstefel
- Använd begränsade återförsök med backoff för läsningar. Vid köp, sändning eller registrering ska du först granska åtgärdens tillstånd; ett återförsök av en accepterad begäran kan duplicera en debiterbar åtgärd.
Idempotensstöd tillhör varje API-familj. Emergency API stöder återförsöksnycklar; det gör inte godtyckliga v3-begäranden idempotenta. Behåll tidsstämplar, returnerade ID:n och maskade svar för supporten.
Fortsätt med ditt kontos referens
Den inloggade referensen filtrerar operationer utifrån dina behörigheter och aktiverade tjänster. Använd dess exakta värd, typ av autentiseringsuppgift, förfrågningsfält och svarsschema. Konsolerna kan utföra skarpa operationer, inklusive köp och meddelanden.