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: string
  The channel ID for the conversation.
• sessionId: string
  The channel session ID for the conversation. From custom component code, you can get the session ID by calling conversation.sessionId().
• userId: 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 : SessionTranscript

Type: object

Conversation Log.

Show Source

• insightsConversation(optional): object InsightsConversation
• transcript(optional): array transcript

{
    "type":"object",
    "properties":{
        "transcript":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SessionInteraction"
            }
        },
        "insightsConversation":{
            "$ref":"#/components/schemas/InsightsConversation"
        }
    },
    "description":"Conversation Log."
}

Nested Schema : InsightsConversation

Type: object

Show Source

• channel(optional): string
• componentPath(optional): string
• endState(optional): string
• errorCategory(optional): string
• errorMessage(optional): string
• errorType(optional): string
• intent(optional): string
• language(optional): string
• locale(optional): string
• phrase(optional): string
• speech(optional): boolean
• speechStart(optional): boolean
• stateCount(optional): integer(int32)
• statePath(optional): string
• switched(optional): boolean
• winMargin(optional): number

{
    "type":"object",
    "properties":{
        "statePath":{
            "type":"string"
        },
        "componentPath":{
            "type":"string"
        },
        "endState":{
            "type":"string"
        },
        "stateCount":{
            "type":"integer",
            "format":"int32"
        },
        "intent":{
            "type":"string"
        },
        "channel":{
            "type":"string"
        },
        "locale":{
            "type":"string"
        },
        "speechStart":{
            "type":"boolean"
        },
        "speech":{
            "type":"boolean"
        },
        "switched":{
            "type":"boolean"
        },
        "phrase":{
            "type":"string"
        },
        "errorCategory":{
            "type":"string"
        },
        "errorType":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "language":{
            "type":"string"
        },
        "winMargin":{
            "type":"number"
        }
    }
}

Nested Schema : transcript

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(optional): integer(int64)
  UNIX Epoch timestamp.
• id(optional): string
  Message ID.
• payload(optional): string
  Message payload.
• source(optional): string
  Allowed Values: [ "USER", "BOT", "AGENT", "INTENT" ]

  Message source.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Message ID."
        },
        "payload":{
            "type":"string",
            "description":"Message payload."
        },
        "createdOn":{
            "type":"integer",
            "description":"UNIX Epoch timestamp.",
            "format":"int64"
        },
        "source":{
            "type":"string",
            "description":"Message source.",
            "enum":[
                "USER",
                "BOT",
                "AGENT",
                "INTENT"
            ]
        }
    },
    "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