Retrieve a conversation

curl --request GET \
  --url https://app.livechatai.com/api/v2/conversations/{conversationId} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "id": "chat_1234567890",
    "contactId": "contact_1234567890",
    "agentId": "clx1234567890abcdef",
    "isResolved": false,
    "isAgent": false,
    "isMuted": false,
    "isStarred": false,
    "integrationType": "WHATSAPP",
    "lastMessageDate": "2024-01-20T14:45:00Z",
    "agent": {
      "id": "agent_1234567890",
      "name": "Jane Smith",
      "email": "[email protected]",
      "avatar": "https://example.com/avatar.jpg"
    },
    "messages": [
      {
        "id": "msg_1234567890",
        "content": "What are your business hours?",
        "role": "user",
        "type": "TEXT",
        "source": [
          {
            "id": "src_1234567890",
            "type": "WEBSITE",
            "link": "https://example.com/page",
            "distance": 0.85
          }
        ],
        "agent": {
          "id": "agent_1234567890",
          "name": "Jane Smith",
          "email": "[email protected]",
          "avatar": "https://example.com/avatar.jpg"
        },
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T14:45:00Z"
  }
}

GET

api

conversations

{conversationId}

Retrieve a conversation

curl --request GET \
  --url https://app.livechatai.com/api/v2/conversations/{conversationId} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "id": "chat_1234567890",
    "contactId": "contact_1234567890",
    "agentId": "clx1234567890abcdef",
    "isResolved": false,
    "isAgent": false,
    "isMuted": false,
    "isStarred": false,
    "integrationType": "WHATSAPP",
    "lastMessageDate": "2024-01-20T14:45:00Z",
    "agent": {
      "id": "agent_1234567890",
      "name": "Jane Smith",
      "email": "[email protected]",
      "avatar": "https://example.com/avatar.jpg"
    },
    "messages": [
      {
        "id": "msg_1234567890",
        "content": "What are your business hours?",
        "role": "user",
        "type": "TEXT",
        "source": [
          {
            "id": "src_1234567890",
            "type": "WEBSITE",
            "link": "https://example.com/page",
            "distance": 0.85
          }
        ],
        "agent": {
          "id": "agent_1234567890",
          "name": "Jane Smith",
          "email": "[email protected]",
          "avatar": "https://example.com/avatar.jpg"
        },
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T14:45:00Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

conversationId

string

required

Unique identifier of the conversation to retrieve

Example:

"chat_1234567890"

Response

Successfully retrieved conversation details

status

string

Example:

"success"

data

object

Show child attributes

data.id

string

Example:

"chat_1234567890"

data.contactId

string

Example:

"contact_1234567890"

data.agentId

string

Example:

"clx1234567890abcdef"

data.isResolved

boolean

Example:

false

data.isAgent

boolean

Example:

false

data.isMuted

boolean

Example:

false

data.isStarred

boolean

Example:

false

data.integrationType

enum<string> | null

Integration type of the conversation

Available options:

WHATSAPP,

SLACK

Example:

"WHATSAPP"

data.lastMessageDate

string<date-time>

Date of the last message

Example:

"2024-01-20T14:45:00Z"

data.agent

object

Show child attributes

data.agent.id

string

Example:

"agent_1234567890"

data.agent.name

string

Example:

"Jane Smith"

data.agent.email

string

Example:

"[email protected]"

data.agent.avatar

string

Example:

"https://example.com/avatar.jpg"

data.messages

object[]

Show child attributes

data.messages.id

string

Example:

"msg_1234567890"

data.messages.content

string

Example:

"What are your business hours?"

data.messages.role

enum<string>

Available options:

user,

assistant

Example:

"user"

data.messages.type

string

Type of the message

Example:

"TEXT"

data.messages.source

object[]

Sources used for generating the message response

Show child attributes

data.messages.source.id

string

Example:

"src_1234567890"

data.messages.source.type

enum<string>

Available options:

WEBSITE,

TEXT,

QA,

PDF,

YOUTUBE,

DOCX,

IMAGE,

NOTION

Example:

"WEBSITE"

data.messages.source.link

string

Example:

"https://example.com/page"

data.messages.source.distance

number | null

Example:

0.85

data.messages.agent

object

Show child attributes

data.messages.agent.id

string

Example:

"agent_1234567890"

data.messages.agent.name

string

Example:

"Jane Smith"

data.messages.agent.email

string

Example:

"[email protected]"

data.messages.agent.avatar

string

Example:

"https://example.com/avatar.jpg"

data.messages.createdAt

string<date-time>

Example:

"2024-01-15T10:30:00Z"

data.createdAt

string<date-time>

Example:

"2024-01-15T10:30:00Z"

data.updatedAt

string<date-time>

Example:

"2024-01-20T14:45:00Z"

Send a message Reply to a conversation

⌘I

API v2 Documentation

Agents

Conversations

Contacts

Data Sources

Analytics

Retrieve a conversation

Authorizations

Path Parameters

Response