/api/chat1
Send a chat query and receive a (bot) response. The Bot configuration is part of the backend setup.
Parameters
| Name | Description | Type |
|---|---|---|
| q | question | string |
| c | alternatively to q, a chat command, one of 'archive', 'delete', 'flag'. | string |
| sid | chat session number. Usually maintained by the server side session if the web session id is provided | string |
| altcha | guests, with the ShopSetup altcha on: the solved ALTCHA payload (see api/client/altcha), needed with the question that opens a chat session. Without it the call fails with error CAPTCHA; too many guest questions fail with LIMIT | string |
| oo-rf | optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml | String |
| oo-auth | optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. | int |
Response Types
| Type | Version | Description |
|---|---|---|
| ChatControl | 1 | Chat service availability status |
| ChatResponse | 1 | A chat bot response message or a message in a chat transcript. |
OpenAPI
See chat1.yaml