分页查询历史消息
GET
/im/v2/conversations/{conversation_id}/messages请求参数
Path 参数
conversation_id
string
必需
会话 ID。会话 ID 需要用户自行拼装,拼装规则:
sender_id|conversation_type|receiver_id
sender_id:会话消息发送者的账号 ID,String 类型
conversation_type:会话类型,1:单聊会话;2:高级群会话;3:超大群会话
receiver_id:接收会话消息的账号 ID 或群组 ID
单聊会话时为消息接收者的账号 ID;高级群会话时为接收消息的高级群 ID;超大群会话时为超大群 ID。
示例值:
apifoxtest35|1|apifoxtest40
Query 参数
begin_time
integer
可选
查询开始时间(毫秒)。
示例值:
0
end_time
integer
可选
查询截止时间(毫秒)。
示例值:
{% mock 'timestamp' %}
page_token
string
可选
分页标识符,如果为空,则从第一页开始查询。
limit
integer
可选
每页返回的消息数上限,最大为 100。小于等于 0,或者大于 100,会报 414 错误。
示例值:
100
descending
boolean
可选
是否按时间正序,true:按时间正序;false:按时间倒序。
message_type
string
可选
例如"0,1,2,3",其中支持的消息类型如下:0:文本;1:图片;2:语音;3:视频;4:地理位置;5:通知;6:文件;10:提示;11:Robot;100:自定义。
check_team_valid
boolean
可选
只检查高级群是否存在,不检查查询账号是否为群成员。
该参数仅对高级群消息生效,对超大群无效。
include_no_sense_msg
boolean
可选
查询结果中是否需要包含无感知消息,默认为 false(不包含)。
无感知消息具体包括:
发送消息时,被设置为发送方无感知的消息(即 msgSenderNoSense = 0)。
发消息时,被设置为接收方无感知的消息(即 msgReceiverNoSense = 1)。
被单向撤回的消息。
被单向删除的消息。
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer
必需
msg
string
必需
data
object
必需
返回的 JSON 数据对象,请求失败则返回空对象。
has_more
boolean
必需
是否还有更多数据。
items
array [object {9}]
返回的历史消息。
示例
{
"code": 200,
"msg": "success",
"data": {
"has_more": false,
"items": []
}
}
最后修改时间: 8 个月前