釘釘機器人訊息Python封裝(開源)

devinzhang發表於2018-01-23
機器人Python封裝

一、釘釘自定義機器人介紹

釘釘機器人是釘釘群的一個高階擴充套件功能，但使用起來卻非常簡單，只需要註冊一個釘釘賬號，就可以將第三方服務資訊聚合到釘釘群中，實現資訊的自動同步。

常見的使用場景：

  • 1、聚合Github、Gitlab等原始碼管理服務，實現原始碼更新同步；
  • 2、聚合Trello、JIRA等專案協調服務，實現專案資訊同步；
  • 3、機器人支援Webhook自定義接入，就可以實現更多可能性，例如：將運維報警、自動化測試結果報告、工作&生活日程安排（上班打卡、下班吃飯、健身、讀書、生日、紀念日...）的提醒；

目前自定義機器人支援文字（text）、連結（link）、markdown三種訊息格式，五種訊息型別，詳細資訊請參考自定義機器人官方文件

二、安裝使用

這麼好用的功能，只要在釘釘群中新增機器人，得到Webhoo地址即可。接下來，我們先在命令列終端一睹為快吧：

curl 'https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxx' \
   -H 'Content-Type: application/json' \
   -d '
  {"msgtype": "text", 
    "text": {
        "content": "我就是我, 是不一樣的煙火"
     }
  }' 
複製程式碼

由於各種訊息呼叫，官方只提供Java語言的封裝，平時使用Python比較多，為了更方便平時自動化專案的使用，週末花了點時間用Python語言對各種訊息型別進行了一一封裝，程式碼已開源在GitHub上，同時也上傳了PyPI。

1、專案原始碼地址如下：DingtalkChatbot 2、安裝命令如下：

pip install DingtalkChatbot
複製程式碼

3、支援功能如下：

  • 支援Text訊息；
  • 支援Link訊息；
  • 支援Markdown訊息；
  • 支援ActionCard訊息；
  • 支援訊息傳送失敗時自動通知；
  • 支援Python2、Python3；

三、各訊息型別使用示例

釘釘機器人訊息Python封裝(開源)

from dingtalkchatbot.chatbot import DingtalkChatbot
# WebHook地址
webhook = 'https://oapi.dingtalk.com/robot/send?access_token=這裡填寫自己釘釘群自定義機器人的token'
# 初始化機器人小丁
xiaoding = DtalkChatbot(webhook)
# Text訊息@所有人
xiaoding.send_text(msg='我就是小丁，小丁就是我！', is_at_all=True)
複製程式碼

釘釘機器人訊息Python封裝(開源)

# Text訊息之@指定使用者
at_mobiles = ['這裡填寫需要提醒的使用者的手機號碼，字串或數字都可以']
xiaoding.send_text(msg='我就是小丁，小丁就是我！', at_mobiles=at_mobiles)
複製程式碼

釘釘機器人訊息Python封裝(開源)

# Link訊息
xiaoding.send_link(title='萬萬沒想到，某小璐竟然...', text='故事是這樣子的...', message_url='http://www.kwongwah.com.my/?p=454748", pic_url="https://pbs.twimg.com/media/CEwj7EDWgAE5eIF.jpg')
複製程式碼

釘釘機器人訊息Python封裝(開源)

# Markdown訊息@所有人
xiaoding.send_markdown(title='氧氣文字', text='#### 廣州天氣\n'
                           '> 9度，西北風1級，空氣良89，相對溫度73%\n\n'
                           '> ![美景](http://www.sinaimg.cn/dy/slidenews/5_img/2013_28/453_28488_469248.jpg)\n'
                           '> ###### 10點20分發布 [天氣](http://www.thinkpage.cn/) \n',
                           is_at_all=True)
複製程式碼

釘釘機器人訊息Python封裝(開源)

    # Markdown訊息@指定使用者
    xiaoding.send_markdown(title='氧氣文字', text='#### 廣州天氣 @使用者手機號\n'
                           '> 9度，西北風1級，空氣良89，相對溫度73%\n\n'
                           '> ![美景](http://www.sinaimg.cn/dy/slidenews/5_img/2013_28/453_28488_469248.jpg)\n'
                           '> ###### 10點20分發布 [天氣](http://www.thinkpage.cn/) \n',
                           at_mobiles=at_mobiles)
複製程式碼

釘釘機器人訊息Python封裝(開源)

# FeedCard訊息型別
feedlink1 = FeedLink(title="氧氣美女", message_url="https://www.dingtalk.com/", pic_url="https://unzippedtv.com/wp-content/uploads/sites/28/2016/02/asian.jpg")
feedlink2 = FeedLink(title="氧眼美女", message_url="https://www.dingtalk.com/", pic_url="https://unzippedtv.com/wp-content/uploads/sites/28/2016/02/asian.jpg")
feedlink3 = FeedLink(title="氧神美女", message_url="https://www.dingtalk.com/", pic_url="https://unzippedtv.com/wp-content/uploads/sites/28/2016/02/asian.jpg")
links = [feedlink1.get_data(), feedlink2.get_data(), feedlink3.get_data()]
xiaoding.send_feed_card(links)
複製程式碼

釘釘機器人訊息Python封裝(開源)

# ActionCard整體跳轉訊息型別
btns1 = [{"title": "檢視詳情", "actionURL": "https://www.dingtalk.com/"}]
actioncard1 = ActionCard(title='萬萬沒想到，竟然...',
                             text='![選擇](http://www.songshan.es/wp-content/uploads/2016/01/Yin-Yang.png) \n### 故事是這樣子的...',
                             btns=btns1,
                             btn_orientation=1,
                             hide_avatar=1)
xiaoding.send_action_card(actioncard1)
複製程式碼

select_actioncard.png

# ActionCard獨立跳轉訊息型別（雙選項）
btns2 = [{"title": "支援", "actionURL": "https://www.dingtalk.com/"}, {"title": "反對", "actionURL": "http://www.back china.com/news/2018/01/11/537468.html"}]
actioncard2 = ActionCard(title='萬萬沒想到，竟然...',
                             text='![選擇](http://www.songshan.es/wp-content/uploads/2016/01/Yin-Yang.png) \n### 故事是這樣子的...',
                             btns=btns2,
                             btn_orientation=1,
                             hide_avatar=1)
xiaoding.send_action_card(actioncard2)
複製程式碼

釘釘機器人訊息Python封裝(開源)

# ActionCard獨立跳轉訊息型別（列表選項）
btns3 = [{"title": "支援", "actionURL": "https://www.dingtalk.com/"}, {"title": "中立", "actionURL": "https://www.dingtalk.com/"}, {"title": "反對", "actionURL": "https://www.dingtalk.com/"}]
    actioncard3 = ActionCard(title='萬萬沒想到，竟然...',
                             text='![選擇](http://www.songshan.es/wp-content/uploads/2016/01/Yin-Yang.png) \n### 故事是這樣子的...',
                             btns=btns3,
                             btn_orientation=1,
                             hide_avatar=1)
xiaoding.send_action_card(actioncard3)
複製程式碼

哥們，更多使用場景，現在盡情展開想象吧... （如果對你有幫助的話，歡迎 > star <）

相關文章