Get Conversation Log
get
/api/v1/bots/sessions/{channelId}/{userId}/{sessionId}/log
Returns the conversation log for the given session ID.
Request
Path Parameters
-
channelId(required): string
The channel ID for the conversation.
-
sessionId(required): string
The channel session ID for the conversation. From custom component code, you can get the session ID by calling
conversation.sessionId()
. -
userId(required): string
The channel user ID for the conversation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object SessionInteraction
An interaction in the conversation.
Nested Schema : SessionInteraction
Type:
object
An interaction in the conversation.
Show Source
-
createdOn: integer
(int64)
Event creation time as 'UNIX Epoch timestamp'.
-
eventIndex: integer
(int32)
Default Value:
0
The sequence number of the event that's associated with the message. -
id: string
A unique system generated message ID.
-
intentName: string
Default Value:
null
The name of the intent that output the message. -
payload: string
The user utterance or bot response.
-
skillName: string
Default Value:
null
The name of the skill that output the message. -
source: string
Allowed Values:
[ "USER", "BOT", "AGENT", "INTENT" ]
Indicates whether the message came from the USER or the BOT.
404 Response
The given session ID, user ID, and channel ID combination is invalid or Enable Insights is switched to Off in the skill.