pten 是一个便利快速使用企业微疑API的python东西库.
github: https://github.com/bendell02/pten
gitee: https://gitee.com/bendell02/pten
1.装置
pip install pten
大概源码装置
2.根底 使用 -- 以使用企业微疑机械人收收消息为例
2.1 树立设置文献
设置文献默认路子为 pten_keys.ini，也能够颠末 keys_filepath 参数指定设置文献路子。 设置文献残破实质请参照[设置文献](#3. 设置文献)，并不是统统字段皆需要树立，按照自己需要设置便可。
好比假设只用企业微疑机械人，只要设置 ww的webhook_key字段便可。
[ww]
webhook_key=7ande764-52a4-43d7-a252-05e8abcdb863
2.2 开端使用
from pten.wwmessager import BotMsgSender
bot = BotMsgSender() # 默认使用 pten_keys.ini 设置文献
# bot = BotMsgSender("another_pten_keys.ini")
# 收收文原消息
response = bot.send_text("hello world")
# 收收markdown消息
markdown_content = '<font color="info">Hello world</font>'
response = bot.send_markdown(markdown_content)
# 收收图片消息
image_path = "sample_image.png"
response = bot.send_image(image_path)
# 借可收收语音消息、图文消息、文献消息等
3. 设置文献
并不是统统字段皆需要树立，按需传进
3.1完整 设置文献样例
[ww]
app_aes_key=9z1Cj9cSd7WtEV3hOWo5iMQlFkSP9Td1ejzsV9WhCmO
app_agentid=1000005
app_secret=jVJF_EBWCVA_KVi_89YnY1T1bPD8-0PdqQ2rXc_Pgmj5
app_token=zJdPmXg8E4J1mMdnzP8d
contact_sync_secret=G4PC19fIwfsykabdv_drNVlOIe_crBvay3sUX8DhGss
corpid=wwdb63ff5ae01cd4b4
webhook_key=7ande764-52a4-43d7-a252-05e8abcdb863
[globals]
debug_mode=False
[proxies]
http=http://xxx:xxx@xxx.xxx.xxx.xxx:8888
https=http://xxx:xxx@xxx.xxx.xxx.xxx:8888
[notice]
;ai
deepseek_api_key=sk-0a6e5b4e8b4c0e1a5b6b8e0e4d5aefb
;weather
seniverse_api_key=v5bFw3o1pSmbGvuEN
3.2 设置文献字段分析
| section | 字段称呼 | 字段分析 | | ww | app_aes_key | 使用的aes_key。使用支收消息减解稀时使用 |
| app_agentid | 使用的agentid。使用收消息时使用 |
| app_secret | 使用的secret。效劳端API获得access_token时需要使用 |
| app_token | 使用的token。使用支收消息减解稀时使用 |
| contact_sync_secret | 通信录的secret。使用通信录模块时部门API需要使用该secret。颠末Contact的contact_sync_secret参数传进 |
| corpid | corpid。效劳端API获得access_token时需要使用 |
| webhook_key | 企业微疑机械人的webhook_key。使用机械人收消息时需要使用 | | globals | debug_mode | 树立为True时启开调试情势，多一点儿调试疑息 | | proxies | http | 树立http代办署理。需要走代办署理时树立便可 |
| https | 树立https代办署理。需要走代办署理时树立便可 | | notice | deepseek_api_key | deepseek的api_key。使用Deepseek类答复一点儿成就时可传进 |
| seniverse_api_key | 心知气候的api_key。使用Weather类获得气候时可传进 |
因为企业微疑API是需要设置可托ip，只需可托ip才气挪用API。假设当地收集的ip经常变，那末屡屡挪用API皆需要从头设置可托ip，比力省事。能够设置代办署理，让企业微疑API挪用时走代办署理，把代办署理的ip设置到可托ip里，如许就能够制止那个成就。
4. 各个模块使用分析
4.1 wwmessage 模块 : 收收机械人战使用消息
4.1.1 机械人收收消息
from pten.wwmessager import BotMsgSender
bot = BotMsgSender() # 默认使用 pten_keys.ini 设置文献
# 收收文原消息
response = bot.send_text("hello world")
# 借可收收markdown消息、图片消息、语音消息、图文消息、文献消息等
4.1.2 使用收收消息
from pten.wwmessager import AppMsgSender
app = AppMsgSender()
# 收收文原消息
response = app.send_text("hello world from app")
# 借可收收markdown消息、图片消息、语音消息、图文消息、文献消息、模板卡片消息等
4.2 notice 模块 :通知 功用
4.2.1 获得气候并报告
可设置颠末机械人大概使用收收报告，默认挨印正在掌握台
from pten.notice import Weather
from pten.wwmessager import BotMsgSender
weather = Weather()
bot = BotMsgSender()
# 设置颠末机械人去收收报告
weather.set_report_func(bot.send_text)
# 增加要获得气候的都会，可增加多个
weather.add_city("深圳", "Shenzhen")
# 收收气候报告，可颠末apscheduler按时挪用，天天早上报告气候疑息
weather.report_weather()
4.2.2 诞辰提醒
夏历诞辰战阴历诞辰皆撑持可设置颠末机械人大概使用收收报告，默认挨印正在掌握台提醒事后会主动增加下一天的提醒schedule夏历诞辰会主动处置闰月情况
from pten.notice import Birthday
from pten.wwmessager import BotMsgSender
from apscheduler.schedulers.blocking import BlockingScheduler
scheduler = BlockingScheduler()
birthday = Birthday()
# 树立按时器
birthday.set_scheduler(scheduler)
# 树立颠末机械人去收收报告
bot = BotMsgSender()
birthday.set_report_func(bot.send_text)
# 增加夏历诞辰提醒
birthday.add_lunar_schedule(3, 15, who="玛丽")
# 可定造提醒实质，挖写 greeting_words 参数
birthday.add_lunar_schedule(3, 15, who="玛丽", greeting_words="玛丽分开天球留念日，死快！")
# 增加阴历诞辰提醒
birthday.add_solar_schedule(1, 12, who="玛莉亚")
scheduler.start()
4.2.3 获得ai的答复
from pten.notice import Deepseek
deepseek = Deepseek()
content = deepseek.get_completion("简单介绍一下牛整理")
4.3 wwcrypt 模块 : 减解稀消息
使用支收消息减解稀模块
from pten.keys import Keys
from pten.wwcrypt import WXBizMsgCrypt
keys = Keys()
CORP_ID = keys.get_key("ww", "corpid")
API_TOKEN = keys.get_key("ww", "app_token")
API_AES_KEY = keys.get_key("ww", "app_aes_key")
wxcpt = WXBizMsgCrypt(API_TOKEN, API_AES_KEY, CORP_ID)
# VerifyURL
# ...
ret, sEchoStr = wxcpt.VerifyURL(msg_signature, timestamp, nonce, echostr)
# DecryptMsg
# ...
body = await request.body()
ret, sMsg = wxcpt.DecryptMsg(body.decode("utf-8"), msg_signature, timestamp, nonce)
# EncryptMsg
# ...
ret, send_msg = wxcpt.EncryptMsg(sReplyMsg=sRespData, sNonce=nonce)
4.4 wwcontact 模块 : 通信录像闭API
from pten.wwcontact import Contact
contact = Contact("pten_keys.ini")
userid = "userid"
response = contact.get_user(userid)
department_id = "2"
response = contact.get_user_simple_list(department_id)
department_id = "2"
response = contact.get_user_list(department_id)
## 更多通信录API可参照源码
4.5 wwdoc 模块 : 企业微疑文档相干API
from pten.wwdoc import Doc
wwdoc = Doc("pten_keys.ini")
#创立 文档
doc_type = 10
doc_name = "test_smart_table2"
admin_users = ["user_a", "user_b"]
response = wwdoc.create_doc(doc_type, doc_name, admin_users=admin_users)
# 智能表格增加望图
docid = "your_docid"
sheet_id = "your_sheetid"
view_title = "view_title"
view_type = "VIEW_TYPE_GRID"
response = wwdoc.smartsheet_add_view(docid, sheet_id, view_title, view_type)
# 智能表格增加字段
fields = [{"field_title": "TITLE", "field_type": "FIELD_TYPE_TEXT"}]
response = wwdoc.smartsheet_add_fields(docid, sheet_id, fields)
assert_response(response)
fields = [
{
"field_title": "number",
"field_type": "FIELD_TYPE_NUMBER",
"property_number": {"decimal_places": 2, "use_separate": False},
}
]
response = wwdoc.smartsheet_add_fields(docid, sheet_id, fields)
## 更多企业微疑文档API可参照源码
4.6 wwapi 模块 : 通用API
假设正在其余模块中找没有到念挪用的api，可颠末此模块挪用
4.6.1 BotApi BOT_API_TYPE
from pten.wwapi import BotApi, BOT_API_TYPE
api = BotApi("pten_keys.ini")
response = api.http_call(
BOT_API_TYPE["WEBHOOK_SEND"],
{"msgtype": "text", "text": {"content": "hello from bot"}},
)
4.6.2 CorpApi CORP_API_TYPE
from pten.wwapi import CorpApi, CORP_API_TYPE
api = CorpApi("pten_keys.ini")
response = api.http_call(CORP_API_TYPE["DEPARTMENT_LIST"])
corp_jsapi_ticket = api.get_corp_jsapi_ticket()
app_jsapi_ticket = api.get_app_jsapi_ticket() |
提升卡
置顶卡
沉默卡
喧嚣卡
变色卡
千斤顶
照妖镜
广告
