Chatbase

获取对话

开发环境

GET

/api/v1/get-conversations

获取对话 API 端点允许您从特定聊天机器人检索对话。您可以根据各种条件过滤对话，包括聊天机器人的 ID、日期范围和过滤的来源。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/api/v1/get-conversations?chatbotId=<chatbot-id>startDate=2023-01-01&endDate=2023-12-12&page=1&size=20' \
--header 'Authorization: Bearer <Your-Secret-Key>'

响应示例

{
  "data": [
    {
      "id": "string",
      "created_at": "string",
      "messages": [
        {
          "role": "string",
          "content": "string"
        }
      ],
      "chatbot_id": "string",
      "customer": "string",
      "source": "string"
    }
  ]
}

请求参数

Query 参数

chatbotId

string

必需

您要从中检索对话的目标聊天机器人的 ID（可在聊天机器人设置中找到）。

示例值:

<chatbot-id>startDate=2023-01-01

endDate

string

可选

示例值:

2023-12-12

page

string

可选

表示结果页码的字符串，用于分页。

示例值:

size

string

可选

表示每页结果数的字符串，也用于分页。

示例值:

Header 参数

Authorization

string

必需

示例值:

Bearer <Your-Secret-Key>

返回响应

🟢200成功

application/json

Body

data

array [object {6}]

必需

string

对话的 ID。

可选

created_at

string

创建对话的时间戳。

可选

messages

array [object {2}]

可选

包含具有角色和内容属性的消息对象的数组。

chatbot_id

string

可选

与对话关联的聊天机器人的 ID。

customer

string

客户或用户标识符。

可选

source

string

对话的来源。

可选

修改于 2024-03-20 10:01:06

获取线索

删除聊天机器人图标