Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leitingting08/ding-bot-sdk
Dingbot customize node sdk
https://github.com/leitingting08/ding-bot-sdk
dingding-bot node
Last synced: 8 days ago
JSON representation
Dingbot customize node sdk
- Host: GitHub
- URL: https://github.com/leitingting08/ding-bot-sdk
- Owner: leitingting08
- Created: 2021-01-17T01:33:38.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-22T02:07:43.000Z (about 3 years ago)
- Last Synced: 2024-12-15T04:38:09.459Z (19 days ago)
- Topics: dingding-bot, node
- Language: TypeScript
- Homepage:
- Size: 191 KB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 钉钉自定义机器人的封装
[官方文档](https://ding-doc.dingtalk.com/document/app/custom-robot-access)
## 安装
```
npm install ding-bot-sdk
# or
yarn add ding-bot-sdk
```
## 初始化
```
import Bot from 'ding-bot-sdk'
# or
const Bot = require('ding-bot-sdk')
// Webhook地址: https://oapi.dingtalk.com/robot/send?access_token=xxx
const bot = new Bot({
base_url: 'https://oapi.dingtalk.com/robot/send', // 可选 不填默认 https://oapi.dingtalk.com/robot/send
access_token: 'xxx', // Webhook地址后的access_token // 必填
secret: 'xxx' // 安全设置：加签的secret 必填
})
```
## 发送消息
[格式和钉钉机器人开发文档保持一致](https://ding-doc.dingtalk.com/document/app/custom-robot-access)
text类型，返回回调内容
```js
bot.send({
"msgtype": "text",
"text": {
"content": "我就是我, @150XXXXXXXX 是不一样的烟火"
},
"at": {
"atMobiles": [
"150XXXXXXXX"
],
"isAtAll": false
}
}).then(res=>{
console.log('res',res)
}).catch(error=>{
console.log('error',error)
})
```
link类型
```js
bot.send({
"msgtype": "link",
"link": {
"text": "这个即将发布的新版本，创始人xx称它为红树林。而在此之前，每当面临重大升级，产品经理们都会取一个应景的代号，这一次，为什么是红树林",
"title": "时代的火车向前开",
"picUrl": "",
"messageUrl": "https://www.dingtalk.com/s?__biz=MzA4NjMwMTA2Ng==&mid=2650316842&idx=1&sn=60da3ea2b29f1dcc43a7c8e4a7c97a16&scene=2&srcid=09189AnRJEdIiWVaKltFzNTw&from=timeline&isappinstalled=0&key=&ascene=2&uin=&devicetype=android-23&version=26031933&nettype=WIFI"
}
})
```
markdown类型
```js
bot.send({
"msgtype": "markdown",
"markdown": {
"title":"杭州天气",
"text": "#### 杭州天气 @150XXXXXXXX \n> 9度，西北风1级，空气良89，相对温度73%\n> \n> ###### 10点20分发布 [天气](https://www.dingtalk.com) \n"
},
"at": {
"atMobiles": [
"150XXXXXXXX"
],
"isAtAll": false
}
})
```
整体跳转ActionCard类型
```js
bot.send({
"actionCard": {
"title": "乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身",
"text": "
### 乔布斯 20 年前想打造的苹果咖啡厅
Apple Store 的设计正从原来满满的科技感走向生活化，而其生活化的走向其实可以追溯到 20 年前苹果一个建立咖啡馆的计划",
"btnOrientation": "0",
"singleTitle" : "阅读全文",
"singleURL" : "https://www.dingtalk.com/"
},
"msgtype": "actionCard"
})
```
独立跳转ActionCard类型
```js
bot.send({
"msgtype": "actionCard",
"actionCard": {
"title": "我 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身",
"text": " \n\n #### 乔布斯 20 年前想打造的苹果咖啡厅 \n\n Apple Store 的设计正从原来满满的科技感走向生活化，而其生活化的走向其实可以追溯到 20 年前苹果一个建立咖啡馆的计划",
"hideAvatar": "0",
"btnOrientation": "0",
"btns": [
{
"title": "内容不错",
"actionURL": "https://www.dingtalk.com/"
},
{
"title": "不感兴趣",
"actionURL": "https://www.dingtalk.com/"
}
]
}
})
```
FeedCard类型
```js
bot.send({
"msgtype": "feedCard",
"feedCard": {
"links": [
{
"title": "时代的火车向前开1",
"messageURL": "https://www.dingtalk.com/",
"picURL": "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png"
},
{
"title": "时代的火车向前开2",
"messageURL": "https://www.dingtalk.com/",
"picURL": "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png"
}
]
}
})
```
## 常见问题
当出现以下错误时，表示消息校验未通过，请查看机器人的安全设置。
```json
// 消息内容中不包含任何关键词
{
"errcode":310000,
"errmsg":"keywords not in content"
}
// timestamp 无效
{
"errcode":310000,
"errmsg":"invalid timestamp"
}
// 签名不匹配
{
"errcode":310000,
"errmsg":"sign not match"
}
// IP地址不在白名单
{
"errcode":310000,
"errmsg":"ip X.X.X.X not in whitelist"
}
```