获取会话历史消息

获取会话（包括单聊、群组）的历史消息（聊天记录）。
接口级别权限默认只能获取单聊（p2p）消息，如果需要获取群组（group）消息，应用还必须拥有 获取群组中所有消息 权限

获取消息时，机器人必须在群组中

错误码

HTTP状态码	错误码	描述	排查建议
400	230001	Your request contains an invalid request parameter.	参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
400	230002	The bot can not be outside the group.	机器人不在对应群组中。
400	230006	Bot ability is not activated.	机器人能力未启用。在开发者后台-应用功能-机器人页面开启机器人功能并发布上线。
400	230027	Lack of necessary permissions.	请根据本文档中的权限要求部分补充所需权限。

其他未列出的错误码请参见服务端通用错误码

{ "code": 0, "msg": "success", "data": { "has_more": false, "page_token": "GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ==", "items": [ { "message_id": "om_dc13264520392913993dd051dba21dcf", "root_id": "om_40eb06e7b84dc71c03e009ad3c754195", "parent_id": "om_d4be107c616aed9c1da8ed8068570a9f", "msg_type": "card", "create_time": "1615380573411", "update_time": "1615380573411", "deleted": false, "updated": false, "chat_id": "oc_5ad11d72b830411d72b836c20", "sender": { "id": "cli_9f427eec54ae901b", "id_type": "app_id", "sender_type": "app", "tenant_key": "736588c9260f175e" }, "body": { "content": "text:测试消息" }, "mentions": [ { "key": "@_user_1", "id": "ou_155184d1e73cbfb8973e5a9e698e74f2", "id_type": "open_id", "name": "Tom", "tenant_key": "736588c9260f175e" } ], "upper_message_id": "om_40eb06e7b84dc71c03e009ad3c754195" } ] } }

请求参数

Query 参数

container_id_type

string

必需

容器类型，目前可选值仅有"chat"，包含单聊（p2p）和群聊（group）示例值："chat"

container_id

string

必需

容器的id，即chat的id，详情参见群ID 说明示例值："oc_234jsi43d3ssi993d43545f"

start_time

string

可选

历史信息的起始时间（秒级时间戳）示例值："1609296809"

end_time

string

可选

历史信息的结束时间（秒级时间戳）示例值："1608594809"

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值："GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ=="

page_size

string

可选

分页大小示例值：20 默认值：20 数据校验规则：最大值：50

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

has_more

boolean

是否还有更多项

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

items

array [object {13}]

必需

获取会话历史消息

错误码#

请求参数

返回响应

错误码