SMS v2

  1. Home
  2. API Library
  3. SMS v2
Hochwertige SMS mit individuell anpassbarem Absender, Echtzeit-Zustellberichten und sofortigem Versand.

Integrieren Sie über die API einen globalen professionellen SMS-Dienst, ideal für Zwei-Faktor-Authentifizierung (2FA), Benachrichtigungen und Alerts, Termin-Erinnerungen und kritische Mitteilungen, und gewährleisten Sicherheit, Geschwindigkeit und vollständige Nachverfolgung jeder Nachricht.

All das Wissen, das Sie benötigen

Hier finden Sie einige Ratschläge, die Sie berücksichtigen sollten, um sich dieser API zu nähern. Wenn Sie möchten, bieten wir Code-Beispiele, OAS3-Dokumentation, die Möglichkeit, die API live über Swagger UI auszuprobieren oder die gesamte Sammlung in Postman zu importieren. Wir bieten auch eine Sandbox-Umgebung an, in der Sie kostenlos mit allen Arten von Anfragen experimentieren können.

Nützliche Tipps für den Einstieg SMS v2

Holen Sie sich das Token im entsprechenden Abschnitt, bevor Sie beginnen.

Verwenden Sie das Online-Tool oder generieren Sie es über die API. Legen Sie das Ablaufdatum, einen nützlichen Namen fest und fügen Sie jetzt eine Vielzahl von Scopes hinzu, um die möglichen Aktionen Ihres Tokens zu begrenzen.
Lesen Sie mehr über die OAuth-API Meine Tokens verwalten

SMS-Nachrichten senden

Methoden zum Senden von SMS-Nachrichten.

SMS weltweit senden (Worldwide)
POST /WW-messages
Erstellt eine neue SMS-Nachricht für den weltweiten Versand und reiht sie in die Warteschlange ein. Die Kosten werden nach dem Versand berechnet.

SMS nach Italien senden
POST /IT-messages
Erstellt eine neue SMS-Nachricht speziell für Italien und reiht sie in die Warteschlange ein.

SMS nach Spanien senden
POST /ES-messages
Erstellt eine neue SMS-Nachricht speziell für Spanien und reiht sie in die Warteschlange ein.

OTP-Verifizierungscode senden
POST /otp
Erzeugt und versendet einen sicheren OTP-Code per SMS. Die Nachricht wird automatisch übersetzt.

Nachrichten abrufen

Methoden zum Abrufen der Liste und Details gesendeter Nachrichten.

Gesendete Nachrichten auflisten
GET /messages
Gibt eine paginierte Liste der von Ihrem Konto gesendeten Nachrichten zurück.

Nachrichtendetails abrufen
GET /messages/{id}
Gibt die Details einer bestimmten Nachricht über deren ID zurück.

API docs by Redocly

