Zum Inhalt springen
Developer

CustomerChatroomMessage

Chat und Benachrichtigungen11 EndpunkteChat / CustomerChatroomMessage

Ergebnis der Umfrage einer ChatroomMessage.

GET/api/cp/chat/chatroom_message/{identifier}/poll

Zählt je Antwort, die eigenen Stimmen und, sofern die Umfrage nicht anonym ist, wer wofür gestimmt hat. Erfordert chatroom_polls_enabled (sonst 8618).

Pfad-Parameter

identifierPflichtstring

Antworten

200Umfrageergebnis

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42/poll \
  --header 'x-iw-jwt-token: <TOKEN>'

Stimme in der Umfrage einer ChatroomMessage ab

PUT/api/cp/chat/chatroom_message/{identifier}/poll

Body: options (Liste der Antwortschlüssel); ersetzt die eigenen Stimmen, eine leere Liste nimmt die Stimme zurück. Nur ein Schlüssel, sofern die Umfrage nicht mehrere Antworten erlaubt. 8620, sobald die Umfrage geschlossen ist.

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • optionsarray<string>

Antworten

200Umfrageergebnis

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42/poll \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "options": [
    "string"
  ]
}
'

Stimme in der Umfrage einer ChatroomMessage ab

PATCH/api/cp/chat/chatroom_message/{identifier}/poll

Body: options (Liste der Antwortschlüssel); ersetzt die eigenen Stimmen, eine leere Liste nimmt die Stimme zurück. Nur ein Schlüssel, sofern die Umfrage nicht mehrere Antworten erlaubt. 8620, sobald die Umfrage geschlossen ist.

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • optionsarray<string>

Antworten

200Umfrageergebnis

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42/poll \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "options": [
    "string"
  ]
}
'

Umfrage einer ChatroomMessage schließen

PUT/api/cp/chat/chatroom_message/{identifier}/poll/close

Der Ersteller, Raumadministratoren und die Verwaltung beenden eine Umfrage; danach kann niemand mehr abstimmen.

Pfad-Parameter

identifierPflichtstring

Antworten

200Umfrageergebnis

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42/poll/close \
  --header 'x-iw-jwt-token: <TOKEN>'

Umfrage einer ChatroomMessage schließen

PATCH/api/cp/chat/chatroom_message/{identifier}/poll/close

Der Ersteller, Raumadministratoren und die Verwaltung beenden eine Umfrage; danach kann niemand mehr abstimmen.

Pfad-Parameter

identifierPflichtstring

Antworten

200Umfrageergebnis

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42/poll/close \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert eine Liste aller ChatroomMessages-Objekte.

GET/api/cp/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<ChatroomMessage>

Felder anzeigen (8)
  • idinteger

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

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment2>

    Anhänge der Chatnachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

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

  • reactionsarray<ChatroomMessageReaction4>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (4)
    • 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.

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "message_text": "Text",
    "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/cp/chat/chatroom_message/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

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

Felder anzeigen (8)
  • idinteger

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

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment2>

    Anhänge der Chatnachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

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

  • reactionsarray<ChatroomMessageReaction4>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (4)
    • 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.

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "googledownloadlink": "string",
      "virus_checked": true
    }
  ],
  "reactions": [
    {
      "id": 42,
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "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/cp/chat/chatroom_message/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataChatroomMessage
    Felder anzeigen (8)
    • idinteger

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

    • message_textstring

      Text der Chat-Nachricht.

    • attachmentsarray<Attachment2>

      Anhänge der Chatnachricht.

    • reactionsarray<ChatroomMessageReaction4>

      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.

Antworten

200ChatroomMessage einzeln aktualisierenChatroomMessage

Felder anzeigen (8)
  • idinteger

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

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment2>

    Anhänge der Chatnachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

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

  • reactionsarray<ChatroomMessageReaction4>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (4)
    • 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.

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

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "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"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "googledownloadlink": "string",
      "virus_checked": true
    }
  ],
  "reactions": [
    {
      "id": 42,
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "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/cp/chat/chatroom_message/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataChatroomMessage
    Felder anzeigen (8)
    • idinteger

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

    • message_textstring

      Text der Chat-Nachricht.

    • attachmentsarray<Attachment2>

      Anhänge der Chatnachricht.

    • reactionsarray<ChatroomMessageReaction4>

      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.

Antworten

200ChatroomMessage einzeln aktualisierenChatroomMessage

Felder anzeigen (8)
  • idinteger

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

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment2>

    Anhänge der Chatnachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

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

  • reactionsarray<ChatroomMessageReaction4>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (4)
    • 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.

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

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "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"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "googledownloadlink": "string",
      "virus_checked": true
    }
  ],
  "reactions": [
    {
      "id": 42,
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "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"
}

ChatroomMessage neu anlegen

POST/api/cp/chat/chatroom_message/{chatroomIdentifier}

Pfad-Parameter

chatroomIdentifierPflichtstring

Request-Body application/json

  • dataChatroomMessage
    Felder anzeigen (8)
    • idinteger

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

    • message_textstring

      Text der Chat-Nachricht.

    • attachmentsarray<Attachment2>

      Anhänge der Chatnachricht.

    • reactionsarray<ChatroomMessageReaction4>

      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.

Antworten

200ChatroomMessage neu anlegenChatroomMessage

Felder anzeigen (8)
  • idinteger

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

  • message_textstring

    Text der Chat-Nachricht.

  • attachmentsarray<Attachment2>

    Anhänge der Chatnachricht.

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googledownloadlinkstring

      Download-Link der Datei in Google Drive.

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

  • reactionsarray<ChatroomMessageReaction4>

    Reaktionen auf die Chat-Nachricht.

    Felder anzeigen (4)
    • 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.

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

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom_message/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "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"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "googledownloadlink": "string",
      "virus_checked": true
    }
  ],
  "reactions": [
    {
      "id": 42,
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "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"
}