TopMessage API-Dokumentation | Nachrichten senden

Authentifizierung

Wenn Sie API-Anfragen stellen, müssen Sie Ihren API-Schlüssel in den HTTP-Header aufnehmen. Das Header-Format sollte folgendermaßen aussehen:

X-TopMessage-Key: {API_KEY}

API-Schlüssel verwalten

hier

Nachrichten senden

Senden Sie Ihren Kunden ganz einfach eine oder mehrere Nachrichten über ihre bevorzugten Kanäle wie SMS und WhatsApp mithilfe einer einzigen, einheitlichen API. Beginnen Sie mit einer einfachen Textnachricht, indem Sie das Ziel und den Inhalt definieren, oder nutzen Sie erweiterte Funktionen, um Ihre Kommunikationsstrategie zu verbessern.

Anwendungsbeispiele

Nachfolgend sind einige Anwendungsbeispiele für die TopMessage-API aufgeführt:

Vollständige Anforderungsparameter

Name	Typ	Beschreibung
data	`object`	Enthält Nachrichteninformationen.

Data Object

Name	Typ	Beschreibung
from	`string`	Anzeigename, von dem Ihre Nachricht gesendet wird. Sie können auf der Absenderseite die verfügbaren Namen überprüfen oder einen neuen für Ihr Konto erstellen. Zur Absenderseite gehen TopMessage
to	`string[]`	Die Mobiltelefonnummer(n) des Empfängers im internationalen Format. 431511234567
text	`string`	Ihr Nachrichtentext, der an den/die Empfänger gesendet werden soll. Hallo! Ich teste gerade diese coole SMS-Funktion. https://topmessage.de

Vollständige Antwortparameter

Die Antwort enthält alle Parameter aus der Anfrage sowie die unten aufgeführten zusätzlichen Parameter.

Data Object

Name	Typ	Beschreibung
id	`string`	Eindeutige Kennung Ihrer Nachricht. 0f15fa5d-97ef-46d5-844a-f507f1c4c461
account_id	`string`	Eindeutige Kennung Ihres Kontos. 0d1f7f1c-27df-41bf-8bdc-5666608a4285
from	`string`	Anzeigename, von dem Ihre Nachricht gesendet wird. Sie können auf der Absenderseite die verfügbaren Namen überprüfen oder einen neuen für Ihr Konto erstellen. Zur Absenderseite gehen TopMessage
to	`string[]`	Die Mobiltelefonnummer(n) des Empfängers im internationalen Format. 431511234567
text	`string`	Ihr Nachrichtentext, der an den/die Empfänger gesendet werden soll. Hallo! Ich teste gerade diese coole SMS-Funktion. https://topmessage.de
channel	`string`	Der Kommunikationskanal, über den Ihre Nachricht gesendet wurde. Möglichen Werte: `SMS` und `WHATSAPP` Standard: `SMS` SMS
segment_count	`integer`	Die Anzahl der Segmente, aus denen Ihre Nachricht bestand. 1
encoding	`string`	Kodierung Ihrer Nachricht. Möglichen Werte: `STANDARD` und `UNICODE` STANDARD
schedule	`string`	Gibt die Zeit an, zu der die Nachricht gesendet werden soll. Die Zeit muss in UTC sein und dem ISO-8601-Format folgen ("2024-12-01T18:00:00Z"). Die geplante Zeit kann nicht mehr als 1 Jahr in der Zukunft festgelegt werden. Standard: Jetzt 2024-11-10T08:11:46Z
create_date	`string`	Zeitpunkt, zu dem die Nachricht initiiert wurde 2024-11-10T08:11:46Z
update_date	`string`	Datum der letzten Statusaktualisierung Ihrer Nachricht. 2024-11-10T08:11:46Z

POST

https://api.topmessage.at/v1/messages

X-TopMessage-Key: {API_KEY}
Content-Type: application/json

Anfragebeispiel

Payload

cURL

Java

Python

{
    "data": {
        "from": "TopMessage",
        "to": [
            "431511234567"
        ],
        "text": "Hallo! Ich teste gerade diese coole SMS-Funktion. https://topmessage.de"
    }
}

Antwortbeispiel

{
    "data": [
        {
            "id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "from": "TopMessage",
            "to": "431511234567",
            "text": "Hallo! Ich teste gerade diese coole SMS-Funktion. https://topmessage.de",
            "channel": "SMS",
            "segment_count": "1",
            "encoding": "STANDARD",
            "schedule": "2024-11-10T08:11:46Z",
            "create_date": "2024-11-10T08:11:46Z",
            "update_date": "2024-11-10T08:11:46Z"
        }
    ]
}