Zum Inhalt springen
Developer

CustomerChatroomMember

Chat und Benachrichtigungen8 EndpunkteChat / CustomerChatroomMember

Personen, mit denen das Mitglied einen Direktchat beginnen darf

GET/api/cp/chat/contacts

Geteilte aktuelle, bevorstehende oder kürzlich vergangene Veranstaltung (chatroom_member_direct_via_event, standardmäßig aktiv) oder geteilte Abteilung (chatroom_member_direct_via_department), ohne gesperrte Personen. Die Abfrage q filtert nach Name. Erfordert chatroom_member_direct_enabled (sonst 8618).

Query-Parameter

qstringTeil des Namens

Antworten

200Liste von {person_id, name, reasons}

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

Direkten Chat mit einer Person abrufen oder starten

POST/api/cp/chat/direct

Body: person (ID). Dieselben zwei Personen erhalten immer denselben Raum. Fehler: 8618 aus, 8621 keine gemeinsame Veranstaltung/Abteilung, 8622 gesperrt, 8623 Minderjährigenschutz ohne hinterlegte Eltern. Beim Minderjährigenschutz erhalten die Eltern des Minderjährigen bei einem Chat zwischen einem Erwachsenen und einem Minderjährigen die Leseberechtigung.

Request-Body application/json

  • personinteger

Antworten

200{id, token, name, member_started_type}

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/direct \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{"person":1}'

Personen, die ein Trainer in eine Gruppe aufnehmen darf

GET/api/cp/chat/group_candidates

Angemeldete (nicht wartende) und leitende Personen der Veranstaltungen, die das Mitglied leitet (aktuelle, bevorstehende oder kürzlich vergangene). Erfordert chatroom_trainer_groups_enabled (sonst 8618); 8624 für Mitglieder, die keine Veranstaltung leiten.

Antworten

200Liste von {person_id, name, reasons}

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

Einen Gruppenchat als Trainer starten

POST/api/cp/chat/group

Body: name (1–100 Zeichen), persons (IDs aus group_candidates, 1–100). Der Trainer ist Raum-Admin. Fehler: 8618 aus, 8624 kein Trainer, 8621 eine Person ist nicht in den Veranstaltungen des Trainers.

Request-Body application/json

  • namestring
  • personsarray<integer>

Antworten

200{id, token, name, member_started_type}

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/group \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "name": "Beispiel",
  "persons": [
    1
  ]
}
'

Eine Chat-Nachricht melden.

POST/api/cp/chat/chatroom_message/{identifier}/report

Body: reason (optional, bis zu 1000 Zeichen). Die Verwaltung sieht die Meldung in ihrer Warteschlange (Chat, Meldungen). Mit chatroom_ai_moderation_enabled wird eine ungeprüfte Nachricht nach der Antwort von der KI-Moderation geprüft. Nur Teilnehmer des Raums melden, nicht ihre eigenen Nachrichten; eine zweite Meldung derselben Person zur selben Nachricht aktualisiert die offene. Erfordert chatroom_message_report_enabled (sonst 8618).

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • reasonstring

Antworten

200{id, status}

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

Die Personen, die das Mitglied blockiert hat

GET/api/cp/chat/blocks

Erfordert chatroom_block_enabled (sonst 8618).

Antworten

200Liste von {id, person_id, name, created}

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

Person sperren

POST/api/cp/chat/blocks

Body: person (ID). Keine Direktchats mehr in beide Richtungen, und die Nachrichten der Person sind für das Mitglied in allen Räumen ausgeblendet. Zweimaliges Sperren behält die erste Sperre. Erfordert chatroom_block_enabled (sonst 8618).

Request-Body application/json

  • personinteger

Antworten

200{id, person_id, name, created}

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/blocks \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{"person":1}'

Person entsperren

DELETE/api/cp/chat/blocks/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200{removed: bool}

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