REST-API-Dokumentation
REST-APIs für SMS & MMS
Versenden Sie freigegebene Anwendungsnachrichten und behandeln Sie Annahme, Zustellereignisse, Segmentierung und Kosten.
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 SMS-Anfrage vorbereiten
Verwenden Sie eine freigegebene, SMS-fähige Absendernummer, die dem Konto gehört, einen Empfänger, der der Nachricht zugestimmt hat, sowie die erforderliche Brand/Campaign- oder Toll-Free-Verifizierung. Das folgende Beispiel versendet eine echte Nachricht, wenn es mit funktionierenden Zugangsdaten und Nummern befüllt wird; es ist keine Sandbox.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"Ersetzen Sie die Platzhalter für Absender und Empfänger durch internationale Ziffern einschließlich der Ländervorwahl. Geben Sie für eine MMS die unterstützte, öffentlich abrufbare Medien-URL in media an und prüfen Sie zuvor die MMS-Eignung und die Preise.
Annahme bedeutet nicht Zustellung
Prüfen Sie sowohl den äußeren Anwendungsstatus als auch das zurückgegebene Nachrichtenergebnis. Notieren Sie die vom Dienst gelieferte Nachrichtenkennung und verfolgen Sie Zustellstatus und Webhook-Ereignisse. Eine erfolgreiche Übermittlung kann nicht belegen, dass das Endgerät des Empfängers die Nachricht erhalten hat.
Die SMS-Abrechnung erfolgt pro Segment. Kodierung und Nachrichtenlänge können mehrere Segmente ergeben; Medien und carrierbezogene Gebühren können von SMS abweichen. Lesen Sie vor dem Versand den aktuellen Verkaufspreis des Kontos. Wiederholen Sie einen Versand nach einem Timeout niemals blind: Prüfen Sie zuerst das protokollierte Ergebnis.
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.