try out ↗

← API Index


/api/chatscript1

Retrieve the chat conversation transcript. There is always only one active chat conversation per user.

Parameters

Name Description Type
chatid the id of the chat session. If there is a valid session, this parameter is not required and maintained server side. If a chat transcript is found, its returned as a sequence of ChatResponses. A user may only look up own transcripts, a admin may have access to all. 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
ChatResponse 1 A chat bot response message or a message in a chat transcript.

OpenAPI

See chatscript1.yaml

Referenced in skills