Chatroom

Chat and notifications13 EndpointsChat / Chatroom

Returns a list of all Chatrooms

GET/api/chat/chatroom

Query parameters

`name`string	_LIST, LOGGED_IN_LIST, C1, C2
`created`string	_LIST, LOGGED_IN_LIST, C1, C2
`company`string	_LIST, LOGGED_IN_LIST, C1, C2
`event`string	_LIST, LOGGED_IN_LIST, C1, C2
`deleted`boolean	This property is used to mark an entity as deleted / archived \| _LIST, C1
`trustLevel`string	Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich vom ChatroomTrustLevelHelper. \| _LIST, C1
`handoverAt`string	Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper. \| _LIST, C1
`person`string	Die Person, deren persoenlicher Assistenten-Raum das hier ist. Genau eine Person plus Bot - die Logik dazu folgt, das Feld steht schon. \| _LIST, C1
`mediaQuestionnaireAnswer`string	_LIST, C1
`id`string	Requires access right: C1, C2
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of all Chatroomsarray<Chatroom3>

Show fields (20)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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.
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/chat/chatroom \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/chat/chatroom', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "unread_count": 1,
    "is_unread": true,
    "chatbot_active": true,
    "member_managed": true,
    "support_status": "string",
    "token": "string",
    "notification_token": "string"
  }
]

Add a new Chatroom

POST/api/chat/chatroom

Request body application/json

dataChatroom4
Show fields (22)
- unread_countinteger
- is_unreadboolean
- chatbot_activeboolean
  Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
- 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).
- support_statusstring
  Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
- idinteger
  Primary key of the chat room. Internal ID.
- tokenstring
  Token that identifies the chat room.
- notification_tokenstring
  Token used for notifications of the chat room.
- participantsarray<ChatroomParticipant4>
  Participants of the chat room.
- last_read_atstring (date-time)
  A timestamp of the last time a admin participant read the chatroom
- message_count_readinteger
  Number of messages read.
- trust_levelstring
  Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
- handover_atstring (date-time)
  Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
- handover_reasonstring
  Siehe HANDOVER_REASON_*.
- support_snoozed_untilstring (date-time)
  Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.

Responses

200Add a new ChatroomChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/chat/chatroom \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "unread_count": 1,
    "is_unread": true,
    "chatbot_active": true
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      name: 'Beispiel',
      image_url: 'https://vynst.de',
      unread_count: 1,
      is_unread: true,
      chatbot_active: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom"

payload = { "data": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "unread_count": 1,
    "is_unread": True,
    "chatbot_active": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/chat/chatroom', [
  'body' => '{"data":{"id":42,"name":"Beispiel","image_url":"https://vynst.de","unread_count":1,"is_unread":true,"chatbot_active":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/chatroom.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.post(Chatroom.fromJson({
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Returns a single Chatroom entry.

GET/api/chat/chatroom/{identifier}

Path parameters

identifierrequiredstring

Responses

200Return single ChatroomChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/chat/chatroom/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Updates an existing Chatroom entry.

PUT/api/chat/chatroom/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataChatroom4
Show fields (22)
- unread_countinteger
- is_unreadboolean
- chatbot_activeboolean
  Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
- 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).
- support_statusstring
  Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
- idinteger
  Primary key of the chat room. Internal ID.
- tokenstring
  Token that identifies the chat room.
- notification_tokenstring
  Token used for notifications of the chat room.
- participantsarray<ChatroomParticipant4>
  Participants of the chat room.
- last_read_atstring (date-time)
  A timestamp of the last time a admin participant read the chatroom
- message_count_readinteger
  Number of messages read.
- trust_levelstring
  Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
- handover_atstring (date-time)
  Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
- handover_reasonstring
  Siehe HANDOVER_REASON_*.
- support_snoozed_untilstring (date-time)
  Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.

Responses

200Update single ChatroomChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "unread_count": 1,
    "is_unread": true,
    "chatbot_active": true
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      name: 'Beispiel',
      image_url: 'https://vynst.de',
      unread_count: 1,
      is_unread: true,
      chatbot_active: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42"

payload = { "data": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "unread_count": 1,
    "is_unread": True,
    "chatbot_active": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/chat/chatroom/42', [
  'body' => '{"data":{"id":42,"name":"Beispiel","image_url":"https://vynst.de","unread_count":1,"is_unread":true,"chatbot_active":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/chatroom.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.put(Chatroom.fromJson({
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Updates an existing Chatroom entry.

PATCH/api/chat/chatroom/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataChatroom4
Show fields (22)
- unread_countinteger
- is_unreadboolean
- chatbot_activeboolean
  Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
- 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).
- support_statusstring
  Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
- idinteger
  Primary key of the chat room. Internal ID.
- tokenstring
  Token that identifies the chat room.
