Conversations

Retrieve a full thread

Gets a full conversation thread between the AI Agent and any interacting users. This will include both external users interacting with the chatbot or live agents interacting with your customer.

GET/v1/accounts/:accountID/application/:applicationID/ai-agents/:aiAgentID/sessions/:chatSessionID/messages

curl --request GET \
  --url http://api.sidecarcx.com/v1/accounts/:accountID/application/:applicationID/ai-agents/:aiAgentID/sessions/:chatSessionID/messages \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Path Parameters

:accountID - REQUIRED[String]
The referenced account ID.
:applicationID - REQUIRED[String]
The referenced application ID.
:aiAgentID - REQUIRED[String]
The referenced AI Agent ID.
:chatSessionID - REQUIRED[String]
The referenced chat session ID.

Chat Messages Response - [Map]

A list of chat messages.

Attributes

chatMessages - REQUIRED[Array]
The list of chat messages.
List Contents (chatMessages)- type of [Map]
- chatMessages[0].actor - REQUIRED[String]
  The actor who sent the message.
- chatMessages[0].actorEmail - OPTIONAL[String]
  The email of the actor.
- chatMessages[0].actorUserID - OPTIONAL[String]
  The ID of the actor.
- chatMessages[0].chatMessageID - REQUIRED[String]
  The chat message identifier.
- chatMessages[0].createdAt - REQUIRED[String]
  The date the message was created.
- chatMessages[0].message - REQUIRED[String]
  The chat message.
- chatMessages[0].updatedAt - REQUIRED[String]
  The date the message was last updated.
- chatMessages[0].voteStatus - OPTIONAL[String]
  The vote status of the message, only applies to bot actors.
totalChatMessages - REQUIRED[Integer]
The total number of chat messages.

Chat Messages Response Shape

{
  "chatMessages": [
    {
      "actor": "string",
      "actorEmail": "string",
      "actorUserID": "string",
      "chatMessageID": "string",
      "createdAt": "string",
      "message": "string",
      "updatedAt": "string",
      "voteStatus": "string"
    }
  ],
  "totalChatMessages": 0
}

Errors

A common set of Error Responses can be found here.