Skip to content

[对话]获取消息列表

  • 接口地址:/api/v2/conversation/{conversationId}/messages
  • 请求方式:GET
  • 传参方式:Rest + Query

Headers 可选参数

参数名公开模式(是否必传)私有模式(是否必传)
X-Fresns-AidYESYES
X-Fresns-Aid-TokenYESYES
X-Fresns-UidYESYES
X-Fresns-Aid-TokenYESYES

Rest 参数

参数名类型是否必传说明
conversationIdNumberYES对话 ID

Query 参数

参数名类型是否必传说明
orderDirectionStringNO排序方向,默认 desc
asc,desc
pageListDirectionStringNO每页列表里数组排序方向,默认 latest
latest,oldest
whitelistKeysStringNO白名单键名,只返回给定键名的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
仅对 user 参数有效
blacklistKeysStringNO黑名单键名,从返回数据中删除指定的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
仅对 user 参数有效
pageSizeNumberNO每页显示条数(默认 15 条)
pageNumberNO页码(默认 1)

返回结果

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / 一共有多少条数据",
            "pageSize": "Number / 每页有多少条数据",
            "currentPage": "Number / 当前页码",
            "lastPage": "Number / 最后一页页码"
        },
        "list": [
            {
                "id": "Number / 消息 ID",
                "user": {
                    // 发信用户信息,为空表示用户已注销
                    // 通用数据结构->用户信息
                },
                "isMe": "Boolean / 是否为自己发的",
                "type": "Number / 1.文本消息 2.文件消息",
                "content": "String / 消息内容",
                "file": {
                    // 文件消息专用
                    // 通用数据结构->文件信息
                },
                "datetime": "String / 发送时间",
                "datetimeFormat": "String / 格式化的发送时间",
                "timeAgo": "String / 人性化发送时间",
                "readStatus": "Boolean / 阅读状态"
            }
        ]
    }
}

Released under the Apache-2.0 License