发送消息 v1.0.0

向指定子频道推送消息。

注意

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

使用示例

async function demo() {
  let { data } = await client.messageApi.postMessage(channelID, message);
}

参数说明

参数	必填	类型	说明
channelID	是	string	子频道 ID
messsage	是	MessageToCreate	消息体结构

MessageToCreate

字段名	类型	必填		描述
content	string	否	消息内容，文本内容，支持内嵌格式
embed	MessageEmbed	否	embed 消息，一种特殊的 ark
ark	MessageArk	否	ark 消息
message_reference	MessageReference	否	引用消息
image	string	否	图片 url 地址
msg_id	string	否	要回复的消息 id。带了 msg_id 视为被动回复消息，否则视为主动推送消息

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

主动消息与被动消息

• 主动消息：发送消息时，未填充 msg_id 字段的消息。
• 被动消息：发送消息时，填充了 msg_id 字段的消息。接口使用此 msg_id 拉取用户的消息，同时判断用户消息的发送时间，如果超过被动消息回复时效，将会不允许发送该消息。

MessageEmbed

详见消息模板。

MessageArk

详见发送模板消息。

MessageReference

详见发送引用消息。

返回说明

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

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

若为私域机器人可正常返回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	子频道管理员

返回示例

以发送文本内容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
}