npm 包 ding-res-msg 使用教程-JavaScript中文网-JavaScript教程资源分享门户

概述

npm 是全球最大的软件注册中心，其中有数百万个包可以供开发人员方便地使用。ding-res-msg 是其中一个用于钉钉应用的 npm 包，可以在钉钉应用中使用，使消息推送更加高效和稳定。本文将介绍该 npm 包的使用教程，以及指导如何从中学到有益的技能。

安装

首先，在 npm 中安装 ding-res-msg，使用以下命令：

npm install ding-res-msg

然后，在代码中引用库：

const dingResMsg = require('ding-res-msg');

API 详解

dingResMsg

create(config: DingResMsgConfig) => string

使用传入的参数配置生成钉钉消息 JSON 格式

参数：

参数名	类型	必填	说明
config	`object`	`是`	钉钉消息配置对象
config.appKey	`string`	`是`	钉钉应用 appKey
config.appSecret	`string`	`是`	钉钉应用 appSecret
config.msgType	`string`	`是`	钉钉消息类型（text或link或markdown或actionCard或feedCard）
config.msgContent	`MsgContent`	`是`	钉钉消息内容
config.accessToken	`string`	`否`	钉钉 access_token
config.agentId	`string`	`否`	应用 id，当应用类型为企业内部自主开发型时才需要
config.corpId	`string`	`否`	钉钉 corpId，当应用为企业内部自主开发型时才需要

MsgContent

钉钉消息内容对象。根据 msgType 类型选择以下参数给 config.msgContent 赋值：

text

content: string

link

description: string
picUrl: string
text: string
title: string
url: string

markdown

text: string
title: string

actionCard

actionUrl: string
btnOrientation: '0' | '1'
btns: [ActionCardBtn]
markdown: string
singleTitle: string
singleUrl: string

feedCard

links: [FeedCardBody[]]

ActionCardBtn

钉钉工作通知按钮对象型。

参数名	类型	必填	说明
title	`string`	`是`	按钮名称
actionURL	`string`	`是`	点击按钮触发的连接

FeedCardBody

钉钉 FeedCard －单条信息颜色对象型。

参数名	类型	必填	说明
title	`string`	`是`	单条信息文本
messageURL	`string`	`是`	点击单条信息后跳转的链接
picURL	`string`	`是`	单条信息后面图片

示例

接下来，我们来创建一段钉钉文本消息：

-- -------------------- ---- -------
----- ---------- - ------------------------

----- ------ - -
  ------- ----- --- ----- 
  ---------- ----- --- -------- 
  -------- ------- 
  ----------- -
    ----- -
      -------- --------------
    -
  --
  ------------ ----- ------ ------
--

----- ------- - --------------------------

钉钉 markdown 消息：

-- -------------------- ---- -------
----- ---------- - ------------------------

----- ------ - -
  ------- ----- --- ----- 
  ---------- ----- --- -------- 
  -------- ----------- 
  ----------- -
    --------- -
      ------ ---------
      ----- -- --------- -
        ------ --------------- -
        -  - --------- -
        -  - ---------
    -
  --
  -------- ----- ----- ----
  ------- ----- ---- ---
--

----- ----------- - --------------------------

这是一个使用 ding-res-msg 发送消息到钉钉 api 的最简单的示例，本文还可以在该 api 上继续开发其它类型的推送。机器人文档提供了许多配置参数，本文是基于它们的指南学习如何使用技术和接口。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6005664081e8991b448e24a7