DingTalk Bot
DingTalk Bot是阿里钉钉自定义机器人的Ruby库
官方文档:阿里钉钉自定义机器人.
安装
从rubygems中安装:
gem install dingbot
添加到Gemfile中:
gem 'dingbot'
用法
初始化客户端:
# 全局配置方式
DingBot.configure do |config|
config.endpoint = 'https://oapi.dingtalk.com/robot/send' # API endpoint URL, default: ENV['DINGTALK_API_ENDPOINT'] or https://oapi.dingtalk.com/robot/send
config.access_token = 'your access token' # access token, default: ENV['DINGTALK_ACCESS_TOKEN']
config.secret = "your sign secret" # sign secret
end
# 局部配置方式
DingBot.endpoint='https://oapi.dingtalk.com/robot/send'
DingBot.access_token = 'your access token'
DingBot.secret = "your sign secret" # sign secret
发送消息
# 快速发送一套只包含文本的Text消息(不需要构造Message对象)
def send_simple_text
DingBot.send_text('我就是我, 是不一样的烟火')
end
# 发送复杂Text消息
def send_text
= DingBot::Message::Text.new(
'我就是我, 是不一样的烟火',
['1371xxxx117'],
false
)
DingBot.send_msg()
end
# 发送Link消息
def send_link
= DingBot::Message::Link.new(
'我就是我, 是不一样的烟火',
'这个即将发布的新版本,创始人陈航(花名“无招”)称它为“红树林”。',
'https://www.dingtalk.com/',
'https://avatars1.githubusercontent.com/u/64818'
)
DingBot.send_msg()
end
# 发送Markdown消息
def send_markdown
DingBot.send_markdown('我就是我, 是不一样的烟火', '### 我就是我, 是不一样的烟火')
end
# 发送整体跳转ActionCard消息
def send_whole_action_card
= DingBot::Message::WholeActionCard.new(
'乔布斯 20 年前想打造一间苹果咖啡厅,而它正是 Apple Store 的前身',
'![screenshot](@lADOpwk3K80C0M0FoA) ### 乔布斯 20 年前想打造的苹果咖啡厅',
'阅读全文',
'https://www.dingtalk.com/'
)
DingBot.send_msg()
end
# 发送独立跳转ActionCard类型消息
def send_independent_action_card
= DingBot::Message::IndependentActionCard.new(
'乔布斯 20 年前想打造一间苹果咖啡厅,而它正是 Apple Store 的前身',
'![screenshot](@lADOpwk3K80C0M0FoA) ### 乔布斯 20 年前想打造的苹果咖啡厅',
[
DingBot::Message::ActionBtn.new('内容不错', 'https://www.dingtalk.com/'),
DingBot::Message::ActionBtn.new('不感兴趣', 'https://www.dingtalk.com/')
]
)
DingBot.send_msg()
end
# 发送FeedCard类型
def send_feed_card
= DingBot::Message::FeedCard.new(
[
DingBot::Message::FeedCardLink.new(
'时代的火车向前开',
'https://avatars1.githubusercontent.com/u/64818',
'https://www.dingtalk.com/'
),
DingBot::Message::FeedCardLink.new(
'时代的火车向前开',
'https://avatars1.githubusercontent.com/u/64818',
'https://www.dingtalk.com/'
)
]
)
DingBot.send_msg()
end
更为详细的用法请见此链接:https://github.com/thierryxing/dingtalk-bot/blob/master/test/dingbot_test.rb
License
Released under the MIT license. See LICENSE.txt for details.