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. Jeder der unten genannten Endpunkte gibt maximal 100 Einträge zurück. Über die Parameter offset und limit können Sie tiefere Seiten Ihrer Logbücher abfragen.

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

GET

Gesendete Nachrichten

Über diesen Endpunkt können Sie die letzten Einträge Ihrer Logbücher abfragen. Sie erhalten bei jeder Abfrage maximal 100 Einträge zurück.

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:50:63.102",
    "mccmnc": "26207",
    "latency": "14.3830",
    "type": "direct",
    "channel": "RCS",
    "connection": "http",
    "label": null,
    "foreign_id": null
  },
  {
    "id": "77231715551",
    // ...
  }
]

GET

Inbound SMS

Über diesen Endpunkt können Sie die eingegangen SMS an Ihre Rufnummer bei seven abfragen. Sie erhalten bei jeder Abfrage maximal 100 Einträge zurück.

Anfrage

GET

/api/journal/inbound

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

Antwort

[
  [
  {
    "id": "1865514",
    "from": "49176123456789",
    "to": "49151123456789",
    "text": "Your Code is: 1035. Don't share it with anyone.",
    "timestamp": "2024-03-03 00:17:02",
    "price": "0.01"
  },
  {
    "id": "1865513",
    // ...
  }
]

GET

Voice Nachrichten

Über diesen Endpunkt können Sie die letzten Einträge Ihrer Logbücher abfragen. Sie erhalten bei jeder Abfrage maximal 100 Einträge zurück.

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",
    // ...
  }
]

GET

Erhaltene Antworten

Über diesen Endpunkt können Sie die Antworten auf Ihre verschickten SMS abfragen. Sie erhalten bei jeder Abfrage maximal 100 Einträge zurück.

Anfrage

GET

/api/journal/replies

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

Antwort

[
  {
    "id": "45900253",
    "from": "49176123456789",
    "to": "49157123456789",
    "text": "Ja, der Termin passt mit sehr gut!",
    "timestamp": "2024-01-07 02:42:00",
    "price": 0.0
  },
  {
    "id": "95839198",
    // ...
  }
]