REST-API-Dokumentation
REST-APIs für Telefonnummern
Entdecken Sie verfügbare Länder und Nummern, prüfen Sie das vollständige Angebot und verwalten Sie Ihre eigenen Nummern.
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.
Den verfügbaren Länderkatalog lesen
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"Die v3-Antwort enthält status und ein response-Array. Ländereinträge umfassen isocode, name, countrycode, Angaben zu Funktionen und next_function. Die Verfügbarkeit hängt vom Konto und vom Bestand ab; ein Land ist kein Versprechen, dass jede Vorwahl oder jeder Nummerntyp vorrätig ist.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}Von der Suche bis zur Aktivierung
- Wählen Sie Land, gegebenenfalls Untergliederung, Gebiet und Nummerntyp mit den passenden Geografie-Vorgängen aus.
- Lesen Sie die Einrichtungs-, Monats- und Nutzungspreise, die Kanäle, das Kontingent und die Registrierungsanforderungen der ausgewählten Nummer.
- Reichen Sie die erforderlichen Endnutzer-Dokumente ein und prüfen Sie deren Status. Eine Nummer kann bis zur Freigabe ausstehend bleiben.
- Bestellen Sie einmal mit der exakten Auswahl von Bestand und Preis. Ist die Antwort unklar, prüfen Sie Ihren Bestand, bevor Sie eine weitere Bestellung absenden.
- Konfigurieren Sie Sprach-Routing und Nachrichtenzustellung unabhängig voneinander und testen Sie dann die gesamte vorgesehene Route.
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.