获取群消息历史 - 齐成云·IM消息服务

获取群组的消息历史记录，支持分页和时间范围查询

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer QC2b8fd0ca342c72f857f5f96

Appid

string

可选

默认值:

1001

ClientId

string

可选

默认值:

131231231223

TimeStamp

string

可选

默认值:

Client-Type

string

可选

默认值:

EnterpriseCenterWEB

Body 参数application/json

receiverId

string

群组ID

必需

>= 1 字符<= 20 字符

示例值:

g_Ab3Xy9Mn4Kp8

page

integer

页码，从1开始

可选

>= 1

示例值:

pageSize

integer

每页数量

可选

>= 1<= 100

示例值:

startTime

string <date-time>

可选

开始时间（ISO 8601格式）

示例值:

2024-01-01T00:00:00Z

endTime

string <date-time>

可选

结束时间（ISO 8601格式）

示例值:

2024-01-31T23:59:59Z

messageTypes

array[string]

消息类型过滤

可选

枚举值:

textimagefilevideovoicelocationcard

示例值:

["text","image"]

lastMessageKey

string

可选

最后一条消息Key（用于加载更多）

>= 1 字符<= 50 字符

示例值:

w4x7y1z5a8b2

示例

{
    "receiverId": "g_Ab3Xy9Mn4Kp8",
    "page": 1,
    "pageSize": 20,
    "startTime": "2024-01-01T00:00:00Z",
    "endTime": "2024-01-31T23:59:59Z",
    "messageTypes": [
        "text",
        "image"
    ],
    "lastMessageKey": "w4x7y1z5a8b2"
}

返回响应

🟢200成功

application/json

获取成功

Body

object {0}

示例

{
    "code": 200,
    "message": "获取消息历史成功",
    "data": {
        "total": 500,
        "messages": [
            {
                "chatsMessageId": 12345,
                "messageKey": "k8m3n9p2q5r7",
                "chatsKey": "group_g_Ab3Xy9Mn4Kp8",
                "sendUserId": "user_123",
                "receiveUserId": "g_Ab3Xy9Mn4Kp8",
                "messageType": "text",
                "messageContent": "大家好，这是一条群消息",
                "createTime": "2024-01-01T12:00:00Z",
                "deliveryStatus": "sent",
                "isRetracted": 0
            },
            {
                "chatsMessageId": 12346,
                "messageKey": "w4x7y1z5a8b2",
                "chatsKey": "group_g_Ab3Xy9Mn4Kp8",
                "sendUserId": "user_456",
                "receiveUserId": "g_Ab3Xy9Mn4Kp8",
                "messageType": "image",
                "messageContent": {
                    "url": "https://example.com/image.jpg"
                },
                "createTime": "2024-01-01T12:01:00Z",
                "deliveryStatus": "sent",
                "isRetracted": 0
            }
        ],
        "hasMore": true
    }
}

🟠403禁止访问

🟠404记录不存在