REST-API-Dokumentation
Ihre erste MultiTEL-API-Anfrage
Beginnen Sie mit einer reinen Leseanfrage, verstehen Sie die Antwort und wählen Sie dann die Referenz für den Dienst, den Sie entwickeln möchten.
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.
Erste Anfrage: Guthaben abrufen
Dieser Lesezugriff kauft keinen Dienst und löst weder einen Anruf noch eine Nachricht aus.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Die Kommunikation-v3-API liefert ein Anwendungsergebnis im JSON-Body. Prüfen Sie den HTTP-Status und status.code, bevor Sie response auslesen; bei einer abgelehnten Anfrage ist möglicherweise kein Response-Objekt vorhanden. Code-Werte können Strings oder Zahlen sein.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Dies ist ein fiktives Beispiel und kein Kontoguthaben. Behandeln Sie Geldbeträge als Dezimalbeträge. Bewahren Sie bei der Diagnose einer abgelehnten Anfrage die Antwortnachricht des Servers auf, jedoch ohne Zugangsdaten.
Abrechnungsdaten richtig verwenden
Die Guthaben-Antwort enthält das aktuelle Guthaben, die Währung und die Zahlungsbedingungen. Sie nennt weder die Kosten eines künftigen Anrufs noch eine vollständige Rechnung. Verwenden Sie für diese Fragen die passenden Tarif- und Nutzungsvorgänge. Bestehende Nummern können andere Tarife haben als der heutige Katalog.
Ihre nächste Integration auswählen
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.
Integrationsleitfaden lesen →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.
Integrationsleitfaden lesen →REST-APIs für SMS & MMS
Versenden Sie freigegebene Anwendungsnachrichten und behandeln Sie Annahme, Zustellereignisse, Segmentierung und Kosten.
Integrationsleitfaden lesen →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.
Integrationsleitfaden lesen →REST-APIs für Konto & Abrechnung
Lesen Sie das Guthaben und die Abrechnungsinformationen aus, die Ihrer genehmigten Integration zur Verfügung stehen.
Integrationsleitfaden lesen →CNAM- und Routing-Abfragen
Lesen Sie Anrufernamen aus, verstehen Sie die Abfragestufen und nutzen Sie Informationen zum Nummernrouting.
CNAM-REST-Referenz →Hosted PBX
Beginnen Sie mit den verfügbaren Tarifen und dem Mandanten, den Sie konfigurieren möchten.
Hosted-PBX-Tarif-API →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.