feishu-message

利用飞书自定义机器人发送消息，详情参考飞书文档。

参数

sign_secret: String，飞书自定义机器人签名密钥。若机器人未开启签名，可忽略此参数。
msg_type: String，消息类型，可选值有 text、post、interactive，默认为 text。
content: String | Object，消息内容。 msg_type 为 text、post 时，必填。内容格式参考下文格式说明。
card: Object，卡片消息内容。msg_type 为 interactive 时，必填。内容格式参考下文格式说明。
filepath: String，消息内容文件路径。当存在该值时，会从文件读取内容，覆盖 content 和 card 参数。内容格式参考下文格式说明。
base64_decode_tag: String，Base64 解码识别后缀。默认为 _cnb_base64_decode。当 JSON 字段中的 key 以此后缀结尾且值为 true 时，会对对应的原字段进行 Base64 解码。

消息内容格式说明

content

当 msg_type 为 text 时，消息内容格式为：


{
  "text": "新更新提醒"
}

若解析失败，会将内容原样发送。即会自动组装成如下格式：


{
  "text": "$content"
}

当 msg_type 为 post 时，消息内容格式为：


{
  "post": {
    "zh_cn": {
      "title": "项目更新通知",
      "content": [
        [
          {
            "tag": "text",
            "text": "项目有更新: "
          },
          {
            "tag": "a",
            "text": "请查看",
            "href": "http://www.example.com/"
          },
          {
            "tag": "at",
            "user_id": "ou_18eac8********17ad4f02e8bbbb"
          }
        ]
      ]
    }
  }
}

card

卡片消息内容格式为：


{
  "elements": [
    {
      "tag": "div",
      "text": {
        "content": "**西湖**，位于浙江省杭州市西湖区龙井路1号，杭州市区西部，景区总面积49平方千米，汇水面积为21.22平方千米，湖面面积为6.38平方千米。",
        "tag": "lark_md"
      }
    },
    {
      "actions": [
        {
          "tag": "button",
          "text": {
            "content": "更多景点介绍 :玫瑰:",
            "tag": "lark_md"
          },
          "url": "https://www.example.com",
          "type": "default",
          "value": {}
        }
      ],
      "tag": "action"
    }
  ],
  "header": {
    "title": {
      "content": "今日旅游推荐",
      "tag": "plain_text"
    }
  }
}

filepath

filepath 对应文件内容格式为：


{
  "content": {
    "post": {
      "zh_cn": {
        "title": "项目更新通知",
        "content": [
          [
            {
              "tag": "text",
              "text": "项目没有更新: "
            },
            {
              "tag": "a",
              "text": "请查看",
              "href": "http://www.example.com/"
            }
          ],
          [
            {
              "tag": "text",
              "text": "项目没有更新: "
            },
            {
              "tag": "a",
              "text": "请查看",
              "href": "http://www.example.com/"
            }
          ]
        ]
      }
    }
  },
  "card": {
    "elements": [
      {
        "tag": "div",
        "text": {
          "content": "**东湖**，位于浙江省杭州市西湖区龙井路1号，杭州市区西部，景区总面积49平方千米，汇水面积为21.22平方千米，湖面面积为6.38平方千米。",
          "tag": "lark_md"
        }
      },
      {
        "actions": [
          {
            "tag": "button",
            "text": {
              "content": "更多景点介绍 :玫瑰:",
              "tag": "lark_md"
            },
            "url": "https://www.example.com",
            "type": "default",
            "value": {}
          }
        ],
        "tag": "action"
      }
    ],
    "header": {
      "title": {
        "content": "今日旅游推荐",
        "tag": "plain_text"
      }
    }
  }
}

按 msg_type，存在 content 和 card 其中一种内容即可。

Base64 内容解码

为解决 JSON/YAML 中包含复杂字符（如换行符、引号）导致格式错误的问题，插件支持对字段值进行 Base64 解码。该功能支持 递归处理（支持嵌套对象）。这通常在环境变量直接赋值到字段时才会需要的功能，也就是说你无法在 CNB 构建过程中对环境变量直接操作时适用的方式。

使用方法：

将目标字段的值转换为 Base64 字符串。
在同一层级增加一个辅助字段，键名为 目标字段名 + 后缀（默认后缀为 _cnb_base64_decode）。
将辅助字段的值设为 true。
插件会自动解码目标字段，并移除辅助字段。

示例： 假设需要发送的内容包含换行符，原始 JSON 如下：


{
  "content": "5Zi/5L2g5aW977yBCui/meaYr+S4gOS4quebuOWvueWkjeadguS4lOWFt+acieaNouihjOespu+8jOWIhumalOespuetieWQhOenjeeJueauiuespuWPt+eahOWGheWuuQpAICYgKiogXHQgXG4=",
  "content_cnb_base64_decode": true
}

插件会自动将 content 解码，并移除 content_cnb_base64_decode 字段。

云原生构建示例

可将 robot 地址和签名密钥配置在私有仓库中，然后通过 imports 导入环境变量中。


# env.yml
ROBOT: https://open.feishu.cn/open-apis/bot/v2/hook/xx
SIGN_SECRET: xxx

文本消息


main:
  pull_request:
    - imports: https://xxx/env.yml
      stages:
        - name: send simple message
          image: tencentcom/feishu-message
          settings:
            robot: $ROBOT
            content: 新更新提醒
        - name: send  message
          image: tencentcom/feishu-message
          settings:
            robot: $ROBOT
            content: |
              {
                  "text": "新更新提醒"
              }

富文本消息


main:
  pull_request:
    - imports: https://xxx/env.yml
      stages:
        - name: send message
          image: tencentcom/feishu-message
          settings:
            robot: $ROBOT
            msg_type: post
            content: |
              {
                  "post": {
                      "zh_cn": {
                          "title": "项目更新通知",
                          "content": [
                              [{
                                  "tag": "text",
                                  "text": "项目有更新: "
                              }, {
                                  "tag": "a",
                                  "text": "请查看",
                                  "href": "http://www.example.com/"
                              }, {
                                  "tag": "at",
                                  "user_id": "ou_18eac8********17ad4f02e8bbbb"
                              }]
                          ]
                      }
                  }
              }

卡片消息


main:
  pull_request:
    - imports: https://xxx/env.yml
      stages:
        - name: send message
          image: tencentcom/feishu-message
          settings:
            robot: $ROBOT
            msg_type: interactive
            card: |
              {
                  "elements": [
                      {
                          "tag": "div",
                          "text": {
                              "content": "**西湖**，位于浙江省杭州市西湖区龙井路1号，杭州市区西部，景区总面积49平方千米，汇水面积为21.22平方千米，湖面面积为6.38平方千米。",
                              "tag": "lark_md"
                          }
                      },
                      {
                          "actions": [
                              {
                                  "tag": "button",
                                  "text": {
                                      "content": "更多景点介绍 :玫瑰:",
                                      "tag": "lark_md"
                                  },
                                  "url": "https://www.example.com",
                                  "type": "default",
                                  "value": {}
                              }
                          ],
                          "tag": "action"
                      }
                  ],
                  "header": {
                      "title": {
                          "content": "今日旅游推荐",
                          "tag": "plain_text"
                      }
                  }
              }