API

Nachricht abrufen

Rufen Sie Details für eingehende und ausgehende Nachrichten ab und bestätigen Sie die an Ihre Kunden gesendeten Authentifizierungscodes. Greifen Sie auf eine Liste aller Nachrichten zu oder finden Sie Informationen zu einer bestimmten Nachricht mithilfe der eindeutigen Nachrichten-ID, die bei der Erstellung oder beim Empfang bereitgestellt wurde.

Anwendungsbeispiele

Nachrichtenliste abrufen
Eine bestimmte Nachricht abrufen
Bestätigungscode

Die Benutzerüberprüfung war erfolgreich, wenn der Header X-Total-Count den Wert 1 hat oder die Datenobjektliste in der Antwort nicht leer ist.

Vollständige Anforderungsparameter

Es sind keine Anforderungsparameter erforderlich.

Vollständige Antwortparameter

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 die folgenden Details der gesendeten Nachricht.

Datenobjekt

Name	Typ	Beschreibung
account_id	`string`	Eindeutige Kennung Ihres Kontos.
id	`string`	Eindeutige Kennung Ihrer Nachricht.
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.
status	`string`	Anfangsstatus Ihrer Nachricht. Möglichen Werte: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
channel	`string`	Der Kommunikationskanal, über den Ihre Nachricht gesendet wurde. Möglichen Werte: `SMS` und `WHATSAPP` Standard: `SMS`
text	`string`	Ihr Nachrichtentext, der an den/die Empfänger gesendet werden soll.
template_id	`string`	Eindeutiger Bezeichner Ihrer gesendeten Vorlage. Sie können die verfügbaren Vorlagen auf der Vorlagenseite einsehen oder eine neue erstellen.Zur Vorlagenseite gehen.
parameters	`string[]`	Diese Werte werden verwendet, um die Platzhalter in Ihrer Nachrichtenvorlage zu ersetzen, sodass Sie die Nachricht für jeden Empfänger anpassen können. Standard: Leer
segment_count	`integer`	Die Anzahl der Segmente, aus denen Ihre Nachricht bestand.
encoding	`string`	Kodierung Ihrer Nachricht. Möglichen Werte: `STANDARD` und `UNICODE`
country	`string`	Zielland Ihres Nachrichtenempfängers.
direction	`string`	Gibt an, ob die Nachricht von Ihrem System empfangen oder von Ihrem System an den Empfänger gesendet wird. Möglichen Werte: `OUTBOUND`, `INBOUND`
type	`string`	Bestimmt die Struktur des Nachrichteninhalts. Möglichen Werte: `TEXT`, `TEMPLATE`
create_date	`string`	Zeitpunkt, zu dem die Nachricht initiiert wurde
update_date	`string`	Datum der letzten Statusaktualisierung Ihrer Nachricht.
code	`string`	Vom Benutzer bereitgestellter Code, 4-6-stellig
expired	`boolean`	Gibt an, ob der Code abgelaufen ist. Möglichen Werte: `TRUE`, `FALSE` Standard: `FALSE`

Nachrichtenliste abrufen

GET

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

Eine bestimmte Nachricht abrufen

GET

https://api.topmessage.ch/v1/messages/{Id}

Bestätigungscode

GET

https://api.topmessage.ch/v1/messages?to={receipnet_number}&code={code}&expired=false

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

Antwortbeispiel

'X-Total-Count': 1

{
    "data": [
        {
            "id": "b63ddae0-48c4-4e81-879c-2170a05051ca",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "from": "19134216816",
            "to": "48727516980",
            "channel": "SMS",
            "status": "DELIVERED",
            "text": "Hi there! Just testing out this cool SMS feature. https://topmessage.com",
            "segment_count": 1,
            "direction": "OUTBOUND",
            "country": "US",
            "type": "TEXT",
            "template": {
                "id": "67d0c347-d946-49ed-958f-3de966278525"
            },
            "schedule": "2024-11-20T08:11:46Z",
            "create_date": "2024-11-25T08:35:13Z",
            "update_date": "2024-11-25T08:35:14Z"
        }
    ]
}