接口说明
查看指定会话的消息列表。
基础信息
| 请求方式 | 请求地址 |
| GET | https://api.helpbots.ai/api/chats/message-list |
请求参数
Header
| 参数名 |
取值
|
说明 |
|---|---|---|
| x-api-key | $apikey |
用于验证客户端身份的访问令牌。你可以在后台生成访问令牌,详细信息,参考获取api key |
Query params
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | int | 是 |
发送消息对应的智能体ID |
| conversation_id | string | 是 |
此消息所在的会话ID |
| page | int | 否 |
分页查询时的页码 默认为1 |
| pagesize | int | 否 |
分页大小 默认为20 |
返回参数
List
| 参数名 | 类型 | 说明 |
|---|---|---|
| message_id | string |
查询会话ID下的消息ID |
| question | string |
用户提问的问题内容 |
| answer | string | ai智能体回答内容 |
|
aborted_answer
|
string | 停止回答时的内容 |
| source | string |
消息来源信息 |
| add_time | string |
消息创建时间 |
Source
| 参数名 | 类型 | 说明 |
|---|---|---|
| resource_id | int |
资源ID |
| resource_type | int |
资源类型 |
| content_id | int | 文章ID |
| title | string |
资源文章的标题 |
| content | string |
资源文章的内容 |
| score | double |
回答的关联评分 |
|
resource_url
|
string |
来源文章地址 |
示例
请求示例
curl --location --request GET 'https://api.helpbots.ai/api/chats/message-list?id=18&conversation_id=yourconversationid' \
--header 'x-api-key: yourapikey' \
响应示例
{
"data": {
"list": [
{
"message_id": "hzyyu125qzvttwmkrggh************", #消息ID
"question": "今天天气怎么样", #提问内容
"answer": "对不起,我已经学习的知识中不包含问题相关内容,暂时无法提供答案。", #回答内容
"aborted_answer":"对不起,我已经学习的知识中", #停止回答时内容
"source":"[{\"resource_id\":32,\"resource_type\":1,\"content_id\":183*,\"title\":\"\",\"content\":\"\",\"score\":,\"resource_url\":\"\"}]", #来源信息
"add_time": "1745481752" #发送消息时间
}
],
"total": 1,
"page": 1,
"page_size": 20
},
"msg": "Success",
"code": 200
}