Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SessionInteraction
  An interaction in the conversation.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SessionInteraction"
    }
}

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"A unique system generated message ID."
        },
        "payload":{
            "type":"string",
            "description":"The user utterance or bot response."
        },
        "createdOn":{
            "type":"integer",
            "description":"Event creation time as 'UNIX Epoch timestamp'.",
            "format":"int64"
        },
        "source":{
            "type":"string",
            "description":"Indicates whether the message came from the USER or the BOT.",
            "enum":[
                "USER",
                "BOT",
                "AGENT",
                "INTENT"
            ]
        },
        "skillName":{
            "type":"string",
            "description":"The name of the skill that output the message.",
            "default":"null"
        },
        "eventIndex":{
            "type":"integer",
            "description":"The sequence number of the event that's associated with the message.",
            "format":"int32",
            "default":0
        },
        "intentName":{
            "type":"string",
            "description":"The name of the intent that output the message.",
            "default":"null"
        }
    },
    "description":"An interaction in the conversation."
}

404 Response

The given session ID, user ID, and channel ID combination is invalid or Enable Insights is switched to Off in the skill.

Back to Top