REST-API-Dokumentation
REST-API für LRN-Routing-Abfragen
Fragen Sie die Routingnummer und die verfügbaren Carrier-Informationen für eine nordamerikanische Telefonnummer zu einem festen Preis pro Abfrage ab.
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.
Eine Nummer nachschlagen
GET /v3/lrn/{number} akzeptiert die Zielnummer im Pfad. Für herkunftsabhängige Informationen kann optional eine Ursprungsnummer als /v3/lrn/{number}/{ani} angegeben werden. Verwenden Sie nordamerikanische Ziffern gegebenenfalls mit Ländervorwahl; die Beispiele verwenden reservierte fiktive Nummern.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123"curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123/12025550124"Eine Abfrage mit gültigen Zugangsdaten ist kostenpflichtig. Der Preis beträgt 0,00025 $ pro Abfrage: 0,25 $ pro 1.000 oder 250 $ pro Million. Es gibt keine Mengenrabatte. Dies ist eine Abfrage von Routing-Informationen; sie löst keinen Telefonanruf aus.
Das Ergebnis lesen
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Dieses erfundene Beispiel zeigt nur die Struktur der Antwort; es ist kein gemessenes Routing-Ergebnis. Prüfen Sie status.code, bevor Sie response verwenden. Das Feld cost ist ein Zeichenfolgenwert mit vorangestelltem Währungssymbol und keine JSON-Zahl.
| Feld | Bedeutung |
|---|---|
lrn | Location Routing Number zur Identifikation des Routing-Ziels. |
ported | Von dieser Abfrage gelieferte Portierungsanzeige: in der Regel 0 oder 1. Verwenden Sie sie nicht als Nachweis für Eigentum oder für die Eignung für einen Dienst. |
ocn | Operating Company Number, sofern angegeben. |
lata | Local Access and Transport Area, sofern angegeben. |
rc | Rate Center, sofern angegeben. |
city, state, lec, lectype, jurisdiction, local | Weitere Angaben zu Standort, Carrier oder Herkunft, sofern verfügbar. Sie können fehlen oder leer sein. |
Setzen Sie nicht voraus, dass jedes Routing-Feld vorhanden ist. Insbesondere können Ergebnisse für gebührenfreie Nummern lokale Rate-Center- und Carrier-Code-Angaben auslassen. Eine zurückgegebene LRN ist weder eine Echtzeit-Garantie der Erreichbarkeit noch ein Test der Gesprächsqualität.
Abfragen in Ihrem Routing-Workflow einsetzen
- Validieren und normalisieren Sie die angefragte Nummer, bevor Sie sie senden.
- Prüfen Sie den HTTP- und den Anwendungsstatus. Führen Sie zur Fehlersuche einen geschwärzten Eintrag mit Nummer, Zeitpunkt und Ergebnis.
- Verwenden Sie nur die Felder, die für Ihre Routing-Regel relevant sind, und behandeln Sie fehlende Werte ausdrücklich.
- Begrenzen Sie Wiederholungsversuche nach einer unklaren Antwort. Die Wiederholung einer Abfrage kann erneut Kosten verursachen; für diesen Endpunkt ist kein Idempotenzschlüssel dokumentiert.
Siehe das LRN-Produkt und den festen Preis pro Abfrage. Der öffentliche OpenAPI-Pfad enthält ein ANI-Segment; die bereitgestellte LRN-Implementierung akzeptiert auch die kürzere Anfrage ohne ANI. lrninfo ist ein separater Vorgang und sollte nicht anstelle dieses Endpunkts verwendet werden.
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.