python dingding --- 钉钉机器人API
创始人
2024-04-13 07:31:39
0

dingding — 钉钉机器人

github 源码地址:https://github.com/zly717216/dingding

一、模块介绍

版本号

dingding: V1.0.0

功能

当前版本支持群机器人相关API调用,包括发送文本消息、文本链接、markdown、整体跳转 ActionCard、独立跳转 ActionCard、FeedCard。

文本消息类型

在这里插入图片描述

文本链接类型

在这里插入图片描述

markdown 类型

在这里插入图片描述

整体跳转 ActionCard类型

在这里插入图片描述

独立跳转 ActionCard 类型

在这里插入图片描述

FeedCard 类型

在这里插入图片描述

如何使用

  • 1.创建钉钉群
  • 2.创建机器人,复制 webhook,如:https://oapi.dingtalk.com/robot/send?access_token=xxxxx
  • 3.调用机器人API,示例见下文

安装

将 dingding 包复制到 site-pakages 下

二、示例

设置token

方式一:

from dingding import set_token# 机器人的token是webhook中的 access_token 参数
set_token('xxx')

方式二:

from dingding import Robot     # Robot 是一个机器人实例对象Robot.set_token('xxx')

方式三:

from dingding import R        # R 是一个机器人类对象r = R()
r.set_token('xxx')

查看token

方式一:

from dingding import Robotprint(Robot.token)

方式二:

from dingding import Rr = R()
print(r.token)

设置关键词

方式一:

from dingding import set_key_word# 机器人的关键词是创建群聊机器人时自己添加的,不包含其中一个关键词消息无法发出
# set_key_word('xxx')
set_key_word(['xxx1', 'xxx2'])

方式二:

from dingding import Robot     # Robot 是一个机器人实例对象# Robot.set_key_word('xxx')
Robot.set_key_word(['xxx1', 'xxx2'])

方式三:

from dingding import R        # R 是一个机器人类对象r = R()
# r.set_key_word('xxx')
r.set_key_word(['xxx1', 'xxx2'])

查看关键词

方式一:

from dingding import Robotprint(Robot.key_word)

方式二:

from dingding import Rr = R()
print(r.key_word)

设置开头模板

方式一:

from dingding import set_token# 设置消息的开头模板,例如:提示时间
set_tpl('xxx')

方式二:

from dingding import Robot     # Robot 是一个机器人实例对象Robot.set_tpl('xxx')

方式三:

from dingding import R        # R 是一个机器人类对象r = R()
r.set_tpl('xxx')

发送文本消息

from dingding import RobotRobot.send_text('hello word')
# @张三
Robot.send_text('hello word', at_user_ids=['zhangsan'])
# @所有人
Robot.send_text('hello word', at_all=True)

发送Markdown消息

from dingding import RobotRobot.send_markdown(title='this is a markdown message', text='**加粗hello world**')

发送整体跳转 ActionCard 消息

from dingding import RobotRobot.send_overall_card(title='this is a markdown message', text='**加粗hello world**', link='https://www.baidu.com')

发送独立跳转 ActionCard 消息

from dingding import RobotRobot.send_dependent_card(title='this is a markdown message', text='**加粗hello world**',buttons=[{"title": "内容不错","actionURL": "https://www.dingtalk.com/"},{"title": "不感兴趣","actionURL": "https://www.dingtalk.com/"}]
)

发送 FeedCard 消息

from dingding import RobotRobot.send_feed_card(title_list=['时代的火车向前开1', '时代的火车向前开2'],message_url_list=['https://www.dingtalk.com/', 'https://www.dingtalk.com/'],pic_url_list=['https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png', 'https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png'],
)

三、API

dingding 模块 API

API说明
R机器人类对象
Robot机器人实例对象
set_token给机器人实例设置token
set_key_word给机器人实例设置关键词
set_tpl给机器人实例设置开头模板

Robot API

API说明
set_token给机器人实例设置token
set_key_word给机器人实例设置关键词
set_tpl给机器人实例设置开头模板
send_text发送文本消息
send_markdown发送markdown文本消息
send_overall_card发送图片消息
send_dependent_card发送图片文本
send_feed_card发送文件

Robot API 参数

