EntwicklerAPI-Ressourcen

Gesendete Nachrichten

Die gesendeten Nachrichten listen die E-Mails und SMS auf, die fepli versendet hat: Bestätigungen, Wartelistenhinweise, Belege, Erinnerungen. Hier beantworten Sie die Frage „Hat die Familie die Bestätigung erhalten?“. In der API ist eine gesendete Nachricht eine sent-message.

Endpunkte

GET/sent-messagesAlle gesendeten Nachrichten abrufen
GET/sent-messages/{uuid}Eine gesendete Nachricht abrufen

Alle Endpunkte für gesendete Nachrichten brauchen ROLE_ADMIN.

Gesendete Nachrichten, die älter sind als die Frist, die im Admin-Panel unter Einstellungen → Datenschutz → Aufbewahrung in der Zeile E-Mails und SMS steht, werden gelöscht. Die Frist zählt ab dem Versand. Gelöschte Nachrichten erscheinen hier nicht mehr.

Das Modell der gesendeten Nachricht

Name
uuid
Typ
string
Beschreibung
Die Kennung der Nachricht.
Name
channel
Typ
string
Beschreibung
email oder sms.
Name
to
Typ
string
Beschreibung
Die E-Mail-Adresse oder Telefonnummer der Empfänger:in.
Name
toName
Typ
string
Beschreibung
Der Name der Empfänger:in. Nur bei E-Mails.
Name
from
Typ
string
Beschreibung
Die Absenderadresse. Nur bei E-Mails.
Name
subject
Typ
string
Beschreibung
Die Betreffzeile. Nur bei E-Mails.
Name
type
Typ
string
Beschreibung
Die Art der Benachrichtigung, etwa attendance_confirmed oder offer_cancelled. null bei SMS und bei E-Mails, die gesendet wurden, bevor fepli die Art erfasste.
Name
sentAt
Typ
timestamp
Beschreibung
Wann die Nachricht gesendet wurde.
Name
deliveryStatus
Typ
string
Beschreibung
Was über die Zustellung bekannt ist, gemeldet vom E-Mail-Dienstleister: sent, delivered oder bounce (zurückgewiesen oder verworfen). Die Berichte des Dienstleisters werden nur festgehalten, solange der Mandant die App Versand nachverfolgen eingeschaltet hat. Ab Werk ist sie aus, und ohne sie bleibt der Status sent. opened und clicked (ein Link wurde ausgewählt) erscheinen nur dort, wo die Einstellung Öffnungen und Klicks messen der App an ist und die Empfänger:in gemessen werden darf.
Name
bounced
Typ
boolean
Beschreibung
Ob die Nachricht zurückgewiesen wurde. Verworfene Nachrichten zeigen deliveryStatus: bounce, aber bounced: false.
Name
accounts
Typ
reference[]
Beschreibung
Die Konten, an die die Nachricht ging. Namen fehlen dort, wo personenbezogene Daten maskiert sind.
Name
attendances
Typ
string[]
Beschreibung
Die UUIDs der Anmeldungen, um die es in der Nachricht geht.
Name
offers
Typ
reference[]
Beschreibung
Die Angebote, um die es in der Nachricht geht.
Name
conversation
Typ
string
Beschreibung
Die UUID des Verlaufs von Kommentaren, zu dem die Nachricht gehört, falls sie aus einem Verlauf gesendet wurde.
Name
text
Typ
string
Beschreibung
Der Text der Nachricht als reiner Text. Nur, wenn Sie eine einzelne Nachricht abrufen. Links, mit denen die Leser:in als Empfänger:in handeln könnte (Links zur Anmeldung, Einladung, zum Passwort, zur Registrierung, Einwilligung und Zahlung), werden durch ****** ersetzt, ebenso der Link hinter dem Hauptknopf der E-Mail. Nachrichten, die gespeichert wurden, bevor fepli diese Links ersetzte, behalten sie.

GET/sent-messages

Alle gesendeten Nachrichten abrufen

Liefert eine Seite mit gesendeten Nachrichten, die neuesten zuerst, ohne ihren Text.

Optionale Filter

Name
account
Typ
string
Beschreibung
Nur Nachrichten an dieses Konto (UUID, oder E-Mail-Adresse innerhalb Ihres eigenen Mandanten).
Name
to
Typ
string
Beschreibung
Nur E-Mails an genau diese Adresse. Schließt channel=email ein.
Name
attendance
Typ
string
Beschreibung
Nur Nachrichten zu dieser Anmeldung (UUID).
Name
offer
Typ
string
Beschreibung
Nur Nachrichten zu diesem Angebot (UUID).
Name
channel
Typ
string
Beschreibung
email oder sms.
Name
since
Typ
timestamp
Beschreibung
Nur Nachrichten, die seit diesem Zeitpunkt gesendet wurden.
Name
page, itemsPerPage
Typ
integer
Beschreibung
Siehe Paginierung.

GET/sent-messages

curl -G https://example.fepli.eu/api/sent-messages \
  -H "Authorization: Bearer $FEPLI_TOKEN" \
  --data-urlencode "account=familie.mueller@example.org" \
  -d since=2026-09-01

Antwort

[
  {
    "uuid": "0192d0e8-4b5c-7d6e-8f7a-9b0c1d2e3f35",
    "channel": "email",
    "to": "familie.mueller@example.org",
    "toName": "Anna Müller",
    "from": "ferienpass@example.fepli.eu",
    "subject": "Zusage: Fahrradtour durch den Stadtpark",
    "type": "attendance_confirmed",
    "sentAt": "2026-09-01T08:03:20+02:00",
    "deliveryStatus": "delivered",
    "bounced": false,
    "accounts": [
      {
        "uuid": "0191c7b2-4d5e-7f60-8a1b-2c3d4e5f6a05",
        "name": "Anna Müller"
      }
    ],
    "attendances": ["0192d0e8-3a4b-7c5d-9e6f-7a8b9c0d1e07"],
    "offers": [
      {
        "uuid": "0192a4f1-6e3b-7c85-b1d2-8f4e6a9c3b03",
        "name": "Fahrradtour durch den Stadtpark",
        "alias": "fahrradtour-durch-den-stadtpark"
      }
    ]
  }
]

GET/sent-messages/{uuid}

Eine gesendete Nachricht abrufen

Liefert eine gesendete Nachricht, einschließlich ihres Textes als reiner Text in text.

GET/sent-messages/{uuid}

curl https://example.fepli.eu/api/sent-messages/0192d0e8-4b5c-7d6e-8f7a-9b0c1d2e3f35 \
  -H "Authorization: Bearer $FEPLI_TOKEN"

Antwort (Auszug)

{
  "uuid": "0192d0e8-4b5c-7d6e-8f7a-9b0c1d2e3f35",
  "channel": "email",
  "subject": "Zusage: Fahrradtour durch den Stadtpark",
  "…": "…",
  "text": "Hallo Anna Müller,\n\nLena hat einen Platz für „Fahrradtour durch den Stadtpark“ am 14.10.2026 …"
}