跳转到主要内容
GET
/
conversations
获取会话列表
curl --request GET \
  --url https://{api_base_url}/conversations \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{api_base_url}/conversations"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/conversations', 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_base_url}/conversations",
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_base_url}/conversations"

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_base_url}/conversations")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/conversations")

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
{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "45701982-8118-4bc5-8e9b-64562b4555f2",
      "name": "iPhone Specs Chat",
      "inputs": {
        "city": "San Francisco"
      },
      "status": "normal",
      "introduction": "Welcome! How can I help you today?",
      "created_at": 1705407629,
      "updated_at": 1705411229
    }
  ]
}
{
"status": 400,
"code": "not_chat_app",
"message": "Please check if your app mode matches the right API route."
}
{
"status": 404,
"code": "not_found",
"message": "Last Conversation Not Exists."
}

授权

Authorization
string
header
必填

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401unauthorized)。

查询参数

user
string

终端用户标识,由你的应用定义,需在应用内唯一。参见 终端用户身份

last_id
string

分页游标:当前页最后一个会话的 id。省略则获取第一页。

limit
integer
默认值:20

返回的记录数。

必填范围: 1 <= x <= 100
sort_by
enum<string>
默认值:-updated_at

排序字段。加 - 前缀表示降序。

可用选项:
created_at,
-created_at,
updated_at,
-updated_at

响应

成功获取会话列表。

limit
integer

每页条目数。

has_more
boolean

是否有更多会话。

data
object[]

会话列表。