REST-API-Dokumentation

REST-APIs für Notrufe

Registrieren Sie eine Nummer und eine Dienstadresse, verfolgen Sie den Aktivierungsstatus und pflegen Sie den Eintrag, wenn sich der Standort ändert.

Kontospezifische Referenz öffnen Entwickler & Automatisierung

API und Zugangsdaten gemeinsam auswählen

Genehmigte Konten für Entwickler & Automatisierung, Unternehmen und Kommunikationsanbieter können freigeschaltete Dienste integrieren. Einzelne Entwickler müssen sich nicht als Unternehmen ausgeben. SMS/MMS aus Anwendungen erfordern die jeweils geltende Sendegenehmigung und Registrierung. Der Dienst für Privatkunden & Familien bietet keine für Kunden zugängliche API zum Versenden von Nachrichten.

API-Familie	Basis-URL	Authentifizierung und Ergebnis
Kommunikation v3	`https://api.multitel.net/v3`	Freigegebene Basic-Zugangsdaten; berechtigte bereitgestellte Tokens nur für Vorgänge, die sie unterstützen. JSON `status` und `response`.
Notruf-Registrierung	`https://api.multi.tel/emergency`	Freigegebene Basic-Zugangsdaten oder gezielt bereitgestellter Bearer-Zugriff. JSON `code`, `message` und `data`.
Portal-REST-Integrationen	Host und Vorgang laut der Entwicklerreferenz Ihres Kontos	Verwenden Sie die dokumentierten Zugangsdaten, Scopes und das Schema des jeweiligen Vorgangs. Anfragen aus Browsersitzungen sind eine separate Oberfläche.

Legen Sie MULTITEL_API_USERNAME und MULTITEL_API_PASSWORD über die Secret-Konfiguration Ihres Servers fest, bevor Sie die Beispiele verwenden. Binden Sie sie niemals in öffentliches Browser-JavaScript, URLs oder Versionsverwaltung ein. Dedizierte Zugangsdaten verwalten Sie unter API-Integrationseinstellungen.

Abdeckung lesen, ohne eine Nummer zu registrieren

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 wird ebenfalls unterstützt. Keine der beiden Notruf-Basis-URLs enthält /v3. Die Abdeckung listet internationale Länder, unterstützte Nummerntypen und Preise auf; die Eignung für nordamerikanisches E911 wird bei der Registrierung geprüft.

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

Dies veranschaulicht nur den Envelope. Das data-Schema jedes Vorgangs finden Sie im veröffentlichten Leitfaden zur Notruf-API.

Registrieren, Status verfolgen, dann Anrufe konfigurieren

Geben Sie für die USA/Kanada und die anderen unterstützten nordamerikanischen E911-Regionen die Nummer, die E911-Adresse und die erforderlichen Einwilligungsbestätigungen an. Nordamerikanisches E911 ist ausschließlich in der Produktion verfügbar.
Geben Sie für eine unterstützte eigene internationale Nummer entweder eine gespeicherte Document-Referenz oder die Identität und Adresse des Endnutzers an. Prüfen Sie zuvor die Anforderungen für Land und Nummerntyp.
Senden Sie eine POST /registrations-Anfrage. Ein optionaler Idempotency-Key kennzeichnet eine logische Änderung; bewahren Sie ihn und die exakte Nutzlast über alle Wiederholungsversuche hinweg unverändert auf.
Lesen Sie GET /registrations/:number. Prüfen Sie Lebenszyklus, pending und actionRequired; beheben Sie erforderliche Korrekturen. Annahme oder ausstehender Status bedeutet keinen aktiven Dienst.
Konfigurieren Sie nach der Aktivierung die korrekte Notruf-Rufnummernkennung und die länderspezifische Wählroute. Verwenden Sie das Verifizierungsverfahren des Dienstes, das ohne Notruf auskommt.

Internationale Sandbox-Registrierungen sind isoliert und aktivieren keine echten Notrufe. Für nordamerikanisches E911 sind Zugangsdaten des Hauptkontos erforderlich; der Leitfaden erläutert die eingeschränkte Unterstützung internationaler Unterkonten.

Einrichtung und Verifizierung im Portal Länderabdeckung und Notrufnummern Vollständiger öffentlicher Leitfaden zu Anfragen, Feldern, Status und Wiederholungen

Fehler und Wiederholungsversuche behandeln

Fehler bei Authentifizierung oder Berechtigung: Prüfen Sie, ob die API-Zugangsdaten aktiviert sind, ob der Dienst zulässig ist und welche Einschränkung der Quell-IP gilt. Ein Portal-Sitzungscookie ist keine Zugangsberechtigung für Integrationen.
Unzureichendes Guthaben oder nicht erfüllte Freigabe: Klären Sie das Kontoguthaben, die Versandfreigabe oder die Dokumentenanforderung, bevor Sie den Vorgang wiederholen.
Kein Ergebnis: Behandeln Sie einen leeren Bestand oder einen fehlenden Anrufernamen als normalen Ausgang. Gehen Sie nicht davon aus, dass eine syntaktisch gültige Nummer jeden Dienst unterstützt.
Netzwerk-Timeout oder Dienstausfall: Verwenden Sie für Lesezugriffe begrenzte Wiederholungsversuche mit Backoff. Prüfen Sie bei einem Kauf, einem Versand oder einer Registrierung zuerst den Status des Vorgangs; die Wiederholung einer akzeptierten Anfrage kann eine kostenpflichtige Aktion doppelt auslösen.

Die Unterstützung von Idempotenz gilt jeweils für eine API-Familie. Die Notruf-API unterstützt Retry-Schlüssel; dadurch werden beliebige v3-Anfragen jedoch nicht idempotent. Bewahren Sie Zeitstempel, zurückgegebene IDs und geschwärzte Antworten für den Support auf.

Weiter mit der Referenz Ihres Kontos

Die Referenz im angemeldeten Zustand filtert Operationen nach Ihren Berechtigungen und aktivierten Diensten. Verwenden Sie dort den genauen Host, den Zugangsdatentyp, die Anfragefelder und das Antwortschema. Die Konsolen können Live-Operationen ausführen, einschließlich Käufen und Nachrichten.

Kontospezifischer Endpunktkatalog Kommunikations-REST-Konsole Öffentliches OpenAPI-Dokument für Kommunikation OAuth-Integrationsleitfaden