飞书 Python SDK 上手指南:一条命令跑通你的第一个 API 调用

发布时间:2026/8/23 0:47:29
飞书 Python SDK 上手指南:一条命令跑通你的第一个 API 调用 飞书 Python SDK 上手指南一条命令跑通你的第一个 API 调用【免费下载链接】oapi-sdk-pythonLarksuite development interface SDK项目地址: https://gitcode.com/gh_mirrors/oa/oapi-sdk-python省掉鉴权和加解密直接写业务代码接入飞书开放平台最琐碎的部分不是业务逻辑而是周边工作获取和续期 tenant_access_token、校验请求签名、对事件数据加解密、手写请求体校验。lark-oapi飞书 Python SDK把这些逻辑封装在一个客户端里你只需要填 App ID 和 App Secret剩下的交给 SDK。下面从安装到拿到第一个 API 返回全程不超过三步。从零到第一次成功调用安装 SDK要求 Python 3.8pip install lark-oapi然后在代码里初始化客户端。builder()链式设置凭据build()返回可用的 Client 对象import lark_oapi as lark client lark.Client.builder() \ .app_id(cli_xxx) \ .app_secret(your_app_secret) \ .build()到这一步token 的获取、缓存和刷新已经由 SDK 内部接管client上挂载了 im、contact、approval 等所有服务模块可以直接发起请求。按场景看能力发消息与收消息IM 模块封装了消息的创建、回复和撤回文本、富文本、图片、卡片消息类型都有对应的请求模型路径见 lark_oapi/api/im/。处理事件与回调消息接收、卡片交互这类事件通过EventDispatcherHandler注册处理函数SDK 负责验签和 AES 解密你只写业务函数路径见 lark_oapi/event/。管理业务数据通讯录、审批、日历、多维表格、文档等服务按业务域拆分成独立模块每个都是client.模块.版本.资源.方法()的固定调用形态路径见 lark_oapi/api/。实时长连接不想暴露公网回调地址时lark.ws.Client通过 WebSocket 长连接接收事件路径见 lark_oapi/ws/。一个完整示例给指定用户发一条消息初始化、构造请求、发起调用、处理结果完整流程如下request lark.im.v1.CreateMessageRequest.builder() \ .receive_id_type(open_id) \ .request_body(lark.im.v1.CreateMessageRequestBody.builder() .receive_id(ou_xxx) .msg_type(text) .content({text:hello lark}) .build()) \ .build() response client.im.v1.message.create(request) if not response.success(): print(response.code, response.msg, response.get_log_id()) else: print(lark.JSON.marshal(response.data, indent4))数据流是单向的request进入client.im.v1.message.create()SDK 补上鉴权头后发往开放平台返回的response里data是业务结果code/msg是错误信息get_log_id()返回的日志 ID 可用于向平台侧查询请求详情。平台侧要填什么在飞书开放平台控制台创建应用后进入「凭证与基础信息」页面复制 App ID 和 App Secret 填入上面的 builder 链。如果要做事件订阅还需在「事件与回调」页配置 Encrypt Key 和 Verification Token这两个值传给EventDispatcherHandler.builder()。常见报错速查返回 99991672 权限错误现象response.success()为 False错误码是 99991672 或 msg 提示 no permission原因应用还没申请对应 API 权限或权限未发布修复在开放平台「权限管理」中开通权限并重新发布应用事件订阅始终收不到事件现象消息发了处理函数没触发原因代码里注册的事件名和平台侧订阅的事件不一致修复以register_p2_im_message_receive_v1这类方法名对应的 key 为准核对「事件与回调」页的订阅列表响应排查抓不到现场现象调用失败但不知道请求发到哪一步原因默认日志级别不够修复builder 链上加.log_level(lark.LogLevel.DEBUG)日志 ID 用response.get_log_id()获取下一步从示例代码继续事件订阅含卡片回传交互samples/event/flask_sample.py卡片回调samples/card/flask_sample.py单个 API 的最小调用模板samples/api/按业务域分目录如api/im/v1/、api/contact/v3/机器人收消息回显samples/channel/echo_bot.py进阶入口在lark_oapi/ws/lark.ws.Client配合事件处理器即可走长连接无需公网地址示例见 samples/ws/sample.py。打开终端把第一条pip install lark-oapi跑起来。【免费下载链接】oapi-sdk-pythonLarksuite development interface SDK项目地址: https://gitcode.com/gh_mirrors/oa/oapi-sdk-python创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

相关新闻