Retrieve conversation

curl --request GET \
  --url https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "data": {
            "id": "8977617953",
            "contact_id": "qtr89df0-112d-d197-b541-3f8674663246",
            "archived": 0,
            "important": 1,
            "created_at": "2024-06-14T15:45:34+00:00",
            "messages": [
                {
                    "text": "System variables are predefined variables that contain system information or can be used to perform specific actions. These variables are automatically created by the Builder.",
                    "role": "bot",
                    "is_ai_kb_response": true,
                    "data": {
                        "helpful_value": null,
                        "sources": [
                            {
                                "type": "webpage",
                                "title": "Types of variables - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/variables/variable-types"
                            },
                            {
                                "type": "webpage",
                                "title": "Sidebar - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/sidebar"
                            },
                            {
                                "type": "webpage",
                                "title": "What are variables? - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/variables/what-are-variables"
                            }
                        ]
                    },
                    "created_at": "2024-06-17T16:09:52+00:00"
                },
                {
                    "text": "What are system variables",
                    "role": "user",
                    "created_at": "2024-06-17T16:09:45+00:00"
                },
                {
                    "text": "**Hello! How can I assist you today?**\n\nIf you have any questions related to our chatbot or services, please feel free to ask. I'm here to help!",
                    "role": "bot",
                    "is_ai_kb_response": true,
                    "data": {
                        "helpful_value": null,
                        "sources": []
                    },
                    "created_at": "2024-06-14T15:45:39+00:00"
                },
                {
                    "text": "Hello!",
                    "role": "user",
                    "created_at": "2024-06-14T15:45:34+00:00"
                }
            ]
        }
}

GET

chatbots

{chatbotId}

conversations

{conversationId}

Retrieve conversation

curl --request GET \
  --url https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations/{conversationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "data": {
            "id": "8977617953",
            "contact_id": "qtr89df0-112d-d197-b541-3f8674663246",
            "archived": 0,
            "important": 1,
            "created_at": "2024-06-14T15:45:34+00:00",
            "messages": [
                {
                    "text": "System variables are predefined variables that contain system information or can be used to perform specific actions. These variables are automatically created by the Builder.",
                    "role": "bot",
                    "is_ai_kb_response": true,
                    "data": {
                        "helpful_value": null,
                        "sources": [
                            {
                                "type": "webpage",
                                "title": "Types of variables - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/variables/variable-types"
                            },
                            {
                                "type": "webpage",
                                "title": "Sidebar - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/sidebar"
                            },
                            {
                                "type": "webpage",
                                "title": "What are variables? - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/variables/what-are-variables"
                            }
                        ]
                    },
                    "created_at": "2024-06-17T16:09:52+00:00"
                },
                {
                    "text": "What are system variables",
                    "role": "user",
                    "created_at": "2024-06-17T16:09:45+00:00"
                },
                {
                    "text": "**Hello! How can I assist you today?**\n\nIf you have any questions related to our chatbot or services, please feel free to ask. I'm here to help!",
                    "role": "bot",
                    "is_ai_kb_response": true,
                    "data": {
                        "helpful_value": null,
                        "sources": []
                    },
                    "created_at": "2024-06-14T15:45:39+00:00"
                },
                {
                    "text": "Hello!",
                    "role": "user",
                    "created_at": "2024-06-14T15:45:34+00:00"
                }
            ]
        }
}

Request parameters

Path

chatbotId

string

required

The chatbot ID.

conversationId

string

required

The conversation ID.

Response

status

string

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

data

object

Show properties

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.

Show properties

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.

Show properties

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.

{
    "status": "success",
    "data": {
            "id": "8977617953",
            "contact_id": "qtr89df0-112d-d197-b541-3f8674663246",
            "archived": 0,
            "important": 1,
            "created_at": "2024-06-14T15:45:34+00:00",
            "messages": [
                {
                    "text": "System variables are predefined variables that contain system information or can be used to perform specific actions. These variables are automatically created by the Builder.",
                    "role": "bot",
                    "is_ai_kb_response": true,
                    "data": {
                        "helpful_value": null,
                        "sources": [
                            {
                                "type": "webpage",
                                "title": "Types of variables - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/variables/variable-types"
                            },
                            {
                                "type": "webpage",
                                "title": "Sidebar - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/sidebar"
                            },
                            {
                                "type": "webpage",
                                "title": "What are variables? - Chatling Documentation",
                                "url": "https://docs.chatling.ai/builder/variables/what-are-variables"
                            }
                        ]
                    },
                    "created_at": "2024-06-17T16:09:52+00:00"
                },
                {
                    "text": "What are system variables",
                    "role": "user",
                    "created_at": "2024-06-17T16:09:45+00:00"
                },
                {
                    "text": "**Hello! How can I assist you today?**\n\nIf you have any questions related to our chatbot or services, please feel free to ask. I'm here to help!",
                    "role": "bot",
                    "is_ai_kb_response": true,
                    "data": {
                        "helpful_value": null,
                        "sources": []
                    },
                    "created_at": "2024-06-14T15:45:39+00:00"
                },
                {
                    "text": "Hello!",
                    "role": "user",
                    "created_at": "2024-06-14T15:45:34+00:00"
                }
            ]
        }
}

List conversations Update conversation

​Request parameters

​Path

​Response

Request parameters

Path

Response