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:

Senden Sie eine einzelne SMS – perfekt für direkte Eins-zu-Eins-Kommunikation wie Benachrichtigungen oder Bestätigungen.

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. 491511234567
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.

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

Data Object

Name	Typ	Beschreibung
id	`string`	Eindeutige Kennung Ihrer Nachricht.
account_id	`string`	Eindeutige Kennung Ihres Kontos.
status	`string`	Anfangsstatus Ihrer Nachricht. Möglichen Werte: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
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
to	`string[]`	Die Mobiltelefonnummer(n) des Empfängers im internationalen Format.
text	`string`	Ihr Nachrichtentext, der an den/die Empfänger gesendet werden soll.
channel	`string`	Der Kommunikationskanal, über den Ihre Nachricht gesendet wurde. Möglichen Werte: `SMS` und `WHATSAPP` Standard: `SMS`
segment_count	`integer`	Die Anzahl der Segmente, aus denen Ihre Nachricht bestand.
encoding	`string`	Kodierung Ihrer Nachricht. Möglichen Werte: `STANDARD` und `UNICODE`
direction	`string`	Zeigt den Nachrichtenfluss an – ob die Nachricht von Ihrem System gesendet oder von einem Nutzer empfangen wurde. Möglichen Werte: `OUTBOUND`, `INBOUND`
country	`string`	Gibt das Land des Empfängers bei ausgehenden Nachrichten und des Absenders bei eingehenden Nachrichten an. Der Wert wird im Format ISO 3166-1 Alpha-2 angegeben.
type	`string`	Gibt den Nachrichtentyp an, der gesendet oder empfangen wird. Hilft zu erkennen, ob es sich um reinen Text, eine Vorlage oder Medien (z. B. Bilder/Videos) handelt – einschließlich interaktiver Inhalte für WhatsApp.
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
create_date	`string`	Zeitpunkt, zu dem die Nachricht initiiert wurde
update_date	`string`	Datum der letzten Statusaktualisierung Ihrer Nachricht.

POST

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

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

Anfragebeispiel

Payload

cURL

Java

Python

PHP

Node.js

{
    "data": {
        "from": "TopMessage",
        "to": [
            "491511234567"
        ],
        "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",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "491511234567",
            "text": "Hallo! Ich teste gerade diese coole SMS-Funktion. https://topmessage.de",
            "channel": "SMS",
            "segment_count": "1",
            "encoding": "STANDARD",
            "direction": "OUTBOUND",
            "country": "DE",
            "type": "text",
            "schedule": "2024-11-10T08:11:46Z",
            "create_date": "2024-11-10T08:11:46Z",
            "update_date": "2024-11-10T08:11:46Z"
        }
    ]
}