Gateway SMS (1.3.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

Die Gateway SMS API von Openapi bietet eine robuste und skalierbare Lösung für die Integration von professionellen SMS-Nachrichten in Ihre Anwendungen. Unser Service ist darauf ausgelegt, große Mengen an Nachrichten mit Präzision zu verarbeiten. Er bietet spezielle Endpunkte für bestimmte Regionen wie Italien und Spanien sowie einen weltweiten Endpunkt für globale Reichweite.

Jede Anfrage durchläuft einen strengen Validierungsprozess, der eine Syntaxprüfung für E.164-Formate, eine Erkennung der Zeichenkodierung (GSM-7 oder UCS-2) und eine automatische Segmentierung für lange Nachrichten umfasst. Sicherheit und Konformität haben bei uns Priorität: Das System prüft Inhalte automatisch auf verbotene Wörter, um Missbrauch zu verhindern, und stellt sicher, dass alle Nachrichten den gesetzlichen Anforderungen entsprechen.

Entwickler profitieren von fortschrittlichen Funktionen wie "Dry Run" für kostenfreie Tests und Echtzeit-Webhook-Callbacks, die sofortige Aktualisierungen des Zustellungsstatus liefern. Nachrichten haben eine maximale Verfallszeit von 48 Stunden; kann eine Nachricht innerhalb dieses Zeitfensters nicht zugestellt werden, ändert sich ihr Status auf VERLOREN. Die Abrechnung ist transparent und dynamisch; während für regionale Nachrichten feste Tarife gelten, werden die weltweiten Zustellkosten nach dem Versand berechnet, um den besten Marktpreis zu gewährleisten. Bitte beachten Sie, dass für den weltweiten Betrieb ein Mindestguthaben erforderlich ist und dass bei Verstößen gegen die Richtlinien strenge Strafen verhängt werden, um die höchste Servicequalität für alle Nutzer zu gewährleisten.

Zum ersten Mal hier? Generieren Sie ein neues Zugangstoken

Messages

Vorgänge zum Senden und Abrufen von SMS-Nachrichten.

Senden einer neuen SMS (weltweit)

Erstellt eine neue SMS-Nachricht und stellt sie in die Warteschlange für den weltweiten Versand. Bitte beachten Sie, dass bei diesem Endpunkt die Kosten für die Nachricht erst nach dem Senden der Nachricht berechnet und in Rechnung gestellt werden. Der endgültige Preis variiert je nach Betreiber des Empfängers.

Wenn der Benutzer einen aktiven Abonnementplan hat, werden die Nachrichtenanteile vom verfügbaren Paket abgezogen, bevor ein eventuelles Restguthaben von der wallet abgebucht wird.

Um eine Nachricht über diesen Endpunkt zu versenden, müssen Sie über ein Mindestguthaben von 1 EUR auf Ihrem Konto verfügen, das mit der Anzahl der Nachrichtenteile (messageCount) multipliziert wird, falls ein Paket nicht verfügbar ist oder nicht ausreicht.

WICHTIG: Wenn der Inhalt oder der Absender der Nachricht verbotene Wörter enthält, wird die Nachricht blockiert, das Konto wird auf die Blockliste gesetzt und eine Strafgebühr von 1 EUR pro Nachrichtsteil wird erhoben.

Authorizations:
bearerAuth
Request Body schema: application/json

Daten der zu sendenden Nachricht.

sender
string or null [ 3 .. 11 ] characters
Default: "Openapi"

Der Absender der Nachricht. Muss ein alphanumerischer Alias sein (zwischen 3 und 11 Zeichen, Leerzeichen erlaubt) und darf nicht rein numerisch sein. Bei Null oder Leerzeichen wird "Openapi" als Standardabsender verwendet.

recipient
required
string

Die Nummer des Empfängers im internationalen E.164-Format.

message
required
string

Der Text der zu sendenden Nachricht. Die Segmentierung wird automatisch vorgenommen. Die GSM-7-Kodierung erlaubt bis zu 160 Zeichen pro Teil (153 bei mehreren Teilen), während UCS-2 bis zu 70 Zeichen (67 bei mehreren Teilen) erlaubt.

object (MessageOptions)
object (CallbackOptions)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
object (MessageResponse)

Objekt, das eine Nachricht darstellt.

Callbacks

Request samples

Content type
application/json
{
  • "sender": "MyCompany",
  • "recipient": "+393331234567",
  • "message": "Hello! This is a test message.",
  • "options": {
    },
  • "callback": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Callback payload samples

Callback
POST: Rückruf für die Aktualisierung des Nachrichtenstatus
Content type
application/json
{
  • "id": "633aabe3e4a9a0e69811ad7f",
  • "username": "string",
  • "state": "NEW",
  • "sender": "string",
  • "recipient": "string",
  • "internationalPrefix": "39",
  • "countryCode": "IT",
  • "message": "string",
  • "encoding": "GSM-7",
  • "charactersCount": 0,
  • "messageCount": 0,
  • "price": 0,
  • "totalPrice": 0,
  • "blocklisted": true,
  • "blocklistedReason": "string",
  • "options": {
    },
  • "callback": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "deliveredAt": "2019-08-24T14:15:22Z"
}

Eine neue SMS-Nachricht senden (Italien)

Erstellt eine neue SMS-Nachricht und stellt sie in die Warteschlange für den Versand speziell nach Italien. Wendet länderspezifische Regeln und Preise an.

WICHTIG: Wenn der Inhalt oder der Absender der Nachricht verbotene Wörter enthält, wird die Nachricht blockiert, das Konto wird auf eine Sperrliste gesetzt und die Kosten für die Nachricht werden berechnet.

Authorizations:
bearerAuth
Request Body schema: application/json

Daten der zu sendenden Nachricht.

sender
string or null [ 3 .. 11 ] characters
Default: "Openapi"

Der Absender der Nachricht. Muss ein alphanumerischer Alias sein (zwischen 3 und 11 Zeichen, Leerzeichen erlaubt) und darf nicht rein numerisch sein. Bei Null oder Leerzeichen wird "Openapi" als Standardabsender verwendet.

recipient
required
string

Die Nummer des Empfängers im internationalen E.164-Format.

message
required
string

Der Text der zu sendenden Nachricht. Die Segmentierung wird automatisch vorgenommen. Die GSM-7-Kodierung erlaubt bis zu 160 Zeichen pro Teil (153 bei mehreren Teilen), während UCS-2 bis zu 70 Zeichen (67 bei mehreren Teilen) erlaubt.

object (MessageOptions)
object (CallbackOptions)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
object (MessageResponse)

Objekt, das eine Nachricht darstellt.

Callbacks

Request samples

Content type
application/json
{
  • "sender": "MyCompany",
  • "recipient": "+393331234567",
  • "message": "Hello! This is a test message.",
  • "options": {
    },
  • "callback": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Callback payload samples

Callback
POST: Rückruf für die Aktualisierung des Nachrichtenstatus
Content type
application/json
{
  • "id": "633aabe3e4a9a0e69811ad7f",
  • "username": "string",
  • "state": "NEW",
  • "sender": "string",
  • "recipient": "string",
  • "internationalPrefix": "39",
  • "countryCode": "IT",
  • "message": "string",
  • "encoding": "GSM-7",
  • "charactersCount": 0,
  • "messageCount": 0,
  • "price": 0,
  • "totalPrice": 0,
  • "blocklisted": true,
  • "blocklistedReason": "string",
  • "options": {
    },
  • "callback": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "deliveredAt": "2019-08-24T14:15:22Z"
}

Senden einer neuen SMS (Spanien)

Erstellt eine neue SMS-Nachricht und stellt sie in die Warteschlange, um sie speziell nach Spanien zu senden. Wendet länderspezifische Regeln und Preise an.

WICHTIG: Wenn der Inhalt oder der Absender der Nachricht verbotene Wörter enthält, wird die Nachricht blockiert, das Konto wird auf eine Sperrliste gesetzt und die Kosten für die Nachricht werden berechnet.

Authorizations:
bearerAuth
Request Body schema: application/json

Daten der zu sendenden Nachricht.

sender
string or null [ 3 .. 11 ] characters
Default: "Openapi"

Der Absender der Nachricht. Muss ein alphanumerischer Alias sein (zwischen 3 und 11 Zeichen, Leerzeichen erlaubt) und darf nicht rein numerisch sein. Bei Null oder Leerzeichen wird "Openapi" als Standardabsender verwendet.

recipient
required
string

Die Nummer des Empfängers im internationalen E.164-Format.

message
required
string

Der Text der zu sendenden Nachricht. Die Segmentierung wird automatisch vorgenommen. Die GSM-7-Kodierung erlaubt bis zu 160 Zeichen pro Teil (153 bei mehreren Teilen), während UCS-2 bis zu 70 Zeichen (67 bei mehreren Teilen) erlaubt.

object (MessageOptions)
object (CallbackOptions)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
object (MessageResponse)

Objekt, das eine Nachricht darstellt.

Callbacks

Request samples

Content type
application/json
{
  • "sender": "MyCompany",
  • "recipient": "+393331234567",
  • "message": "Hello! This is a test message.",
  • "options": {
    },
  • "callback": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Callback payload samples

Callback
POST: Rückruf für die Aktualisierung des Nachrichtenstatus
Content type
application/json
{
  • "id": "633aabe3e4a9a0e69811ad7f",
  • "username": "string",
  • "state": "NEW",
  • "sender": "string",
  • "recipient": "string",
  • "internationalPrefix": "39",
  • "countryCode": "IT",
  • "message": "string",
  • "encoding": "GSM-7",
  • "charactersCount": 0,
  • "messageCount": 0,
  • "price": 0,
  • "totalPrice": 0,
  • "blocklisted": true,
  • "blocklistedReason": "string",
  • "options": {
    },
  • "callback": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "deliveredAt": "2019-08-24T14:15:22Z"
}

Senden einer OTP-Verifizierungsnachricht

Erzeugt einen sicheren OTP-Code und sendet ihn per SMS an den Empfänger unter Verwendung von "OTP MOBILE" als Standardabsender. Der Nachrichtentext wird automatisch in das Land des Empfängers übersetzt. Die Preisgestaltung erfolgt nach dem Worldwide (WW) Modell.

Authorizations:
bearerAuth
Request Body schema: application/json

Daten für die OTP-Nachricht.

recipient
required
string

Die Nummer des Empfängers im internationalen E.164-Format.

alphanumeric
boolean
Default: false

Bei der Einstellung "true" ist das generierte OTP alphanumerisch. Bei "false" (Standard) ist es rein numerisch.

length
integer [ 4 .. 10 ]
Default: 5

Die Länge des OTP-Codes (mindestens 4, höchstens 10).

cacheSeconds
integer [ 0 .. 600 ]
Default: 0

Die Anzahl der Sekunden, innerhalb derer derselbe OTP-Code für denselben Empfänger wiederverwendet wird (max. 600).

object (MessageOptions)
object (CallbackOptions)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
object (OTPMessageResponse)

Objekt, das eine Nachricht darstellt.

Callbacks

Request samples

Content type
application/json
{
  • "recipient": "+393331234567",
  • "alphanumeric": false,
  • "length": 5,
  • "cacheSeconds": 0,
  • "options": {
    },
  • "callback": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Callback payload samples

Callback
POST: Rückruf für OTP-Statusaktualisierungen
Content type
application/json
{
  • "id": "633aabe3e4a9a0e69811ad7f",
  • "username": "string",
  • "state": "NEW",
  • "sender": "string",
  • "recipient": "string",
  • "internationalPrefix": "39",
  • "countryCode": "IT",
  • "message": "string",
  • "encoding": "GSM-7",
  • "charactersCount": 0,
  • "messageCount": 0,
  • "price": 0,
  • "totalPrice": 0,
  • "blocklisted": true,
  • "blocklistedReason": "string",
  • "options": {
    },
  • "callback": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "deliveredAt": "2019-08-24T14:15:22Z",
  • "isOtp": true,
  • "otp": "5F8A2",
  • "otpOptions": {
    }
}

Abrufen der Liste der gesendeten Nachrichten

Gibt eine paginierte Liste der von Ihrem Konto gesendeten Nachrichten zurück.

Authorizations:
bearerAuth
query Parameters
skip
integer
Default: 0

Anzahl der zu überspringenden Nachrichten für die Paginierung.

limit
integer
Default: 100

Maximale Anzahl der zurückzugebenden Nachrichten.

Responses

Response Schema: application/json
Array of objects (MessageResponse)

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://sms.openapi.com/messages?skip=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Abrufen einer einzelnen Nachricht

Gibt die Details einer bestimmten Nachricht über ihre ID zurück.

Authorizations:
bearerAuth
path Parameters
id
required
string

Die eindeutige ID der abzurufenden Nachricht.

Responses

Response Schema: application/json
object (MessageResponse)

Objekt, das eine Nachricht darstellt.

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://sms.openapi.com/messages/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    }
}
Web Service Revision: 2.0.0