Botpy-Docs

发送模板消息

注意

  • 要求操作人在该子频道具有发送消息和 模板消息 的权限。
  • 调用前需要先申请消息模板，这一步会得到一个模板 id，在请求时填在 ark.template_id 上
  • 发送成功之后，会触发一个创建消息的事件。
  • 可用模板参考可用模板
  • 如果发送的消息中包含链接（网页、图片、视频链接等），需要提前在机器人管理端open in new window报备，操作流程：操作路径为：“开发设置” -> “消息 URL 配置”

使用示例

需要关注ark字段的使用。

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})

参数说明

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

Embed

字段名类型描述
titlestring标题
descriptionstring描述
promptstring消息弹窗内容
timestampstring消息创建时间
fieldsEmbedField[]消息创建时间，是个 ISO8601 timestamp 字符串，例："2021-11-23T15:16:48+08:00"

EmbedField

字段名类型描述
namestring字段名
valuestring字段值

Ark

字段名类型描述
template_idnumberark 模板 id（需要先申请）
kvAkrKv[]kv 值列表

ArkKv

字段名类型描述
keystringkey
valuestringvalue
objArkObj[]ark obj 类型的列表

ArkObj

字段名类型描述
obj_kvArkObjKv[]ark objkv 列表

ArkObjKv

字段名类型描述
keystringkey
valuestringvalue

参数示例

假设模板如下，其中#META_LIST#类型为数组、#META_URL#类型为 URL、其他为文本。

{
  "app": "com.tencent.miniapp",
  "view": "detail",
  "ver": "0.0.0.1",
  "desc": "#DESC#",
  "prompt": "[QQ小程序]#PROMPT#",
  "meta": {
    "detail": {
      "title": "#TITLE#",
      "desc": "#META_DESC#",
      "url": "#META_URL#",
      "list": "#META_LIST#"
    }
  }
}

请求体中的 ark 内容为

{
  "ark": {
    "template_id": 1,
    "kv": [
      {
        "key": "#DESC#",
        "value": "机器人订阅消息"
      },
      {
        "key": "#PROMPT#",
        "value": "XX机器人"
      },
      {
        "key": "#TITLE#",
        "value": "XX机器人消息"
      },
      {
        "key": "#META_URL#",
        "value": "http://domain.com/"
      },
      {
        "key": "#META_LIST#",
        "obj": [
          {
            "obj_kv": [
              {
                "key": "name",
                "value": "aaa"
              },
              {
                "key": "age",
                "value": "3"
              }
            ]
          },
          {
            "obj_kv": [
              {
                "key": "name",
                "value": "bbb"
              },
              {
                "key": "age",
                "value": "4"
              }
            ]
          }
        ]
      }
    ]
  }
}

则实际下发的 json 为

{
  "app": "com.tencent.miniapp",
  "view": "detail",
  "ver": "0.0.0.1",
  "desc": "机器人订阅消息",
  "prompt": "[QQ小程序]XX机器人",
  "meta": {
    "detail": {
      "title": "XX机器人消息",
      "url": "http://domain.com/",
      "list": [
        { "name": "aaa", "age": "3" },
        { "name": "bbb", "age": "4" }
      ]
    }
  }
}

返回说明

返回Message 对象。

Message

字段名类型描述
idstring消息 id
channel_idstring子频道 ID
guild_idstring频道 ID
contentstring消息内容
timestampstring消息创建时间，是个 iISO8601 timestamp 字符串，例："2021-11-23T15:16:48+08:00"
edited_timestampstring消息编辑时间，是个 iISO8601 timestamp 字符串，例："2021-11-23T15:16:48+08:00"
mention_everyoneboolean是否是@全员消息
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子频道管理员

返回示例

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