- notification_tokenstring
  Token used for notifications of the chat room.
- participantsarray<ChatroomParticipant4>
  Participants of the chat room.
- last_read_atstring (date-time)
  A timestamp of the last time a admin participant read the chatroom
- message_count_readinteger
  Number of messages read.
- trust_levelstring
  Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
- handover_atstring (date-time)
  Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
- handover_reasonstring
  Siehe HANDOVER_REASON_*.
- support_snoozed_untilstring (date-time)
  Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.

Responses

200Update single ChatroomChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "unread_count": 1,
    "is_unread": true,
    "chatbot_active": true
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      name: 'Beispiel',
      image_url: 'https://vynst.de',
      unread_count: 1,
      is_unread: true,
      chatbot_active: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42"

payload = { "data": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "unread_count": 1,
    "is_unread": True,
    "chatbot_active": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/chat/chatroom/42', [
  'body' => '{"data":{"id":42,"name":"Beispiel","image_url":"https://vynst.de","unread_count":1,"is_unread":true,"chatbot_active":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"unread_count\":1,\"is_unread\":true,\"chatbot_active\":true}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/chat/chatroom/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "id": 42,
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "unread_count": 1,
      "is_unread": true,
      "chatbot_active": true
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Delete a single Chatroom

DELETE/api/chat/chatroom/{identifier}

Path parameters

identifierrequiredstring

Responses

200Return single ChatroomChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.delete(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/chat/chatroom/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.delete('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Liefert den persoenlichen Assistenten-Raum der eingeloggten Person und legt ihn beim ersten Aufruf an.

POST/api/chat/chatroom/assistant

Read genuegt: der Aufruf beruehrt ausschliesslich die eigene Person, das Profil kommt aus den Einstellungen und ist nicht frei waehlbar.

Responses

200Der persoenliche Assistenten-Raum der eingeloggten PersonChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/assistant \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/assistant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/assistant"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/chat/chatroom/assistant', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/assistant"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/assistant")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/assistant"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.getOrCreateAssistant();
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Status und Zuweisung eines Support-Raums setzen (chatroom_support_inbox_enabled, sonst 8618).

PUT/api/chat/chatroom/{identifier}/support

Nur gesendete Felder aendern sich, null leert sie. Fehler: 8625 kein Support-Raum, 8626 unbekannter Status, ungueltiges Datum oder unbekannte Person bzw. Gruppe.

Path parameters

identifierrequiredstring

Request body application/json

statusstring
Allowed: open snoozed resolved
snoozed_untilstring (date-time)
Nur fuer snoozed; leer = bis der Kunde schreibt
assigned_userinteger
Benutzer-Id, null = niemand
assigned_groupinteger
Benutzergruppen-Id, null = keine

Responses

200Der Raum mit neuem Status und neuer ZuweisungChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42/support \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "status": "open",
  "snoozed_until": "2026-10-15T09:30:00+02:00",
  "assigned_user": 1,
  "assigned_group": 1
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    status: 'open',
    snoozed_until: '2026-10-15T09:30:00+02:00',
    assigned_user: 1,
    assigned_group: 1
  })
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42/support', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42/support"

payload = {
  "status": "open",
  "snoozed_until": "2026-10-15T09:30:00+02:00",
  "assigned_user": 1,
  "assigned_group": 1
}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/chat/chatroom/42/support', [
  'body' => '{"status":"open","snoozed_until":"2026-10-15T09:30:00+02:00","assigned_user":1,"assigned_group":1}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42/support"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"status\":\"open\",\"snoozed_until\":\"2026-10-15T09:30:00+02:00\",\"assigned_user\":1,\"assigned_group\":1}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"status\":\"open\",\"snoozed_until\":\"2026-10-15T09:30:00+02:00\",\"assigned_user\":1,\"assigned_group\":1}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42/support")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42/support"

	payload := strings.NewReader("{\"status\":\"open\",\"snoozed_until\":\"2026-10-15T09:30:00+02:00\",\"assigned_user\":1,\"assigned_group\":1}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.setSupport('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Status und Zuweisung eines Support-Raums setzen (chatroom_support_inbox_enabled, sonst 8618).

PATCH/api/chat/chatroom/{identifier}/support

Nur gesendete Felder aendern sich, null leert sie. Fehler: 8625 kein Support-Raum, 8626 unbekannter Status, ungueltiges Datum oder unbekannte Person bzw. Gruppe.

Path parameters

identifierrequiredstring

Request body application/json

statusstring
Allowed: open snoozed resolved
snoozed_untilstring (date-time)
Nur fuer snoozed; leer = bis der Kunde schreibt
assigned_userinteger
Benutzer-Id, null = niemand
assigned_groupinteger
Benutzergruppen-Id, null = keine

Responses

200Der Raum mit neuem Status und neuer ZuweisungChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42/support \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "status": "open",
  "snoozed_until": "2026-10-15T09:30:00+02:00",
  "assigned_user": 1,
  "assigned_group": 1
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    status: 'open',
    snoozed_until: '2026-10-15T09:30:00+02:00',
    assigned_user: 1,
    assigned_group: 1
  })
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42/support', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42/support"

