拉取消息列表

获取消息列表。

使用示例

  1. import qqbot
  3. token = qqbot.Token({appid}, {token})
  5. msg_api = qqbot.MessageAPI(token, False)
  6. message_list = msg_api.get_messages(channel_id, pager)

参数说明

参数 必填 类型 说明
channel_id 是 string 子频道 ID
pager 否 MessagesPager 分页信息

MessagesPager

参数 必填 类型 说明
type 是 TypesEnum 拉取类型
id 是 string 消息 ID
limit 是 string 每次拉取多少条消息，最大 20

TypesEnum

字段名 类型 描述
around string 读此 id 前后的消息
before string 读此 id 之前的消息
after string 读此 id 之后的消息
latest string 最新limit的消息

如果 around/before/after 均为空，则拉取最新的 limit 条消息。

返回说明

返回 Message 对象数组。

Message

字段名 类型 描述
id string 消息 ID
channel_id string 子频道 ID
guild_id string 频道 ID
content string 消息内容
timestamp string 消息创建时间，是个 iISO8601 timestamp 字符串，例：”2021-11-23T15:16:48+08:00”
author User 消息创建者
member Member 消息创建者的 member 信息

User

字段名 类型 描述
id string 用户 ID
username string 用户名
bot boolean 是否是机器人

Member

字段名 类型 描述
roles string[] 用户在频道内的身份组 ID，默认值可参考DefaultRoleIDs
joined_at string 用户加入频道的时间，是个 ISO8601 timestamp 字符串，例：”2021-11-23T15:16:48+08:00”

DefaultRoleIDs

系统默认生成下列身份组 ID。

身份组 ID 默认值 描述
1 全体成员
2 管理员
4 群主/创建者
5 子频道管理员

返回示例

data：

  1. [
  2.   {
  3.     "id": "xxx",
  4.     "channel_id": "100001",
  5.     "guild_id": "100000000001",
  6.     "content": "hello",
  7.     "timestamp": "2021-05-25T15:20:34+08:00",
  8.     "author": {
  9.       "id": "1000000001",
  10.       "username": "az",
  11.       "bot": false
  12.     },
  13.     "member": {
  14.       "roles": [
  15.         "1"
  16.       ],
  17.       "joined_at": "2021-04-12T16:34:42+08:00"
  18.     }
  19.   },
  20.   {
  21.     "id": "yyy",
  22.     "channel_id": "100001",
  23.     "guild_id": "1000000000001",
  24.     "content": "world",
  25.     "timestamp": "2021-05-25T15:20:32+08:00",
  26.     "author": {
  27.       "id": "10000001",
  28.       "username": "az",
  29.       "bot": false
  30.     },
  31.     "member": {
  32.       "roles": [
  33.         "1"
  34.       ],
  35.       "joined_at": "2021-04-12T16:34:42+08:00"
  36.     }
  37.   }
  38. ]