Chatling Documentation home page

Dashboard

Conversations

List conversations

Documentation

API Reference

Introduction
Rate limiting

Project

GET
List settings
PATCH
Update settings

Members

GET
List members

Chatbots

GET
List chatbot templates
POST
Create chatbot
GET
List chatbots
GET
Retrieve chatbot
PATCH
Update chatbot settings

AI

GET
List AI models
GET
List AI languages
POST
Chat

Contacts

GET
List contacts
GET
Retrieve contact
DEL
Delete contact

Conversations

GET
List conversations
GET
Retrieve conversation
PATCH
Update conversation
GET
List conversation messages

Knowledge base

GET
List data sources
POST
Add link
POST
Add text
POST
Add FAQ
POST
Resync data source
DEL
Delete data source

Usage

GET
AI Credits
GET
Email Credits
GET
Knowledge Base
GET
Chatbots
GET
User Seats

Conversations

List conversations

Get a list of all the chatbot’s conversations with users.

GET

chatbots

{chatbotId}

conversations

Request parameters

Path

chatbotId

string

required

The chatbot ID.

Query

page

integer

default: "1"

The page number for pagination.

sort

string

default: "date_desc"

The sort order. Possible values:

date_desc: Sort by date in descending order.
date_asc: Sort by date in ascending order.

Response

status

string

The status of the request. Will be success if the request was successful, otherwise error.

data

object

pages

object

current_page

integer

The current page number.

last_page

integer

The last page number.

per_page

integer

The number of items per page.

conversations

array

string

The unique identifier of the conversation.

contact_id

string

The unique identifier of the contact associated with the conversation.

archived

boolean

Whether the conversation is archived (by the admin).

important

boolean

Whether the conversation is marked as important.

created_at

string

The date and time when the conversation was created.

messages

array

List of the most recent 20 messages in the conversation.

string

The unique identifier of the message.

text

string

The text content of the message.

role

string

The role of the sender of the message (bot, user, or system).

is_ai_kb_response

boolean

Whether the message is generated by the AI using the knowledge base.

data

object

The data of the message. Varies depending on the message type.

helpful_value

string

(AI response) Whether the AI’s response was marked as helpful by the user. Possible values are 1 for helpful, 0 for not helpful, and null for not rated.

sources

string

(AI response) The sources used by the AI to generate the response.

created_at

string

The date and time when the message was created.

Delete contact Retrieve conversation

x linkedin

Project

Members

Chatbots

AI

Contacts

Conversations

Knowledge base

Usage

​Request parameters

​Path

​Query

​Response

Request parameters

Path

Query

Response