Zum Inhalt springen
Developer

CustomerChatroom

Chat und Benachrichtigungen8 EndpunkteChat / CustomerChatroom

Liefert eine Liste aller Chatrooms-Objekte.

GET/api/cp/chat/chatroom

Query-Parameter

namestring_LIST, LOGGED_IN_LIST, C1, C2
createdstring_LIST, LOGGED_IN_LIST, C1, C2
companystring_LIST, LOGGED_IN_LIST, C1, C2
eventstring_LIST, LOGGED_IN_LIST, C1, C2
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE_LIST, C1
trustLevelstringBerechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nach außen nur lesbar; gesetzt wird sie ausschließlich vom ChatroomTrustLevelHelper. | _LIST, C1
handoverAtstringSeit wann sich die KI aus dem Raum zurückgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und gelöscht nur vom ChatbotHandoverHelper. | _LIST, C1
personstringDie Person, deren persönlicher Assistenten-Raum das hier ist. Genau eine Person plus Bot - die Logik dazu folgt, das Feld steht schon. | Erfordert Zugriffs-Tag: SCOPE_LIST, C1
mediaQuestionnaireAnswerstring_LIST, C1
idstringErfordert Zugriffsrecht: C1, C2
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 Chatrooms-Objekte.array<Chatroom2>

Felder anzeigen (11)
  • unread_countinteger
  • is_unreadboolean
  • member_managedboolean

    Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit (verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur die Verwaltung. Die Apps blenden danach die Raum-Optionen ein.

  • idinteger

    Primärschlüssel des Chatraums. Interne ID.

  • notification_tokenstring

    Token für Benachrichtigungen des Chatraums.

  • trust_levelstring

    Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nach außen nur lesbar; gesetzt wird sie ausschließlich vom ChatroomTrustLevelHelper.

  • member_started_typestring

    Von Mitgliedern gestartet (Paket D): „direct“ (1:1, chatroom_member_direct_enabled) oder „group“ (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null für alle anderen Räume.

  • handover_atstring (date-time)

    Seit wann sich die KI aus dem Raum zurückgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und gelöscht nur vom ChatbotHandoverHelper.

  • handover_reasonstring

    Siehe HANDOVER_REASON_*.

  • namestring

    Name der Einheit.

  • image_urlstring

    URL des Bildes des Datensatzes.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "unread_count": 1,
    "is_unread": true,
    "member_managed": true,
    "notification_token": "string",
    "trust_level": "string",
    "member_started_type": "string",
    "handover_at": "2026-10-15T09:30:00+02:00"
  }
]

Liefert einen einzelnen Chatroom-Eintrag.

GET/api/cp/chat/chatroom/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

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

Felder anzeigen (12)
  • unread_countinteger
  • is_unreadboolean
  • member_managedboolean

    Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit (verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur die Verwaltung. Die Apps blenden danach die Raum-Optionen ein.

  • is_support_roomboolean

    Ist das der Haushalts-Chat mit dem Verein (Support-Chat)? Die Kunden-Apps sehen die Firma nicht und zeigen damit den Hinweis auf die Buerozeiten (chatroom_support_office_hours_enabled).

  • idinteger

    Primärschlüssel des Chatraums. Interne ID.

  • notification_tokenstring

    Token für Benachrichtigungen des Chatraums.

  • trust_levelstring

    Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nach außen nur lesbar; gesetzt wird sie ausschließlich vom ChatroomTrustLevelHelper.

  • member_started_typestring

    Von Mitgliedern gestartet (Paket D): „direct“ (1:1, chatroom_member_direct_enabled) oder „group“ (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null für alle anderen Räume.

  • handover_atstring (date-time)

    Seit wann sich die KI aus dem Raum zurückgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und gelöscht nur vom ChatbotHandoverHelper.

  • handover_reasonstring

    Siehe HANDOVER_REASON_*.

  • namestring

    Name der Einheit.

  • image_urlstring

    URL des Bildes des Datensatzes.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "member_managed": true,
  "is_support_room": true,
  "notification_token": "string",
  "trust_level": "string",
  "member_started_type": "string"
}

Chatroom verlassen

DELETE/api/cp/chat/chatroom/{identifier}/participant

Nur Event- und Gruppenräume, nicht Support-Räume; Trainer bleiben in ihrem Event-Chat. Die Event-Synchronisation fügt die Person nicht erneut hinzu. Benötigt chatroom_member_leave_enabled.

Pfad-Parameter

identifierPflichtstring

Antworten

200Links

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

Eigene Benachrichtigungsstufe eines Chatraums

GET/api/cp/chat/chatroom/{identifier}/notifications

Liefert level (all | mentions | none), muted_until und die aktuell wirksame Stufe jetzt. Erfordert chatroom_mute_enabled.

Pfad-Parameter

identifierPflichtstring

Antworten

200Benachrichtigungsstufe

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

Legt die eigene Benachrichtigungsstufe eines Chatrooms fest

PUT/api/cp/chat/chatroom/{identifier}/notifications

Body: level (all | mentions | none) und optional muted_hours (1-720) oder muted_until (ISO-Datum), um den Raum für eine Weile vollständig stummzuschalten; keines von beiden hebt die Pause auf. Erfordert chatroom_mute_enabled (sonst 8618).

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • levelstring

    Erlaubt: all mentions none

  • muted_hoursinteger
  • muted_untilstring (date-time)

Antworten

200Benachrichtigungsstufe

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom/42/notifications \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "level": "all",
  "muted_hours": 1,
  "muted_until": "2026-10-15T09:30:00+02:00"
}
'

Legt die eigene Benachrichtigungsstufe eines Chatrooms fest

PATCH/api/cp/chat/chatroom/{identifier}/notifications

Body: level (all | mentions | none) und optional muted_hours (1-720) oder muted_until (ISO-Datum), um den Raum für eine Weile vollständig stummzuschalten; keines von beiden hebt die Pause auf. Erfordert chatroom_mute_enabled (sonst 8618).

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • levelstring

    Erlaubt: all mentions none

  • muted_hoursinteger
  • muted_untilstring (date-time)

Antworten

200Benachrichtigungsstufe

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/chatroom/42/notifications \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "level": "all",
  "muted_hours": 1,
  "muted_until": "2026-10-15T09:30:00+02:00"
}
'
Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/support_hours \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "text": "Text",
  "enabled": true,
  "open": true
}
Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/my_messages/export \
  --header 'x-iw-jwt-token: <TOKEN>'