发送含有消息按钮组件的消息

效果

接口

POST /channels/{channel_id}/messages

功能描述

通过指定 keyboard 字段发送带按钮的消息，支持 keyboard 模版 和 自定义 keyboard 两种请求格式。

• 要求操作人在该子频道具有发送消息和 对应消息按钮组件 的权限。
• 请求参数 keyboard 模版 和 自定义 keyboard 只能单一传值。
• keyboard 模版
  • 调用前需要先申请消息按钮组件模板，这一步会得到一个模板 id，在请求时填在 keyboard 字段上。
  • 申请消息按钮组件模板需要提供响应的 json，具体格式参考 InlineKeyboard。
• 仅 markdown 消息支持消息按钮。

Content-Type

application/json

参数

字段名	类型	描述
keyboard	MessageKeyboard	keyboard 消息

返回

Message 对象

具体错误

错误码

示例

Keyboard 模板请求

{
  "markdown": {
    "template_id": 1,
    "params": [{
        "key": "title",
        "value": ["标题"]
      }
    ]
  },
  "msg_id": "xxxxxx",
  "keyboard": {
    "id": "123"
  }
}

自定义 Keyboard 请求

{
  "markdown": {
    "template_id": 1,
    "params": [{
        "key": "title",
        "value": ["标题"]
      }
    ]
  },
  "msg_id": "xxxxxx",
  "keyboard": {
    "content": {
      "rows": [{
        "buttons": [{
          "id": "1",
          "render_data": {
            "label": "AtBot-按钮1",
            "visited_label": "点击后按钮1上文字"
          },
          "action": {
            "type": 2,
            "permission": {
              "type": 2,
              "specify_role_ids": ["1", "2", "3"]
            },
            "click_limit": 10,
            "unsupport_tips": "编辑-兼容文本",
            "data": "/搜索",
            "at_bot_show_channel_list": true
          }
        }]
      }],
      "bot_appid": 123123123
    }
  }
}

响应数据包

{
    "id": "101234567890abcdef",
    "channel_id": "10001",
    "guild_id": "6400000001",
    "content": "",
    "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
}