Zum Inhalt springen
Developer

ChatroomMessage

Chat und Benachrichtigungen6 EndpunkteChat / ChatroomMessage

Liefert eine Liste aller ChatroomMessages-Objekte.

GET/api/chat/chatroom_message

Query-Parameter

chatroomstring_LIST
participantstring_LIST, LOGGED_IN_LIST
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE_LIST
createdstring_LIST, LOGGED_IN_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 ChatroomMessages-Objekte.array<ChatroomMessage2>

Felder anzeigen (10)
  • idinteger

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

  • participantChatroomParticipant5

    Teilnehmende Person, die die Nachricht verfasst hat.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Teilnehmers. 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.

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment22>

    Anhänge der Chatnachricht.

    Felder anzeigen (26)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • reactionsarray<ChatroomMessageReaction2>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel der Reaktion. Interne ID.

    • emojistring

      Emoji der Reaktion.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • deletedboolean

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

  • completedboolean

    Kennzeichen, ob diese Nachricht abgeschlossen ist

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • 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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_message \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "message_text": "Text",
    "participant": {
      "id": 42,
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    },
    "completed": true,
    "edited_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  }
]

ChatroomMessage neu anlegen

POST/api/chat/chatroom_message

Request-Body application/json

  • dataChatroomMessage3
    Felder anzeigen (11)
    • idinteger

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

    • chatroomChatroom10

      Chatraum, zu dem die Nachricht gehört.

    • participantChatroomParticipant5

      Teilnehmende Person, die die Nachricht verfasst hat.

    • message_textstring

      Text der Chat-Nachricht.

    • attachmentsarray<Attachment22>

      Anhänge der Chatnachricht.

    • reactionsarray<ChatroomMessageReaction6>

      Reaktionen auf die Chat-Nachricht.

    • completedboolean

      Kennzeichen, ob diese Nachricht abgeschlossen ist

    • edited_atstring (date-time)

      Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

    • 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

Antworten

200ChatroomMessage neu anlegenChatroomMessage3

