获取对话明细

获取指定对话 ID 内的所有消息记录。

请求方式

GET

调用地址

https://api.gptbots.ai/v1/messages

调用验证

详情参见 API 概述的鉴权方式说明。

请求

请求示例

curl -X GET 'https://api.gptbots.ai/v1/messages?conversation_id=xxxxxx&user_id=123456&page=1&page_size=100' \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json'

          curl -X GET 'https://api.gptbots.ai/v1/messages?conversation_id=xxxxxx&user_id=123456&page=1&page_size=100' \ 
  -H 'Authorization: Bearer your_apikey' \ 
  -H 'Content-Type: application/json'

此代码块在浮窗中显示

请求头

字段	类型	描述
Authorization	Bearer ${token}	使用 Authorization: Bearer ${token}进行调用验证，请在 API 密钥页面获取密钥作为 token。
Content-Type	application/json	数据类型，取值为 application/json。

请求体

字段	类型	必填	描述
conversation_id	string	是	对话标识符。
page	int	是	页数，表示你想请求第几页的数据。
page_size	int	是	每页的数据量，表示你希望每页返回多少条数据，最多 100 条。

响应

响应示例

{ "total": 100, "messages": [ { "message_id": "645dd86906931c4a9e0ffb1f", "parent_message_id": "", "message_type": "ANSWER", "text": "你好，我是一个客服机器人，你可以在这里得到问题解答", "create_time": 1683871849906 }, { "message_id": "745dd86906931c4a9e0ffb1f", "parent_message_id": "645dd86906931c4a9e0ffb1f", "message_type": "QUESTION", "text": "极光推送的功能介绍", "create_time": 1683871849906 }, { "message_id": "845dd86906931c4a9e0ffb1f", "parent_message_id": "745dd86906931c4a9e0ffb1f", "message_type": "ANSWER", "text": "极光推送是一个强大的平台。...", "create_time": 1683871849906 } ] }

          {
  "total": 100,
  "messages": [
    {
      "message_id": "645dd86906931c4a9e0ffb1f",
      "parent_message_id": "",
      "message_type": "ANSWER",
      "text": "你好，我是一个客服机器人，你可以在这里得到问题解答",
      "create_time": 1683871849906
    },
    {
      "message_id": "745dd86906931c4a9e0ffb1f",
      "parent_message_id": "645dd86906931c4a9e0ffb1f",
      "message_type": "QUESTION",
      "text": "极光推送的功能介绍",
      "create_time": 1683871849906
    },
    {
      "message_id": "845dd86906931c4a9e0ffb1f",
      "parent_message_id": "745dd86906931c4a9e0ffb1f",
      "message_type": "ANSWER",
      "text": "极光推送是一个强大的平台。...",
      "create_time": 1683871849906
    }
  ]
}

此代码块在浮窗中显示

成功响应

字段	类型	描述
total	string	本对话中的消息总数。
messages	JSON Array	消息详情。
message_id	string	消息的唯一标识。
parent_message_id	string	本消息的父消息的唯一标识。
message_type	string	消息类型，取值：ANSWER、QUESTION。
text	string	消息内容。
create_time	long	这条消息产生的时间戳。

失败响应

字段	类型	描述
code	int	错误码。
message	string	错误详情。

错误码

Code	Message
40000	参数错误
40005	分页参数不能大于实际数量
40127	开发者鉴权失败
40356	会话不存在
20059	Bot 已删除