钉钉企业内部机器人开发(公网部署版本)
钉钉给出的开发文档地址如下: https://open.dingtalk.com/document/group/enterprise-created-chatbot
1.创建机器人
? 1.登录钉钉开发者后台,依次选择应用开发 > 企业内部开发 > 机器人,点击创建应用 ? 2.填写机器人名字、描述、图片等信息,点击创建,创建完成会生成AppKey、AppSecret(代码里用来校验请求是否合法)等信息
2.开发机器人
当用户@机器人时,钉钉会通过机器人开发者的HTTPS服务地址,把消息内容发送出去,报文协议如下。
{
"Content-Type": "application/json; charset=utf-8",
"timestamp": "1577262236757",
"sign":"xxxxxxxxxx"
}
开发者需对header中的timestamp和sign进行验证,以判断是否是来自钉钉的合法请求,避免其他仿冒钉钉调用开发者的HTTPS服务传送数据,具体验证逻辑如下:
?timestamp 与系统当前时间戳如果相差1小时以上,则认为是非法的请求。
?sign 与开发者自己计算的结果不一致,则认为是非法的请求。
?必须当timestamp和sign同时验证通过,才能认为是来自钉钉的合法请求。
sign的计算方法:
header中的timestamp + “\n” + 机器人的appSecret当做签名字符串,使用HmacSHA256算法计算签名,然后进行Base64 encode,得到最终的签名值。,python的签名代码示例如下
import hmac
import hashlib
import base64
timestamp = '1577262236757'
app_secret = 'this is a secret'
app_secret_enc = app_secret.encode('utf-8')
string_to_sign = '{}\n{}'.format(timestamp, app_secret)
string_to_sign_enc = string_to_sign.encode('utf-8')
hmac_code = hmac.new(app_secret_enc, string_to_sign_enc, digestmod=hashlib.sha256).digest()
sign = base64.b64encode(hmac_code).decode('utf-8')
print(sign)
捋一下整体逻辑: 1.用户@机器人,发一个消息到消息接收地址(相当于访问机器人服务接口) 2.从请求headers里面获取到sign和timestamp两个值服务端自己算的sign及timestamp做校验 3.校验通过,是合法请求,返回给调用者对应的内容,否则不通过报错
代码实现 使用flask写个接口,host绑定0.0.0.0,端口9090(随意定即可)
import flask
from flask import request
import json
import requests
import time
import hmac
import base64
import hashlib
server = flask.Flask(__name__)
@server.route("/robot", methods=['post'])
def run():
post_sign = request.headers.get("Sign")
print("请求头中的sign", request.headers.get("Sign"))
post_timestamp = request.headers.get("Timestamp")
print("请求头中的Timestamp", request.headers.get("Timestamp"))
timestamp = str(round(time.time() * 1000))
app_secret_enc = app_secret.encode('utf-8')
string_to_sign = '{}\n{}'.format(post_timestamp, app_secret)
string_to_sign_enc = string_to_sign.encode('utf-8')
hmac_code = hmac.new(app_secret_enc, string_to_sign_enc, digestmod=hashlib.sha256).digest()
sign = base64.b64encode(hmac_code).decode('utf-8')
print("根据加密规则生成的sign:", sign)
if (abs(int(post_timestamp) - int(timestamp)) < 3600000 and post_sign == sign):
request_data_dict = json.loads(request.get_data())
print("请求数据:", request_data_dict)
post_userid = request_data_dict.get("senderId")
post_message = request_data_dict.get("text").get("content").strip()
print("请求内容:", post_message)
post_sessionwebhook = request_data_dict.get("sessionWebhook")
header = {
"Content-Type": "application/json",
"Charset": "UTF-8"
}
message_json = {
"msgtype": "text",
"text": {
"content": "这是响应内容"
},
"at": {
"atDingtalkIds": [post_userid],
"isAtAll": False
}
}
info = requests.post(url=post_sessionwebhook, data=message_json, headers=header))
print(info.text)
else:
print("Warning:Not DingDing's post")
if __name__ == '__main__':
server.run(host="0.0.0.0", port=9090)
上述代码中只展示了一种返回格式,更多具体返回消息格式详见: https://open.dingtalk.com/document/group/basic-message-types 写完之后,将代码上传公网服务器,使用命令启动该文件,如 python xxx.py 即可
3.发布机器人
发布之前,在机器7人详情页,单击开发管理,配置开发信息。主要包括两个点: ?1.服务器出口ip。这个其实就是部署机器人服务公网可访问的IP ?2.消息接收地址。这个就是机器人服务的 http://公网ip:9090/robot(上面接口定义的)
然后在开发者后台对应的机器人应用详情页面,单击版本管理与发布,点击发布,即可使用
使用过程建议:可以先和机器人单聊,然后再建个群使用@功能
|