Zum Inhalt springen
Developer

MessengerMessage

Benachrichtigung / MessengerMessage

Chat und Benachrichtigungen2 EndpunkteNotification / MessengerMessage

Liefert eine Liste aller MessengerMessages-Objekte.

GET/api/notification/messenger_message

Query-Parameter

idstring, SCOPE_LIST
directionstringoutbound | inbound | , SCOPE_LIST
channelstringsms | whatsapp | , SCOPE_LIST
providerstringINFOBIP | SINCH | CM | Benötigt Zugriffsrecht: SCOPE, SCOPE_LIST
phoneNumberstringE.164-Ziffern ohne + der Person (Empfänger oder Absender) | Erfordert Zugriffs-Tag: SCOPE, SCOPE_LIST
statusstringsent | failed | received | , SCOPE_LIST
providerMessageIdstring, SCOPE_LIST
userNotificationstring, SCOPE_LIST
chatroomstring, SCOPE_LIST
chatroomMessagestring, SCOPE_LIST
createdstring, SCOPE_LIST
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste aller MessengerMessages-Objekte.array<MessengerMessage>

Felder anzeigen (10)
  • idinteger

    Primärschlüssel der Messenger-Nachricht. Interne ID.

  • directionstring

    outbound | inbound

  • channelstring

    sms | whatsapp

  • providerstring

    INFOBIP | SINCH | CM

  • phone_numberstring

    E.164-Ziffern ohne + der Person (Empfänger oder Absender)

  • template_namestring

    WhatsApp-Vorlage, die außerhalb des Servicefensters verwendet wird

  • statusstring

    sent | failed | received

  • error_messagestring

    Fehlermeldung, falls der Versand fehlgeschlagen ist.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/notification/messenger_message \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "template_name": "Beispiel",
    "direction": "string",
    "channel": "string",
    "provider": "string",
    "phone_number": "string",
    "status": "string",
    "error_message": "string",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
]

Liefert einen einzelnen MessengerMessage-Eintrag.

GET/api/notification/messenger_message/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Gibt ein einzelnes MessengerMessage-Objekt zurück.MessengerMessage2

Felder anzeigen (14)
  • idinteger

    Primärschlüssel der Messenger-Nachricht. Interne ID.

  • directionstring

    outbound | inbound

  • channelstring

    sms | whatsapp

  • providerstring

    INFOBIP | SINCH | CM

  • phone_numberstring

    E.164-Ziffern ohne + der Person (Empfänger oder Absender)

  • template_namestring

    WhatsApp-Vorlage, die außerhalb des Servicefensters verwendet wird

  • statusstring

    sent | failed | received

  • provider_message_idstring

    ID der Nachricht beim Messenger-Anbieter.

  • error_messagestring

    Fehlermeldung, falls der Versand fehlgeschlagen ist.

  • user_notificationUserNotification

    Benutzerbenachrichtigung, zu der die Nachricht gehört.

    Felder anzeigen (25)
    • idinteger

      Primärschlüssel der Benachrichtigung. Interne ID.

    • readboolean

      Ob die Benachrichtigung gelesen wurde.

    • category_identifierstring

      Kennung der Benachrichtigungskategorie.

    • object_identifierstring

      Kennung des Objekts, auf das sich die Benachrichtigung bezieht.

    • notification_typestring

      Art der Benachrichtigung.

    • text_identifierstring

      Kennung der Vorlage für Benachrichtigungstexte.

    • long_text_identifierstring

      Kennung der Vorlage für lange Texte.

    • html_textstring

      HTML-Text der Benachrichtigung.

    • attachmentsarray<Attachment10>

      Anhänge der Benachrichtigung.

    • only_adminboolean

      Ob die Benachrichtigung nur Administratoren angezeigt wird.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • chatroomChatroom10

    Chatraum, zu dem die Nachricht gehört.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Chatraums. Interne ID.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • chatroom_messageChatroomMessage4

    Chatraum-Nachricht, zu der die Messenger-Nachricht gehört.

    Felder anzeigen (4)
    • idinteger

      Primärschlüssel der Chat-Nachricht. Interne ID.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/notification/messenger_message/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "template_name": "Beispiel",
  "direction": "string",
  "channel": "string",
  "provider": "string",
  "phone_number": "string",
  "status": "string",
  "provider_message_id": "42",
  "error_message": "string",
  "user_notification": {
    "id": 42,
    "html_text": "Text",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "read": true,
    "category_identifier": "42",
    "object_identifier": "42"
  }
}