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

    动作卡片消息推送服务。

    用于向钉钉群组发送包含交互按钮的动作卡片消息,支持单按钮与多按钮两种形态。 单按钮形态通过 singleTitlesingleURL 指定;多按钮形态通过 btns 数组指定多个按钮,并可设置按钮排列方向。

    26.7.1

    // 单按钮
    EZPush.ActionCard.of("your_access_token").post({
    title: "审批通知",
    text: "您有一个新的审批请求需要处理。",
    singleTitle: "查看详情",
    singleURL: "https://example.com/approval/123",
    })

    // 多按钮
    EZPush.ActionCard.of("your_access_token").post({
    title: "会议邀请",
    text: "您被邀请参加一个会议,请选择您的回复。",
    btns: [
    { title: "接受", actionURL: "https://example.com/meeting/accept" },
    { title: "拒绝", actionURL: "https://example.com/meeting/reject" },
    ],
    btnOrientation: "1",
    })

    层级 (查看层级一览)

    索引

    构造函数

    方法

    post

    • post(
          data:
              | {
                  singleTitle: string;
                  singleURL: string;
                  text: string;
                  title: string;
              }
              | {
                  btnOrientation?: "0"
                  | "1";
                  btns: { actionURL: string; title: string }[];
                  text: string;
                  title: string;
              },
      ): Promise<void>

      发送一条动作卡片消息。

      参数

      • data:
            | {
                singleTitle: string;
                singleURL: string;
                text: string;
                title: string;
            }
            | {
                btnOrientation?: "0"
                | "1";
                btns: { actionURL: string; title: string }[];
                text: string;
                title: string;
            }

        动作卡片消息数据,可为单按钮或多按钮形态。

      返回 Promise<void>

      父类的 post 方法返回的异步结果。

      26.7.1

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

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

      参数

      • precheckKeyword: string

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

      返回 ActionCard

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

      26.7.1

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

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

      参数

      • transferDomain: string

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

      返回 ActionCard

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

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