程序包 cn.siriusbot.siriuspro.bot.api

接口 MessageApi

public interface MessageApi
消息Api

  • 方法详细资料

    • sendMessage

      Tuple<Message,String> sendMessage(String bot_id, String channel_id, String content, String image_Url, String msg_id, String event_id)
      用于向 channel_id 指定的子频道发送消息。 要求机器人在该子频道具有发送消息的权限。 主动消息在频道主或管理设置了情况下，按设置的数量进行限频。在未设置的情况遵循如下限制: 主动推送消息，默认每天往每个子频道可推送的消息数是 20 条，超过会被限制。 主动推送消息在每个频道中，每天可以往 2 个子频道推送消息。超过后会被限制。 不论主动消息还是被动消息，在一个子频道中，每 1s 只能发送 5 条消息。 被动回复消息有效期为 5 分钟。超时会报错。 发送消息接口要求机器人接口需要连接到 websocket 上保持在线状态 有关主动消息审核，可以通过 Intents 中审核事件 MESSAGE_AUDIT 返回 MessageAudited 对象获取结果。 如传入event_id和msg_id其中一个，此条消息视为被动消息
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      content - 要发送的消息内容
      image_Url - 图片Url
      msg_id - 消息ID，
      event_id - 事件ID
      返回:
      消息对象

    • getMessageById

      Tuple<Message,String> getMessageById(String bot_id, String channel_id, String message_id)
      获取指定子频道的指定消息详情
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      message_id - 消息ID
      返回:
      返回消息对象

    • sendReferenceMessage

      Tuple<Message,String> sendReferenceMessage(String bot_id, String channel_id, String content, MessageReference reference)
      发送引用消息
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      content - 消息内容
      reference - 引用消息对象
      返回:
      返回消息对象

    • sendMarkdownMessage

      Tuple<Message,String> sendMarkdownMessage(String bot_id, String channel_id, String msg_id, String event_id, MessageMarkdown markdown)
      发送markdown消息(富文本) 要求操作人在该子频道具有发送消息和对应 Markdown 模版 的权限。 调用前开发者需要先在“QQ开放平台-机器人-发布设置-消息模板”入口为对应机器人创建申请Markdown消息模板，得到模板 id ，在请求时填在对应的 markdown.template_id 上。 模板参数暂不支持数组。 消息体中所包含的URL需要报备并通过验证，方可使用。 如传入event_id和msg_id其中一个，此条消息视为被动消息
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      msg_id - 消息id
      event_id - 事件ID
      markdown - markdown对象
      返回:
      返回消息对象

    • deleteMessageById

      Boolean deleteMessageById(String bot_id, String channel_id, String message_id, boolean hidetip)
      用于撤回子频道 channel_id 下的消息 message_id。 管理员可以撤回普通成员的消息。 频道主可以撤回所有人的消息。 !!注意!! 公域机器人暂不支持申请，仅私域机器人可用，选择私域机器人后默认开通。 注意: 开通后需要先将机器人从频道移除，然后重新添加，方可生效
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      message_id - 消息ID
      hidetip - 是否隐藏删除消息后的小灰条
      返回:
      撤回结果

    • sendArkMessage

      Tuple<Message,String> sendArkMessage(String bot_id, String channel_id, MessageArk ark, String msg_id, String event_id)
      通过指定 ark 字段发送模板消息。 要求操作人在该子频道具有发送消息和 对应ARK 模板 的权限。 调用前需要先申请消息模板，这一步会得到一个模板 id，在请求时填在 ark.template_id 上。 发送成功之后，会触发一个创建消息的事件。 如传入event_id和msg_id其中一个，此条消息视为被动消息
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      ark - ark消息对象
      msg_id - 消息id
      event_id - 事件ID
      返回:
      消息对象

    • sendEmbedMessage

      Tuple<Message,String> sendEmbedMessage(String bot_id, String channel_id, MessageEmbed embed, String msg_id, String event_id)
      发送embed模板消息 如传入event_id和msg_id其中一个，此条消息视为被动消息
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      embed - embed消息对象
      msg_id - 消息id
      event_id - 事件id
      返回:
      消息对象

    • sendImageAndTextMessage

      Tuple<Message,String> sendImageAndTextMessage(String bot_id, String channel_id, String content, String image_path, String msg_id, String event_id)
      发送图文消息
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      content - 消息内容
      image_path - 本地图片路径
      msg_id - 消息ID
      event_id - 事件ID
      返回:
      消息对象

    • sendCustomInLineKeyword

      Tuple<Message,String> sendCustomInLineKeyword(String bot_id, String channel_id, RequestCustomKeyboard requestCustomKeyboard, String msg_id, String event_id)
      发送自定义按钮模板对象
      参数:
      bot_id - 传入机器人ID
      channel_id - 子频道ID
      requestCustomKeyboard - 自定义按钮请求对象
      返回:
      返回消息对象