前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >钉钉发送报警消息的Python实现

钉钉发送报警消息的Python实现

作者头像
Debian中国
发布2018-12-21 15:37:29
3.2K2
发布2018-12-21 15:37:29
举报
文章被收录于专栏:Debian中国Debian中国

我司使用钉钉作为主要的内部通讯工具,基本上大家在电脑和手机上都开着,消息可以第一时间查看,报警消息的即时性要求比较高,我们计划使用钉钉来发送报警通知。本文将简要介绍发送消息的API使用样例。钉钉的API接口文档,请查阅钉钉开放平台

介绍如何用 Python 实现钉钉自动发送消息,你可以用来和报警平台整合,或者做ChatOps。

获取 access token

要使用钉钉发送消息,首先需要获取access token,代码如下:

代码语言:javascript
复制
def get_access_token():
    url = 'https://oapi.dingtalk.com/gettoken?corpid=%s&corpsecret=%s' % (corp_id, corp_secret)
    request = urllib2.Request(url)
    response = urllib2.urlopen(request)
    response_str = response.read()
    response_dict = json.loads(response_str)
    error_code_key = "errcode"
    access_token_key = "access_token"
    if response_dict.has_key(error_code_key) and response_dict[error_code_key] == 0 and response_dict.has_key(access_token_key):
        return response_dict[access_token_key]
    else:
        return ''

access token 在2小时内有效,有效期内重复获取返回相同结果,重复获取会使有效期会自动顺延。corp_id 和corp_secret 是企业的 id 和 secret,在钉钉的管理后台可以找到。另外,上面用到了 urllib2 和 json,需要在脚本中引用。

消息类型

钉钉的消息类型分为:text,image,voice,file,link和OA。下面以发送文本,链接和文件消息为例进行说明。

给用户发送消息

发送文本

代码语言:javascript
复制
def send_text_to_users(access_token, users, text):
    msg_type, msg = _gen_text_msg(text)
    return _send_msg_to_users(access_token, users, msg_type, msg)

def _gen_text_msg(text):
    msg_type = 'text'
    msg = { "content": text }
    return msg_type, msg

def _send_msg_to_users(access_token, users, msg_type, msg):
    to_users = '|'.join(users)
    body_dict = {
        "touser": to_users,
        "agentid": agent_id,
        "msgtype": msg_type
    }
    body_dict[msg_type] = msg
    body = json.dumps(body_dict)
    return _send_msg("https://oapi.dingtalk.com/message/send?access_token=", access_token, body)

其中agent_id是一个钉钉应用的id,以钉钉应用的名义给用户发送消息。users是用户id列表,每个用户id是一个字符串。

发送链接

代码语言:javascript
复制
def send_link_to_users(access_token, users, url, title, text):
    msg_type, msg = _gen_link_msg(url, title, text)
    return _send_msg_to_users(access_token, users, msg_type, msg)

def _gen_link_msg(url, title, text):
    msg_type = 'link'
    msg = { 
        "messageUrl": url,
        "picUrl": "https://gw.alicdn.com/tps/TB1FN16LFXXXXXJXpXXXXXXXXXX-256-130.png",
        "title": title,
        "text": text 
    }
    return msg_type, msg

其中_send_msg_to_users方法参见前面的代码,picUrl字段设置的是钉钉官方的图片,这里用于测试。

发送文件

代码语言:javascript
复制
def send_file_to_users(access_token, users, file_name):
    media_id = upload_file(access_token, file_name)
    if media_id == '':
        return
    msg_type, msg = _gen_file_msg(media_id)
    return _send_msg_to_users(access_token, users, msg_type, msg)

def upload_file(access_token, file_name):
    register_openers()
    datagen, headers = multipart_encode({'media': open(file_name, 'rb')})
    requst_url = 'https://oapi.dingtalk.com/media/upload?access_token=' + access_token + '&type=file'
    request = urllib2.Request(requst_url, datagen, headers)
    response = urllib2.urlopen(request)
    response_str = response.read()
    response_dict = json.loads(response_str)
    media_id_key = 'media_id'
    error_code_key = 'errcode'
    if response_dict.has_key(error_code_key) and response_dict[error_code_key] == 0 and response_dict.has_key(media_id_key):
        return response_dict[media_id_key]
    else:
        return ''

需要先上传文件获得media_id,然后使用media_id将文件发送给用户。另外,这里用到了poster,可使用pip安装:

代码语言:javascript
复制
pip install poster

之后引入multipart_encode和register_openers函数:

代码语言:javascript
复制
from poster.encode import multipart_encode
from poster.streaminghttp import register_openers

给群会话发送消息

与给用户发送信息类似,区别是需要群会话id,而不是用户列表,以发送文本消息为例,代码如下:

代码语言:javascript
复制
def send_text_to_chat(access_token, chat_id, text):
    msg_type, msg = _gen_text_msg(text)
    return _send_msg_to_chat(access_token, chat_id, msg_type, msg)

def _send_msg_to_chat(access_token, chat_id, msg_type, msg):
    body_dict = {
        "chatid": chat_id,
        "msgtype": msg_type
    }
    body_dict[msg_type] = msg
    body = json.dumps(body_dict)
    return _send_msg("https://oapi.dingtalk.com/chat/send?access_token=", access_token, body)

其中_gen_text_msg 方法参见前面的代码。

群会话可以自行创建,详情请参考这里的文档

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2018-04-27 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 获取 access token
  • 消息类型
  • 给用户发送消息
    • 发送文本
      • 发送链接
        • 发送文件
        • 给群会话发送消息
        领券
        问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档