Botpy-Docs

发送消息

向指定子频道推送消息。

注意

  • 要求操作人在该子频道具有发送消息的权限。
  • 主动推送消息，默认每天往每个频道可推送的消息数是 20 条，超过会被限制。
  • 主动推送消息在每个频道中，每天可以往 2 个子频道推送消息，超过后会被限制。
  • 不论主动消息还是被动消息，在一个子频道中，每 1s 只能发送 5 条消息。
  • 被动回复消息有效期为 5 分钟，超时会报错。
  • 发送消息接口要求机器人接口需要链接到 websocket gateway 上保持在线状态。
  • 有关主动消息审核，可以通过 Intents 中审核事件 MESSAGE_AUDIT 返回 MessageAudited 对象获取结果。

使用示例

import botpy
from botpy.message import Message

class MyClient(botpy.Client):
    async def on_at_message_create(self, message: Message):
        await self.api.post_message(channel_id="xxxx", content="xxx", msg_id="xxxx", embed=embed)

intents = botpy.Intents(public_guild_messages=True)
client = MyClient(intents=intents)
client.run(appid={appid}, token={token})

参数说明

参数必填类型说明
channel_id是string子频道 ID
content否string消息内容，文本内容，支持内嵌格式，可以为空
embed否MessageEmbedembed 消息，一种特殊的 ark
ark否MessageArkark 消息
image否string图片 url 地址
msg_id否string要回复的消息 id。带了 msg_id 视为被动回复消息，否则视为主动推送消息
message_referenceMessageReference否引用消息对象

content、embed、ark、image至少需要有一个字段，否则无法下发消息。

被动回复消息

注意

被动消息需是用户@机器人的消息，否则将会报错。

MessageEmbed

详见消息内嵌格式。

MessageArk

详见发送模板消息。

MessageReference

详见发送引用消息。

返回说明

主动消息都需要审核，返回结果如下：

{
  "code": 304023,
  "message": "push message is waiting for audit now"
}

若为私域机器人可正常返回Message 对象。

Message

字段名类型描述
idstring消息 ID
channel_idstring子频道 ID
guild_idstring频道 ID
contentstring消息内容
timestampstring消息创建时间，是个 iISO8601 timestamp 字符串，例："2021-11-23T15:16:48+08:00"
authorUser消息创建者
memberMember消息创建者的 member 信息

User

字段名类型描述
idstring用户 ID
usernamestring用户名
botboolean是否是机器人

Member

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

DefaultRoleIDs

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

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

返回示例

以发送文本内容hello world为例，下面是返回示例：

data:

{
  "id": "101234567890abcdef",
  "channel_id": "10001",
  "guild_id": "6400000001",
  "content": "hello world",
  "timestamp": "2021-05-13T14:45:45+08:00",
  "tts": false,
  "mention_everyone": false,
  "author": {
    "id": "12345",
    "username": "abc",
    "avatar": "",
    "bot": true
  },
  "embeds": [{}],
  "pinned": false,
  "type": 0,
  "flags": 0
}