/api/chatscript1

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

Parameters

(string) 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.🔗 chat_sid
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) 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.

Response Types

ChatResponse

ChatResponse (v1) docs

A chat bot response message or a message in a chat transcript.

Fields (6)
#FieldTypeDescriptionLinks
0sidstringchat session id. Usually maintained in the server side session.⬆ chatid🔗 chat_sid
1speechstringtext response from the chat bot, intended for speech output
2displaystringdisplay-ready HTML response. While the content should be similar to the speech output, the format may be different, depending on the chat provider.
3actionstringmicroformat 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.
4dtdatetimemessage timestamp, time of generation
5agentstringagent name, set for bot answers, empty for user messages

Data (1 record)

sidspeechdisplayactiondtagent
Hallo, ich heiße Grille und kenne mich hier im Shop aus! Wie kann ich dir helfen?Hallo, ich heiße Grille und kenne mich hier im Shop aus! Wie kann ich dir helfen?Jim