Logbuch

Der API-Endpunkt zur Abfrage von Logbüchern stellt eine direkte Schnittstelle bereit, um Einblicke in gesendete und empfangene Nachrichten zu erhalten. Dieser Endpunkt ist essenziell für die Überwachung der Nachrichtenkommunikation oder für das Aufspüren von Übertragungsfehlern. Er bietet die notwendigen Daten, um die Nachrichtenverarbeitung und den Austausch innerhalb der Anwendung transparent zu analysieren.

Sie können über Parameter die Suche einschränken, um genau die Daten zu erhalten, die Sie benötigen. Standardmäßig gibt jeder der unten genannten Endpunkte bis zu 100 Einträge zurück. Durch Ihre Logbücher blättern Sie mit offset und limit (max. 100 pro Abfrage) oder mit show_page und items (max. 10000 pro Abfrage).

Alle Zeitangaben (timestamp, dlr_timestamp) werden in deutscher Ortszeit (Zeitzone Europe/Berlin, MEZ/MESZ) und ohne UTC-Offset zurückgegeben. Die Parameter date_from und date_to beziehen sich ebenfalls auf diese Zeitzone.

Optionale Parameter

Name
id
Type
integer
Description
Die ID der Nachricht.
Name
date_from
Type
timestamp
Description
Startdatum, ab dem gesucht werden soll im Format JJJJ-MM-TT 2020-01-01.
Name
date_to
Type
timestamp
Description
Enddatum, bis zu dem gesucht werden soll im Format JJJJ-MM-TT 2020-05-30.
Name
state
Type
string
Description
Status der Nachricht. Dies könnte z.B. completed / failed bei Voice oder DELIVERED / NOTDELIVERED etc. bei SMS sein. Bei empfangenen Nachrichten nicht verfügbar.
Name
to
Type
string
Description
Empfängerrufnummer im beliebigen Format.
Name
limit
Type
integer
Description
Limitiert die Anzahl der zurückzugebenden Einträge. Muss eine Ganzzahl zwischen 1-100 sein.
Name
offset
Type
integer
Description
Startpunkt, ab dem Einträge abgefragt werden sollen.
Name
show_page
Type
integer
Description
Abzufragende Seite, beginnend bei 1. Wird ignoriert, wenn offset gesetzt ist.
Name
items
Type
integer
Description
Anzahl der Einträge pro Seite bei Verwendung von show_page. Muss eine Ganzzahl zwischen 1-10000 sein. Wird ignoriert, wenn offset gesetzt ist.

GET

Gesendete Nachrichten

Über diesen Endpunkt können Sie die letzten Einträge Ihrer Logbücher abfragen. Standardmäßig erhalten Sie pro Abfrage bis zu 100 Einträge.

Anfrage

GET

/api/journal/outbound

curl -G "https://gateway.seven.io/api/journal/outbound" \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL"

Antwort

[
  {
    "id": "77231715575",
    "to": "49176123456789",
    "from": "sender",
    "text": "Hello World",
    "timestamp": "2024-02-13 05:50:58.802",
    "price": "0.0750",
    "dlr": "DELIVERED",
    "dlr_timestamp": "2024-02-13 05:51:13.185",
    "mccmnc": "26207",
    "latency": "14.3830",
    "type": "direct",
    "channel": "RCS",
    "connection": "http",
    "label": null,
    "foreign_id": null
  },
  {
    "id": "77231715551"
    // ...
  }
]

GET

Empfangene Nachrichten

Über diesen Endpunkt können Sie die empfangenen Nachrichten abfragen, z.B. SMS und WhatsApp. Standardmäßig erhalten Sie pro Abfrage bis zu 100 Einträge.

Anfrage

GET

/api/journal/inbound

curl -G "https://gateway.seven.io/api/journal/inbound" \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL"

Antwort

[
  {
    "id": "4603396",
    "from": "49176123456789",
    "to": "49151123456789",
    "text": "Awesome! Your message was received.",
    "timestamp": "2025-01-16 12:53:17",
    "reply_to_message_id": "77258554687",
    "price": 0
  },
  {
    "id": "1865514",
    "from": "49176123456789",
    "to": "49151123456789",
    "text": "Your Code is: 1035. Don't share it with anyone.",
    "timestamp": "2024-03-03 00:17:02",
    "reply_to_message_id": null,
    "price": 0.01
  },
  {
    // ...
  }
]

GET

Voice Nachrichten

Über diesen Endpunkt können Sie die letzten Einträge Ihrer Logbücher abfragen. Standardmäßig erhalten Sie pro Abfrage bis zu 100 Einträge.

Anfrage

GET

/api/journal/voice

curl -G "https://gateway.seven.io/api/journal/voice" \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL"

Antwort

[
  {
    "id": "1429729",
    "from": "49157123456789",
    "to": "49176123456789",
    "xml": false,
    "text": "Hallo, Ihr Authentifizierungscode lautet: 1 2 3 4 5 6.",
    "duration": "17",
    "status": "completed",
    "error": null,
    "timestamp": "2024-03-01 14:20:03",
    "price": "0.045"
  },
  {
    "id": "1429671"
    // ...
  }
]