Send a chat query and receive a (bot) response. The Bot configuration is part of the backend setup.
Chat service availability status
| # | Field | Type | Description |
|---|---|---|---|
| 0 | status | int | control status code: -2=chat(bot) disabled in this system or not open for the current user, 0=offline, 1=online (control only), 2=OK - a ChatResponse with the answer follows |
Data (1 record)
| status |
|---|
| 2 |
A chat bot response message or a message in a chat transcript.
| # | Field | Type | Description | Links |
|---|---|---|---|---|
| 0 | sid | string | chat session id. Usually maintained in the server side session. | ⬆ sid🔗 chat_sid |
| 1 | speech | string | text response from the chat bot, intended for speech output | |
| 2 | display | string | display-ready HTML response. While the content should be similar to the speech output, the format may be different, depending on the chat provider. | |
| 3 | action | string | microformat action string, handled by the client. E.g. [g:123] is a advice to the client to show items or a link to item group 123. | |
| 4 | dt | datetime | message timestamp, time of generation | |
| 5 | agent | string | agent name, set for bot answers, empty for user messages |
Data (1 record)
| sid | speech | display | action | dt | agent |
|---|---|---|---|---|---|
| e288f7da-6787-4579-80f8-6@schoenegge →chatscript1 →chat1 ⬆ | 2026-11-22T16:02:37+0100 |