Felder anzeigen (11)
  • idinteger

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

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

  • participantChatroomParticipant5

    Teilnehmende Person, die die Nachricht verfasst hat.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Teilnehmers. 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.

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment22>

    Anhänge der Chatnachricht.

    Felder anzeigen (26)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • reactionsarray<ChatroomMessageReaction6>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Reaktion. Interne ID.

    • emojistring

      Emoji der Reaktion.

    • participantChatroomParticipant5

      Teilnehmende Person, die reagiert hat.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • deletedboolean

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

  • completedboolean

    Kennzeichen, ob diese Nachricht abgeschlossen ist

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • 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

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_message \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "chatroom": {
      "id": 42,
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    },
    "participant": {
      "id": 42,
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    },
    "completed": true,
    "edited_at": "2026-10-15T09:30:00+02:00"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "participant": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "reactions": [
    {
      "id": 42,
      "image_url": "https://vynst.de",
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Liefert einen einzelnen ChatroomMessage-Eintrag.

GET/api/chat/chatroom_message/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Gibt ein einzelnes ChatroomMessage-Objekt zurück.ChatroomMessage3

Felder anzeigen (11)
  • idinteger

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

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

  • participantChatroomParticipant5

    Teilnehmende Person, die die Nachricht verfasst hat.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Teilnehmers. 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.

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment22>

    Anhänge der Chatnachricht.

    Felder anzeigen (26)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • reactionsarray<ChatroomMessageReaction6>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Reaktion. Interne ID.

    • emojistring

      Emoji der Reaktion.

    • participantChatroomParticipant5

      Teilnehmende Person, die reagiert hat.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • deletedboolean

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

  • completedboolean

    Kennzeichen, ob diese Nachricht abgeschlossen ist

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • 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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_message/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "participant": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "reactions": [
    {
      "id": 42,
      "image_url": "https://vynst.de",
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Aktualisiert einen vorhandenen ChatroomMessage-Eintrag.

PUT/api/chat/chatroom_message/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataChatroomMessage3
    Felder anzeigen (11)
    • idinteger

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

    • chatroomChatroom10

      Chatraum, zu dem die Nachricht gehört.

    • participantChatroomParticipant5

      Teilnehmende Person, die die Nachricht verfasst hat.

    • message_textstring

      Text der Chat-Nachricht.

    • attachmentsarray<Attachment22>

      Anhänge der Chatnachricht.

    • reactionsarray<ChatroomMessageReaction6>

      Reaktionen auf die Chat-Nachricht.

    • completedboolean

      Kennzeichen, ob diese Nachricht abgeschlossen ist

    • edited_atstring (date-time)

      Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

    • 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

Antworten

200ChatroomMessage einzeln aktualisierenChatroomMessage3

Felder anzeigen (11)
  • idinteger

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

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

  • participantChatroomParticipant5

    Teilnehmende Person, die die Nachricht verfasst hat.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Teilnehmers. 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.

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment22>

    Anhänge der Chatnachricht.

    Felder anzeigen (26)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • reactionsarray<ChatroomMessageReaction6>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Reaktion. Interne ID.

    • emojistring

      Emoji der Reaktion.

    • participantChatroomParticipant5

      Teilnehmende Person, die reagiert hat.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • deletedboolean

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

  • completedboolean

    Kennzeichen, ob diese Nachricht abgeschlossen ist

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • 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

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_message/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "chatroom": {
      "id": 42,
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    },
    "participant": {
      "id": 42,
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    },
    "completed": true,
    "edited_at": "2026-10-15T09:30:00+02:00"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "participant": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "reactions": [
    {
      "id": 42,
      "image_url": "https://vynst.de",
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Aktualisiert einen vorhandenen ChatroomMessage-Eintrag.

PATCH/api/chat/chatroom_message/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataChatroomMessage3
    Felder anzeigen (11)
    • idinteger

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

    • chatroomChatroom10

      Chatraum, zu dem die Nachricht gehört.

    • participantChatroomParticipant5

      Teilnehmende Person, die die Nachricht verfasst hat.

    • message_textstring

      Text der Chat-Nachricht.

    • attachmentsarray<Attachment22>

      Anhänge der Chatnachricht.

    • reactionsarray<ChatroomMessageReaction6>

      Reaktionen auf die Chat-Nachricht.

    • completedboolean

      Kennzeichen, ob diese Nachricht abgeschlossen ist

    • edited_atstring (date-time)

      Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

    • 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

Antworten

200ChatroomMessage einzeln aktualisierenChatroomMessage3

Felder anzeigen (11)
  • idinteger

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

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

  • participantChatroomParticipant5

    Teilnehmende Person, die die Nachricht verfasst hat.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Teilnehmers. 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.

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment22>

    Anhänge der Chatnachricht.

    Felder anzeigen (26)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • reactionsarray<ChatroomMessageReaction6>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Reaktion. Interne ID.

    • emojistring

      Emoji der Reaktion.

    • participantChatroomParticipant5

      Teilnehmende Person, die reagiert hat.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • deletedboolean

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

  • completedboolean

    Kennzeichen, ob diese Nachricht abgeschlossen ist

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • 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

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_message/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "chatroom": {
      "id": 42,
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    },
    "participant": {
      "id": 42,
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    },
    "completed": true,
    "edited_at": "2026-10-15T09:30:00+02:00"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "participant": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "reactions": [
    {
      "id": 42,
      "image_url": "https://vynst.de",
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Eine einzelne ChatroomMessage löschen

DELETE/api/chat/chatroom_message/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Gibt ein einzelnes ChatroomMessage-Objekt zurück.ChatroomMessage3

Felder anzeigen (11)
  • idinteger

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

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

  • participantChatroomParticipant5

    Teilnehmende Person, die die Nachricht verfasst hat.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Teilnehmers. 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.

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment22>

    Anhänge der Chatnachricht.

    Felder anzeigen (26)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • reactionsarray<ChatroomMessageReaction6>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Reaktion. Interne ID.

    • emojistring

      Emoji der Reaktion.

    • participantChatroomParticipant5

      Teilnehmende Person, die reagiert hat.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • deletedboolean

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

  • completedboolean

    Kennzeichen, ob diese Nachricht abgeschlossen ist

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • 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

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_message/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "participant": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "reactions": [
    {
      "id": 42,
      "image_url": "https://vynst.de",
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}