payload = {
  "status": "open",
  "snoozed_until": "2026-10-15T09:30:00+02:00",
  "assigned_user": 1,
  "assigned_group": 1
}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/chat/chatroom/42/support', [
  'body' => '{"status":"open","snoozed_until":"2026-10-15T09:30:00+02:00","assigned_user":1,"assigned_group":1}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42/support"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"status\":\"open\",\"snoozed_until\":\"2026-10-15T09:30:00+02:00\",\"assigned_user\":1,\"assigned_group\":1}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"status\":\"open\",\"snoozed_until\":\"2026-10-15T09:30:00+02:00\",\"assigned_user\":1,\"assigned_group\":1}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42/support")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42/support"

	payload := strings.NewReader("{\"status\":\"open\",\"snoozed_until\":\"2026-10-15T09:30:00+02:00\",\"assigned_user\":1,\"assigned_group\":1}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/chat/chatroom/42/support'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "status": "open",
    "snoozed_until": "2026-10-15T09:30:00+02:00",
    "assigned_user": 1,
    "assigned_group": 1
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Wem ein Support-Raum zugewiesen werden kann: Benutzergruppen mit Lese-Recht auf den Chat und ihre Benutzer (chatroom_support_inbox_enabled, sonst 8618).

GET/api/chat/chatroom_support_assignees

Responses

200users (id, name, group_id) und groups (id, name)

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/chat/chatroom_support_assignees \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom_support_assignees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom_support_assignees"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/chat/chatroom_support_assignees', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom_support_assignees"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom_support_assignees")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom_support_assignees"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.getSupportAssignees();
if (result.success) {
  print(result.data);
}

Den Verlauf eines anonymen Besuchers in den Support-Chat des Haushalts der Person uebernehmen (chatroom_support_merge_visitor_enabled, sonst 8618). Der Besucher verliert den Zugang zum alten Raum, der geschlossen wird. Fehler: 8627 kein Besucher im Raum, Person ohne Haushalt.

POST/api/chat/chatroom/{identifier}/merge_visitor

Path parameters

identifierrequiredstring

Request body application/json

personinteger
CRM-Person, der der Besucher entspricht

Responses

200Der Support-Chat des Haushalts mit dem uebernommenen VerlaufChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42/merge_visitor \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{"person":1}'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({person: 1})
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42/merge_visitor', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42/merge_visitor"

payload = { "person": 1 }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/chat/chatroom/42/merge_visitor', [
  'body' => '{"person":1}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42/merge_visitor"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"person\":1}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"person\":1}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42/merge_visitor")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42/merge_visitor"

	payload := strings.NewReader("{\"person\":1}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.mergeVisitor('42', 42);
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Das Team uebernimmt einen Support-Raum: die KI zieht sich zurueck, ohne dass schon jemand geschrieben hat (Support-Modus, "Uebernehmen").

POST/api/chat/chatroom/{identifier}/handover

Path parameters

identifierrequiredstring

Responses

200Die KI uebergibt den Raum an das TeamChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42/handover \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42/handover', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42/handover"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/chat/chatroom/42/handover', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42/handover"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42/handover")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42/handover"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.handover('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}

Die KI antwortet im Raum wieder.

DELETE/api/chat/chatroom/{identifier}/handover

Path parameters

identifierrequiredstring

Responses

200Die KI antwortet im Raum wiederChatroom4

Show fields (22)

unread_countinteger
is_unreadboolean
chatbot_activeboolean
Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung: dort kann das Team den Raum dann uebernehmen.
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).
support_statusstring
Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.
idinteger
Primary key of the chat room. Internal ID.
tokenstring
Token that identifies the chat room.
notification_tokenstring
Token used for notifications of the chat room.
participantsarray<ChatroomParticipant4>
Participants of the chat room.
Show fields (30)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
last_read_atstring (date-time)
A timestamp of the last time a admin participant read the chatroom
message_count_readinteger
Number of messages read.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich 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 fuer alle anderen Raeume.
handover_atstring (date-time)
Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
support_snoozed_untilstring (date-time)
Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/chat/chatroom/42/handover \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom/42/handover', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom/42/handover"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.delete(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/chat/chatroom/42/handover', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom/42/handover"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom/42/handover")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom/42/handover"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomController.resumeChatbot('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "chatbot_active": true,
  "member_managed": true,
  "is_support_room": true,
  "support_status": "string",
  "token": "string"
}