# web.feishu.socketClient 库模块帮助文档 ## feishuSocketClientObject 成员列表 # ### feishuSocketClientObject.appId # 飞书应用 App ID ### feishuSocketClientObject.appSecret # 飞书应用 App Secret ### feishuSocketClientObject.autoReconnect # 是否自动重连，默认 true ### feishuSocketClientObject.close() # 关闭连接并停止自动重连 ### feishuSocketClientObject.connId # 连接成功后的 device_id ### feishuSocketClientObject.connect(url) # 连接到指定 WebSocket URL ### feishuSocketClientObject.domain # 飞书 API 域名，默认 "https://open.feishu.cn" ### feishuSocketClientObject.download(url,savePath,progressCb) # 下载文件 ### feishuSocketClientObject.downloadFile(fileKey,savePath,progressCb) # 下载文件 ### feishuSocketClientObject.downloadImage(imageKey,savePath,progressCb) # 下载图片 ### feishuSocketClientObject.downloadMessageResource(messageId,fileKey,typ,savePath,progressCb) # 下载消息资源 ### feishuSocketClientObject.getTenantToken() # 获取 tenant_access_token ### feishuSocketClientObject.on(eventType,handler) # 注册事件监听器。 handler 签名：function（eventObj, frame, headers） ### feishuSocketClientObject.pingInterval # 心跳间隔（秒），默认 120 ### feishuSocketClientObject.reconnectCount # 最大重连次数，-1 表示无限重连 ### feishuSocketClientObject.reconnectInterval # 重连间隔（秒），默认 120 ### feishuSocketClientObject.reconnectNonce # 重连随机延迟（秒），默认 30 ### feishuSocketClientObject.reply(messageId,msgType,contentTable) # 回复消息 ### feishuSocketClientObject.replyFile(messageId,fileKey) # 回复文件消息 ### feishuSocketClientObject.replyFilePath(messageId,path,fileType,fileName,duration,progressCb) # 上传并回复文件 ### feishuSocketClientObject.replyImage(messageId,imageKey) # 回复图片消息 ### feishuSocketClientObject.replyImagePath(messageId,path,imageType,progressCb) # 上传并回复图片 ### feishuSocketClientObject.replyText(messageId,text) # 快捷回复文本 ### feishuSocketClientObject.request(url,method,data) # 发送 REST 请求 ### feishuSocketClientObject.rest # REST API 客户端实例 [返回对象:feishuRestClientObject](#feishuRestClientObject) ### feishuSocketClientObject.send(receiveId,receiveIdType,msgType,contentTable) # 发送消息 ### feishuSocketClientObject.sendFile(receiveId,receiveIdType,fileKey) # 发送文件消息 ### feishuSocketClientObject.sendFilePath(receiveId,receiveIdType,path,fileType,fileName,duration,progressCb) # 上传并发送文件 ### feishuSocketClientObject.sendImage(receiveId,receiveIdType,imageKey) # 发送图片消息 ### feishuSocketClientObject.sendImagePath(receiveId,receiveIdType,path,imageType,progressCb) # 上传并发送图片 ### feishuSocketClientObject.sendText(receiveId,receiveIdType,text) # 快捷发送文本 ### feishuSocketClientObject.serviceId # 连接成功后的 service_id ### feishuSocketClientObject.source # 来源标识，用于 User-Agent ### feishuSocketClientObject.start() # 启动长连接。自动获取 endpoint 并连接。返回 true 或 false, 错误信息 ### feishuSocketClientObject.updateMessage(messageId,msgType,contentTable) # 编辑消息 ### feishuSocketClientObject.updateText(messageId,text) # 快捷编辑文本 ### feishuSocketClientObject.uploadFilePath(path,fileType,fileName,duration,progressCb) # 上传文件，返回 fileKey ### feishuSocketClientObject.uploadImagePath(path,imageType,progressCb) # 上传图片，返回 imageKey ### feishuSocketClientObject.ws # WebSocket 客户端实例 ## feishuSocketClientObject 事件列表 # ### feishuSocketClientObject.onCard # 卡片交互回调。 @.onCard = function（cardObj, frame, headers）{} ### feishuSocketClientObject.onDisconnected # 断开连接回调。 @.onDisconnected = function（e）{} ### feishuSocketClientObject.onError # 错误回调。 @.onError = function（err）{} ### feishuSocketClientObject.onEvent # 通用事件回调。 @.onEvent = function（eventType, eventObj, frame, headers）{} ### feishuSocketClientObject.onRawFrame # 原始帧回调。 @.onRawFrame = function（frame）{} ### feishuSocketClientObject.onReady # 连接就绪回调。 @.onReady = function（）{} ### feishuSocketClientObject.onReconnecting # 重连中回调。 @.onReconnecting = function（attempts, delay）{} ## web.feishu 成员列表 # ### web.feishu.socketClient # 飞书开放平台长连接 WebSocket 客户端。支持事件订阅、自动重连、心跳维持。 [返回对象:feishuSocketClientObject](#feishuSocketClientObject) ### web.feishu.socketClient(配置表) # 创建飞书长连接客户端。配置表必须包含 appId、appSecret 字段，可选字段：domain、source、autoReconnect、reconnectCount、 reconnectInterval、reconnectNonce、pingInterval。 [返回对象:feishuSocketClientObject](#feishuSocketClientObject)