宜搭+
    正在准备搜索索引...

    类 DingtalkMessagePushingBot抽象

    钉钉消息推送机器人基类。

    本抽象类定义钉钉 Webhook 机器人的通用配置与推送流程。子类仅需重写 post 方法以适配特定消息类型的参数结构，即可完成该类型的消息推送。

    推送流程如下：

    1. 若已设置 关键词校验， 则先检查消息内容是否包含指定关键词；若未包含则跳过推送并输出错误日志。
    2. 通过 fetch 向钉钉机器人接口发送 POST 请求。
    3. 若接口返回 errcode 非零，则抛出包含 errmsg 的错误。
    4. 推送成功或失败时均会输出对应日志。

    26.7.1

    层级 (查看层级一览)

    索引

    构造函数

    constructor

    方法

    post withPrecheckKeyword withTransferDomain of

    构造函数

    方法

    post

    • post(param?: {}): Promise<void>

      执行钉钉机器人消息推送。

      该方法会先将参数对象序列化为 JSON 字符串，执行关键词校验（若已设置）， 然后通过 fetch 向钉钉机器人接口发送 POST 请求，并根据响应结果输出日志。 任何网络异常或接口错误都会被捕获并记录为错误日志，不会向上抛出。

      参数

      • param: {} = {}

        消息内容参数对象，结构需符合钉钉机器人接口要求；默认为空对象。

      返回 Promise<void>

      异步操作完成后返回 undefined。

      26.7.1

    • 设置推送前的关键词校验字符串。

      设置后，只有当待推送消息内容（JSON 序列化后的字符串）包含该关键词时， 才会真正执行推送；否则将跳过推送并记录错误日志。关键词校验可用于避免因 未包含机器人安全设置关键词而导致的接口调用失败。

      参数

      • precheckKeyword: string

        关键词字符串；传空字符串或不调用此方法则表示不校验。

      返回 DingtalkMessagePushingBot

      当前实例，支持链式调用。

      26.7.1

    • 设置钉钉机器人请求的转发域名。

      当业务运行在内网环境或需要通过特定代理转发请求时，可通过此方法指定 转发域名。最终请求 URL 格式为： https://{transferDomain}/https://oapi.dingtalk.com/robot/send?access_token={key}。

      参数

      • transferDomain: string

        转发域名字符串，例如 "to.example.com"。

      返回 DingtalkMessagePushingBot

      当前实例，支持链式调用。

      26.7.1

    • 创建并初始化一个新的钉钉机器人推送服务实例。

      该方法为子类提供统一的工厂入口，返回的实例已保存 access_token。

      类型参数

      参数

      • this: new () => T
      • key: string

        钉钉机器人 Webhook URL 中的 access_token 部分。

      返回 T

      初始化后的机器人实例。

      26.7.1

      const bot = EZPush.Text.of("your_access_token")

    显示设置

    成员可见性

    目录

    构造函数
    方法