set_token 参数:

参数类型说明
token列表token,webhook中的key参数

set_key_word 参数:

参数类型说明
key_word列表关键词,机器人的关键词是创建群聊机器人时自己添加的,不包含其中一个关键词消息无法发出

set_tpl 参数:

参数类型说明
tpl列表开头模板

send_text 参数:

参数类型说明
text字符串消息内容
at_allbool@all
at_user_ids列表userid的列表,提醒群中的指定成员(@某个成员)。如:[‘zhangsan’, ‘lisi’]
at_mobiles列表手机号列表,提醒手机号对应的群成员(@某个成员) 如:[‘19912345678’]
indexint关键词索引,如果设置了多个关键词,index 表示用第几个官籍此发消息

send_markdown 参数:

参数类型说明
title字符串消息标题
text字符串消息内容
at_allbool@all
at_user_ids列表userid的列表,提醒群中的指定成员(@某个成员)。如:[‘zhangsan’, ‘lisi’]
at_mobiles列表手机号列表,提醒手机号对应的群成员(@某个成员) 如:[‘19912345678’]
indexint关键词索引,如果设置了多个关键词,index 表示用第几个官籍此发消息

send_link 参数:

参数类型说明
title字符串图片路径
at_allbool图片路径
at_user_ids列表图片路径
at_mobiles列表图片路径
indexint关键词索引,如果设置了多个关键词,index 表示用第几个官籍此发消息

send_overall_card 参数:

参数类型说明
title字符串消息标题
text字符串消息内容
link字符串消息链接
single_title字符串消息结尾提示标题,如:全文阅读
indexint关键词索引,如果设置了多个关键词,index 表示用第几个官籍此发消息

send_dependent_card 参数:

参数类型说明
title字符串消息标题
text字符串消息内容
buttons列表消息跳转按钮列表
indexint关键词索引,如果设置了多个关键词,index 表示用第几个官籍此发消息

buttons 参数字段说明:

参数类型说明
title字符串消息标题
actionURL字符串跳转url
  • botton 构造参数示例:
[{"title": "内容不错","actionURL": "https://www.dingtalk.com/"},{"title": "不感兴趣","actionURL": "https://www.dingtalk.com/"}
]

send_feed_card 参数:

参数类型说明
title_list列表消息标题列表
title_list列表消息标题列表
message_url_list列表消息跳转url列表
pic_url_list列表消息封面url列表
indexint关键词索引,如果设置了多个关键词,index 表示用第几个官籍此发消息

相关内容

热门资讯

宇树科技被起诉,什么原因? 涉及侵权责任纠纷案件 投资时间网、标点财经快讯 天眼查法律诉讼信息显示,近日,杭州宇树科技股份有限公...
惠城环保:已制定《市值管理制度... 证券之星消息,惠城环保(300779)12月31日在投资者关系平台上答复投资者关心的问题。 投资者提...
看2026|和尔解王倩:降低调... 站在“十五五”新程待启的关键时点,如何看待2026年的经济形势?2026年经济工作怎么干?新京报贝壳...
奇瑞汽车申请满足软件升级法规要... 国家知识产权局信息显示,奇瑞汽车股份有限公司申请一项名为“一种满足软件升级法规要求的升级测试优化方法...
国台办:公安机关发布悬赏通告并... 12月31日上午,国台办在新闻发布厅举行例行新闻发布会,发言人张晗就近期两岸热点问题回答记者提问。 ...
元旦前发布这种朋友圈,他们面临... 元旦即将到来 不少人想买点烟花爆竹 增添节日氛围 朋友圈里也出现了 各种烟花爆竹的广告 但你知道吗 ...
“护航”增值税法顺利实施 配套... 新华社北京12月31日电 《经济参考报》12月31日刊发记者韦夏怡采写的文章《“护航”增值税法顺利实...
《山东省行政调解办法》5月1日... 在我们的日常生活中,难免会遇到各种纠纷,调解作为重要的纠纷解决方式,在维护群众权益方面发挥了重要作用...
上海发文推进老年人意定监护制度... 12月31日,上海市政府官网发布《上海市人民政府办公厅关于推进实施老年人意定监护制度的若干意见(试行...