{ "version": "0.2.0", "updatedAt": "2026-07-10", "source": "企业微信开放接口资料", "gateway": { "baseUrl": "https://server.fmode.cn/api/qiwei", "endpoint": "POST {baseUrl}/doApi", "auth": "Authorization: Bearer ", "envelope": "Fmode 网关请求信封：{\"uid\": \"<本地稳定设备标识>\", \"method\": \"<接口 method 路径>\", \"params\": {...}}；企业微信接口访问凭据和设备上下文由 Fmode 网关管理。", "note": "所有业务请求均通过 Fmode 网关转发的企业微信接口执行。清单未登记的普通 JSON 接口可用 qiwei_api_call 传 rawMethod + params；登录和设备接口必须使用 qiwei_login_* 专用工具。" }, "modules": [ "client", "cloud", "contact", "label", "login", "msg", "room", "session", "sns", "user" ], "endpoints": [ { "id": "room.openidToId", "module": "room", "title": "OpenID转Roomid", "summary": "OpenID转Roomid 将 OpenID 转换为 Roomid，用于群聊等场景下的用户标识映射。", "method": "/room/openidToId", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "OpenID转Roomid.md", "tags": [ "群模块", "room", "OpenID转Roomid", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "openRoomId", "in": "body", "type": "string", "required": true, "desc": "群openid。单个查询" }, { "name": "openRoomIdList", "in": "body", "type": "array", "required": true, "desc": "群openid列表。批量查询（当单个查询时，批量查询不会生效，只能任选其一）" }, { "name": "corpAgentId", "in": "body", "type": "string", "required": true, "desc": "企业应用id，请从企业模块-企业应用相关API中获取" } ], "responseHint": "data 字段：roomId（目标群聊 ID，可通过群分页或群详情接口获取 roomId）；roomIdList（群Id列表）" }, { "id": "contact.openidToId", "module": "contact", "title": "Openid转Userid", "summary": "Openid转Userid • OpenID：就是官方API的 external_userid（客户的唯一身份证）", "method": "/contact/openidToId", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "Openid转Userid.md", "tags": [ "contact", "Openid转Userid", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "openIdList", "in": "body", "type": "array", "required": true, "desc": "用户openid" }, { "name": "openPartyIdList", "in": "body", "type": "array", "required": true, "desc": "部门openid" }, { "name": "corpAgentId", "in": "body", "type": "string", "required": true, "desc": "企业应用id，请从企业模块-企业应用相关API中获取" } ], "responseHint": "data 字段：vid2UserIdList（Vid2用户Id列表）；partyId2OpenPartyIdList（PartyId2OpenPartyId列表）；vid2OpenIdList（Vid2OpenId列表）" }, { "id": "room.openid", "module": "room", "title": "Roomid转OpenID", "summary": "Roomid转OpenID 将 Roomid 转换为 OpenID，用于跨场景的用户标识映射。", "method": "/room/openid", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "Roomid转OpenID.md", "tags": [ "群模块", "room", "Roomid转OpenID", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "corpAgentId", "in": "body", "type": "string", "required": true, "desc": "请从企业模块-企业应用相关API中获取" } ], "responseHint": "data 字段：openRoomId（Open群Id）" }, { "id": "contact.openid", "module": "contact", "title": "Userid转Openid", "summary": "Userid转Openid OpenID：就是官方API的 external_userid（客户的唯一身份证）", "method": "/contact/openid", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "Userid转Openid.md", "tags": [ "contact", "联系人模块", "Userid转Openid", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userIdList", "in": "body", "type": "array", "required": true, "desc": "用户id列表" }, { "name": "corpAgentId", "in": "body", "type": "string", "required": true, "desc": "请从企业模块-企业应用相关API中获取" } ], "responseHint": "data 字段：openUserList（Open用户列表）" }, { "id": "msg.syncCollectionMsg", "module": "msg", "title": "个人收藏-分页", "summary": "个人收藏-分页 • 接口返回结果包含 表情收藏列表 和 消息收藏列表 。", "method": "/msg/syncCollectionMsg", "category": [ "API参考", "基础能力", "个人模块" ], "docFile": "个人收藏-分页.md", "tags": [ "基础能力", "个人收藏-分页", "msg", "个人模块", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "msgSeq", "in": "body", "type": "integer", "required": true, "desc": "分页使用，首次传0，下次传入返回值seq" }, { "name": "limit", "in": "body", "type": "integer", "required": true, "desc": "每页数量" } ], "responseHint": "data 字段：lastSeq（最后序号）；list（列表）" }, { "id": "msg.insertCollectionMsg", "module": "msg", "title": "个人收藏-添加GIF表情", "summary": "个人收藏-添加GIF表情 提示： 上传表情文件时，单文件大小不允许超过 1MB ，超出限制会导致添加失败", "method": "/msg/insertCollectionMsg", "category": [ "API参考", "基础能力", "个人模块" ], "docFile": "个人收藏-添加GIF表情.md", "tags": [ "基础能力", "个人收藏-添加GIF表情", "msg", "个人模块", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "msgData", "in": "body", "type": "object", "required": true, "desc": "消息数据", "children": [ { "name": "fileMd5", "in": "body", "type": "string", "required": true, "desc": "图片md5" }, { "name": "fileHttpUrl", "in": "body", "type": "string", "required": true, "desc": "接口详情见: 文件CDN转URL" } ] }, { "name": "type", "in": "body", "type": "integer", "required": true, "desc": "类型编号。" } ] }, { "id": "label.editLabel", "module": "label", "title": "个人标签-增删改", "summary": "个人标签-增删改 对个人标签进行新增、修改或删除操作。", "method": "/label/editLabel", "category": [ "API参考", "客户管理", "标签模块" ], "docFile": "个人标签-增删改.md", "tags": [ "label", "标签模块", "个人标签-增删改", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "opType", "in": "body", "type": "integer", "required": true, "desc": "1 新建标签， 此时必须设置 labelName 和 labelSuperId;2 删除标签，此时必须设置 labelId;3 修改标签， 此时必须设置 labelId 和 labelName,labelSuperId;" }, { "name": "paramList", "in": "body", "type": "array", "required": true, "desc": "Param列表", "children": [ { "name": "labelId", "in": "body", "type": "string", "required": false, "desc": "标签ID" }, { "name": "labelSuperId", "in": "body", "type": "string", "required": false, "desc": "个人标签所属的分组ID" }, { "name": "labelName", "in": "body", "type": "string", "required": false, "desc": "标签名称" } ] } ] }, { "id": "cloud.wxDownload", "module": "cloud", "title": "个微文件下载", "summary": "个微文件下载 - 下载地址为临时云资源，非官方CDN，7–15天不定期清理，请及时下载。", "method": "/cloud/wxDownload", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "个微文件下载.md", "tags": [ "个微文件下载", "文件与媒体（下载", "上传）", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAeskey", "in": "body", "type": "string", "required": true, "desc": "文件Aeskey" }, { "name": "fileAuthkey", "in": "body", "type": "string", "required": true, "desc": "文件Authkey" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "1: 大图. 如果【接收图片消息】中的字段 image_has_hd=1,或者fileBigHttpUrl有值， 则可以使用这个type下载2: 小图. 如果image_has_hd=0，或者fileMiddleHttpUrl有值, 则应该用这个type下载3: 视频/图片缩略图，对应thumb这个字段4: 视频5: 文件/语音文件" }, { "name": "fileUrl", "in": "body", "type": "string", "required": true, "desc": "文件链接" } ], "responseHint": "data 字段：cloudUrl（云端文件地址。）" }, { "id": "cloud.wxDownloadAsync", "module": "cloud", "title": "个微文件异步下载", "summary": "个微文件异步下载 - 下载地址为临时云资源，非官方CDN，7–15天不定期清理，请及时下载。• 异步下载结果通过回调通知，详情查阅回调结构说明中的 API 异步消息响应。• 根据回调返回的 requestId 值查询，requestId 一致即为对应下载结果。", "method": "/cloud/wxDownloadAsync", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "个微文件异步下载.md", "tags": [ "文件与媒体（下载", "上传）", "个微文件异步下载", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAeskey", "in": "body", "type": "string", "required": true, "desc": "文件Aeskey" }, { "name": "fileAuthkey", "in": "body", "type": "string", "required": true, "desc": "文件Authkey" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "1: 大图. 如果【接收图片消息】中的字段 image_has_hd=1,或者fileBigHttpUrl有值， 则可以使用这个type下载2: 小图. 如果image_has_hd=0，或者fileMiddleHttpUrl有值, 则应该用这个type下载3: 视频/图片缩略图，对应thumb这个字段4: 视频5: 文件/语音文件" }, { "name": "fileUrl", "in": "body", "type": "string", "required": true, "desc": "文件链接" } ], "responseHint": "data 字段：requestId（请使用requestId 去消息回调中获取文件地址）" }, { "id": "login.verifyLoginQrcode", "module": "login", "title": "二维码-code验证（步骤4）", "summary": "二维码-code验证收到 6 位验证码后，调用本接口完成校验。 收到6位数验证码，执行此接口验证• 验证码校验成功后，必须再次调用 二维码状态-检测（步骤3） 接口，此时状态码将变为 Status=2，代表登录成功。", "method": "/login/verifyLoginQrcode", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "二维码-code验证（步骤4）.md", "tags": [ "基础能力", "二维码-code验证（步骤4）", "登录模块", "login", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "code", "in": "body", "type": "string", "required": true, "desc": "手机端 6 位验证码。" } ] }, { "id": "login.getLoginQrcode", "module": "login", "title": "二维码-获取（步骤2）", "summary": "二维码-获取 获取登录二维码及 loginQrcodeKey，供手机企微扫码完成设备绑定。 • 首次登录：请使用参数 useCache=false，获取全新二维码。 • 旧设备异常：提示设备不存在/不在线时，先调用恢复设备接口，再获取二维码。 • 恢复设备后：请使用参数 useCache=true，获取缓存二维码。", "method": "/login/getLoginQrcode", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "二维码-获取（步骤2）.md", "tags": [ "基础能力", "登录模块", "login", "二维码-获取（步骤2）", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "useCache", "in": "body", "type": "boolean", "required": true, "desc": "是否使用缓存二维码，首次登录传 false。" } ], "responseHint": "data 字段：loginQrcodeBase64Data（二维码 Base64 图片。）；loginQrcodeKey（二维码key）" }, { "id": "login.checkLoginQrCode", "module": "login", "title": "二维码状态-检测（步骤3）", "summary": "二维码状态-检测 获取二维码后，需轮询调用本接口，实时获取用户的扫码进度。 核心逻辑 • 请求频率：建议轮询间隔 2-3 秒，避免请求过于频繁。 • 生命周期：从“获取二维码”开始，到“登录成功/失败”结束。超时将报错。", "method": "/login/checkLoginQrCode", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "二维码状态-检测（步骤3）.md", "tags": [ "基础能力", "登录模块", "二维码状态-检测（步骤3）", "login", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ], "responseHint": "data 字段：corpId（企业 ID。）；corpLogo（企业 Logo URL。）；loginQrcodeKey（二维码 Key）；loginQrcodeStatus（扫码状态：-1 未登陆，需要扫码登陆 · 0 未登陆，可免扫码登陆 · 1 已扫码待确认 · 2 登陆成功 · 4 用户取消登陆 · 10 已扫码确认，待检测6位验证码）；nickname（昵称）；userId（用户id）；avatarUrl（头像 URL。）" }, { "id": "cloud.cdnBigFileUploadByUrlAsync", "module": "cloud", "title": "企微大文件异步上传", "summary": "企微大文件异步上传 - 异步上传结果通过回调通知，详情查阅回调结构说明中的 API 异步消息响应。• 根据回调返回的 requestId 值查询，requestId 一致即为对应上传结果。", "method": "/cloud/cdnBigFileUploadByUrlAsync", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "企微大文件异步上传.md", "tags": [ "文件与媒体（下载", "企微大文件异步上传", "上传）", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true }, { "name": "filename", "in": "body", "type": "string", "required": true }, { "name": "fileUrl", "in": "body", "type": "string", "required": true }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "22大视频 35文件" } ], "responseHint": "data 字段：requestId（请求Id）" }, { "id": "cloud.wxWorkDownload", "module": "cloud", "title": "企微文件下载", "summary": "企微文件下载 - 下载地址为临时云资源，非官方CDN，7–15天不定期清理，请及时下载。", "method": "/cloud/wxWorkDownload", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "企微文件下载.md", "tags": [ "文件与媒体（下载", "企微文件下载", "上传）", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAeskey", "in": "body", "type": "string", "required": true, "desc": "文件Aeskey" }, { "name": "fileId", "in": "body", "type": "string", "required": true, "desc": "文件 ID" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "文件类型编号。" } ], "responseHint": "data 字段：cloudUrl（云端文件地址。）" }, { "id": "cloud.cdnUploadByUrlAsync", "module": "cloud", "title": "企微文件异步上传", "summary": "企微文件异步上传 - 异步上传结果通过回调通知，详情查阅回调结构说明中的 API 异步消息响应。• 根据回调返回的 requestId 值查询，requestId 一致即为对应上传结果。", "method": "/cloud/cdnUploadByUrlAsync", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "企微文件异步上传.md", "tags": [ "文件与媒体（下载", "企微文件异步上传", "上传）", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "filename", "in": "body", "type": "string", "required": true, "desc": "文件名称" }, { "name": "fileUrl", "in": "body", "type": "string", "required": true, "desc": "文件url地址" }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "1: jpg图片4: mp4视频5: 文件(也包括语音silk文件)" } ], "responseHint": "data 字段：requestId（请求Id）" }, { "id": "cloud.wxWorkDownloadAsync", "module": "cloud", "title": "企微文件异步下载", "summary": "企微文件异步下载 - 下载地址为临时云资源，非官方CDN，7–15天不定期清理，请及时下载。• 异步下载结果通过回调通知，详情查阅回调结构说明中的 API 异步消息响应。• 根据回调返回的 requestId 值查询，requestId 一致即为对应下载结果。", "method": "/cloud/wxWorkDownloadAsync", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "企微文件异步下载.md", "tags": [ "文件与媒体（下载", "企微文件异步下载", "上传）", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAeskey", "in": "body", "type": "string", "required": true, "desc": "文件Aeskey" }, { "name": "fileId", "in": "body", "type": "string", "required": true, "desc": "文件 ID" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "1: 大图. 如果【接收图片消息】中的字段 image_has_hd=1, 则可以使用这个type下载2: 小图. 如果image_has_hd=0, 则应该用这个type下载3: 视频/图片缩略图，对应thumb这个字段4: 视频5: 文件/语音文件" } ], "responseHint": "data 字段：requestId（请使用requestId 去消息回调中获取文件地址）" }, { "id": "session.getSessionPage", "module": "session", "title": "会话分页", "summary": "会话分页 分页查询会话列表，包含单聊与群聊会话。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/session/getSessionPage", "category": [ "API参考", "会话与消息", "会话模块" ], "docFile": "会话分页.md", "tags": [ "会话与消息", "会话模块", "session", "会话分页", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "currentSeq", "in": "body", "type": "integer", "required": true, "desc": "暂时不支持。分页使用，首次传0，下次传入返回值currentSeq" } ], "responseHint": "data 字段：currentSeq（下次请求时应传入的currentSeq）；hasMore（是否有更多）；sessionCount（会话数量）；sessionList（会话列表）" }, { "id": "session.getSessionList", "module": "session", "title": "会话组-查询", "summary": "会话组-查询 查询会话分组列表及每个分组下的会话归属。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/session/getSessionList", "category": [ "API参考", "会话与消息", "会话模块" ], "docFile": "会话组-查询.md", "tags": [ "会话与消息", "会话模块", "session", "会话组-查询", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ], "responseHint": "data 字段：collectList（通讯录列表）；shieldList（免打扰列表）；topList（置顶列表）；markList（标记列表）" }, { "id": "session.setSessionCmd", "module": "session", "title": "会话组-编辑", "summary": "会话组-编辑 创建、修改或删除会话分组，整理会话列表结构。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/session/setSessionCmd", "category": [ "API参考", "会话与消息", "会话模块" ], "docFile": "会话组-编辑.md", "tags": [ "会话与消息", "会话组-编辑", "会话模块", "session", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "chatId", "in": "body", "type": "string", "required": true, "desc": "会话id" }, { "name": "chatType", "in": "body", "type": "integer", "required": true, "desc": "1: 置顶 2: 取消置顶 3: 开启免打扰 4: 取消免打扰 5: 保存群聊到通讯录 6: 从通讯录移除群聊 7: 标记 8:取消标记" } ] }, { "id": "msg.statusModify", "module": "msg", "title": "修改消息状态", "summary": "修改消息状态 批量查询朋友圈动态的详细内容，包括图片、视频与互动信息。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/statusModify", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "修改消息状态.md", "tags": [ "修改消息状态", "会话与消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "chatId", "in": "body", "type": "string", "required": true, "desc": "会话id，=sessionId" }, { "name": "modifyType", "in": "body", "type": "integer", "required": true, "desc": "1: 标记为已读 2: 标记为未读 3: 清空聊天记录 4: 从聊天列表删除该聊天" } ] }, { "id": "room.modifyRoomNotice", "module": "room", "title": "修改群公告", "summary": "修改群公告 修改指定群聊的公告内容。", "method": "/room/modifyRoomNotice", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "修改群公告.md", "tags": [ "修改群公告", "群模块", "room", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "notice", "in": "body", "type": "string", "required": true, "desc": "群公告。" } ] }, { "id": "room.modifyRoomNickname", "module": "room", "title": "修改群内昵称", "summary": "修改群内昵称 修改当前账号在指定群内的显示昵称。", "method": "/room/modifyRoomNickname", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "修改群内昵称.md", "tags": [ "群模块", "room", "修改群内昵称", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "nickname", "in": "body", "type": "string", "required": true, "desc": "用户昵称。" } ] }, { "id": "room.modifyRoomName", "module": "room", "title": "修改群名称", "summary": "修改群名称 修改指定群聊的名称。", "method": "/room/modifyRoomName", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "修改群名称.md", "tags": [ "群模块", "room", "客户管理", "修改群名称", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "name", "in": "body", "type": "string", "required": true, "desc": "名称" } ] }, { "id": "room.modifyRoomRemarkName", "module": "room", "title": "修改群备注", "summary": "修改群备注 群备注仅自己可见", "method": "/room/modifyRoomRemarkName", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "修改群备注.md", "tags": [ "群模块", "room", "修改群备注", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "remarkName", "in": "body", "type": "string", "required": true, "desc": "备注名称" } ] }, { "id": "client.stopClient", "module": "client", "title": "停用设备", "summary": "停用设备 设备切换 如需更换新设备或重新开始流程，请遵循 “先停再建” 原则：• 第一步：停用设备 调用「停用设备」接口，释放当前占用的资源。• 第二步：创建设备 调用 创建设备（步骤1） 接口，初始化全新的设备环境。", "method": "/client/stopClient", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "停用设备.md", "tags": [ "基础能力", "登录模块", "client", "停用设备", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ] }, { "id": "contact.updateWxWorkContact", "module": "contact", "title": "内部联系人信息-更新", "summary": "内部联系人信息-更新 更新内部联系人的备注等资料信息。", "method": "/contact/updateWxWorkContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "内部联系人信息-更新.md", "tags": [ "contact", "联系人模块", "客户管理", "内部联系人信息-更新", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" }, { "name": "remark", "in": "body", "type": "string", "required": true, "desc": "备注名。" }, { "name": "desc", "in": "body", "type": "string", "required": true, "desc": "描述" } ] }, { "id": "contact.getWxWorkContactList", "module": "contact", "title": "内部联系人分页", "summary": "内部联系人分页 分页拉取企业内部联系人（同事）列表。", "method": "/contact/getWxWorkContactList", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "内部联系人分页.md", "tags": [ "contact", "内部联系人分页", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "clientVersion", "in": "body", "type": "string", "required": true, "desc": "客户端版本号。" }, { "name": "limit", "in": "body", "type": "integer", "required": true, "desc": "每页数量" } ], "responseHint": "data 字段：contactCount（联系人数量）；contactList（联系人列表）；currentVersion（下次请求时应传入的currentVersion）；hasMore（是否有更多）" }, { "id": "label.syncLabelList", "module": "label", "title": "列表分页", "summary": "列表分页 分页查询列表数据。", "method": "/label/syncLabelList", "category": [ "API参考", "客户管理", "标签模块" ], "docFile": "列表分页.md", "tags": [ "label", "标签模块", "客户管理", "列表分页", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "currentSeq", "in": "body", "type": "integer", "required": true, "desc": "分页使用，首次传0，下次传入返回值currentSeq" }, { "name": "labelType", "in": "body", "type": "integer", "required": true, "desc": "1 企业标签 =2 个人标签" } ], "responseHint": "data 字段：currentSeq（下次请求时应传入的currentSeq）；hasMore（是否有更多）；labelCount（标签数量）；labelList（标签列表）" }, { "id": "room.createRoom", "module": "room", "title": "创建群", "summary": "创建群 创建新的群聊。", "method": "/room/createRoom", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "创建群.md", "tags": [ "群模块", "room", "客户管理", "创建群", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "isOuterRoom", "in": "body", "type": "integer", "required": true, "desc": "是否外部群" }, { "name": "memberList", "in": "body", "type": "array", "required": true, "desc": "成员列表。" } ], "responseHint": "data 字段：memberList（群成员列表）；roomCreatetime（创建时间）；roomCreatorId（创建人id）；roomId（群id）" }, { "id": "client.createClient", "module": "client", "title": "创建设备（步骤1）", "summary": "创建设备 — 获取虚拟设备实例 通过该接口创建一个企业微信云设备实例，返回 guid（设备唯一标识）。后续所有操作（扫码登录、收发消息等）均依赖此 guid。 重要：创建/恢复设备后 5 分钟内未完成登录，该实例将自动清理。代理地区务必与企微手机登录所在地一致，严禁异省，否则可能导致登录失败。", "method": "/client/createClient", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "创建设备（步骤1）.md", "tags": [ "基础能力", "登录模块", "创建设备（步骤1）", "client", "API参考" ], "params": [ { "name": "proxyUrl", "in": "body", "type": "string", "required": false, "desc": "- **网络方式2：自定义代理ip** 格式必须为: socks5://user:password@ip:port，如无验证直接写地址即可。目前只支持socks5。 示例：socks5://root:123456@192.168.88.242:1080" }, { "name": "areaCode", "in": "body", "type": "integer", "required": false, "desc": "- **网络方式1：使用地区ID** 110000：北京市 | 120000：天津市 | 130000：河北省 | 140000：山西省 150000：内蒙古 | 210000：辽宁省 | 220000：吉林省 | 230000：黑龙江省 310000：上海市 | 320000：江苏省 | 330000：浙江省 | 340000：安徽省 350000：福建省 | 360000：江西省 | 370000：山东省 | 410000：河南省 420000：湖北省 | 430000：湖南省 | 440000：广东省 | 450000：广 西 460000：海南省 | 500000：重庆市 | 510000：四川省 | 520000：贵州省 530000：云南省 | 540000：西 藏 | 610000：陕西省 | 620000：甘肃省 630000：青海省 | 640000：宁 夏 | 650000：新 疆" }, { "name": "deviceName", "in": "body", "type": "string", "required": true, "desc": "用于在控制台辨识不同设备，如「张三的iPad" }, { "name": "deviceType", "in": "body", "type": "integer", "required": true, "desc": "设备类型：0 = iPad（推荐），2 = Windows" }, { "name": "clientVersion", "in": "body", "type": "string", "required": true, "desc": "客户端版本由 Fmode 服务自动选择，通常无需填写。" } ], "responseHint": "data 字段：guid（参数 guid）" }, { "id": "sns.deleteSns", "module": "sns", "title": "删除朋友圈", "summary": "删除朋友圈 删除指定朋友圈动态。", "method": "/sns/deleteSns", "category": [ "API参考", "媒体与运营", "朋友圈模块" ], "docFile": "删除朋友圈.md", "tags": [ "sns", "朋友圈模块", "删除朋友圈", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "snsId", "in": "body", "type": "number", "required": true, "desc": "朋友圈Id" } ] }, { "id": "contact.deleteContact", "module": "contact", "title": "删除联系人", "summary": "删除联系人 删除指定联系人，解除好友关系或从列表中移除。", "method": "/contact/deleteContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "删除联系人.md", "tags": [ "contact", "联系人模块", "删除联系人", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" } ] }, { "id": "msg.sendGif", "module": "msg", "title": "发送GIF表情消息", "summary": "发送GIF表情消息 发送GIF表情步骤方法一： GIF图片上传：调用 文件上传 接口。 获取GIF的CdnUrl：调用 文件CDN转URL 接口。 发送GIF表情步骤方法二： 获取收藏表情列表：通过调用 收藏分页 API，过滤出 表情收藏列表 。", "method": "/msg/sendGif", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送GIF表情消息.md", "tags": [ "会话与消息", "发送GIF表情消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "wxFileUrl", "in": "body", "type": "string", "required": true, "desc": "Wx文件链接" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（是否发送成功）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendPersonalCard", "module": "msg", "title": "发送名片消息", "summary": "发送名片消息 取消群内置顶消息。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendPersonalCard", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送名片消息.md", "tags": [ "会话与消息", "发送名片消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "sharedId", "in": "body", "type": "string", "required": true, "desc": "要分享的好友id" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendImage", "module": "msg", "title": "发送图片消息", "summary": "发送图片消息 图片格式 JPG 图片消息参数：通过接口 文件上传 或 文件上传-URL 获取发送图片参数。也可通过回调获取相应参数。", "method": "/msg/sendImage", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送图片消息.md", "tags": [ "发送图片消息", "会话与消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAesKey", "in": "body", "type": "string", "required": true, "desc": "文件密钥" }, { "name": "fileId", "in": "body", "type": "string", "required": true, "desc": "文件id" }, { "name": "fileMd5", "in": "body", "type": "string", "required": true, "desc": "文件md5值" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "filename", "in": "body", "type": "string", "required": true, "desc": "文件名称" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendLocation", "module": "msg", "title": "发送定位消息", "summary": "发送定位消息 查询群发任务的执行状态与发送结果。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendLocation", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送定位消息.md", "tags": [ "会话与消息", "msg", "发送定位消息", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "title", "in": "body", "type": "string", "required": true, "desc": "标题" }, { "name": "address", "in": "body", "type": "string", "required": true, "desc": "地址" }, { "name": "latitude", "in": "body", "type": "number", "required": true, "desc": "纬度" }, { "name": "longitude", "in": "body", "type": "number", "required": true, "desc": "经度" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendWeapp", "module": "msg", "title": "发送小程序消息", "summary": "发送小程序消息 将指定消息设为群内置顶，方便成员查看重要通知。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendWeapp", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送小程序消息.md", "tags": [ "发送小程序消息", "会话与消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "appId", "in": "body", "type": "string", "required": true, "desc": "小程序appid" }, { "name": "coverFileAesKey", "in": "body", "type": "string", "required": true, "desc": "封面文件AesKey" }, { "name": "coverFileId", "in": "body", "type": "string", "required": true, "desc": "封面图id" }, { "name": "coverFileSize", "in": "body", "type": "integer", "required": true, "desc": "封面图大小" }, { "name": "desc", "in": "body", "type": "string", "required": true, "desc": "描述" }, { "name": "pagePath", "in": "body", "type": "string", "required": true, "desc": "小程序页面路径。" }, { "name": "thumbUrl", "in": "body", "type": "string", "required": true, "desc": "缩略图 URL。" }, { "name": "title", "in": "body", "type": "string", "required": true, "desc": "标题" }, { "name": "username", "in": "body", "type": "string", "required": true, "desc": "账号原始id" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendFile", "module": "msg", "title": "发送文件消息", "summary": "发送纯文本消息 向指定联系人或群聊发送文件。发送前请确认接收方 ID（toId 或 roomId）正确。", "method": "/msg/sendFile", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送文件消息.md", "tags": [ "会话与消息", "发送文件消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAesKey", "in": "body", "type": "string", "required": true, "desc": "大文件时，可为空；否则必填" }, { "name": "fileId", "in": "body", "type": "string", "required": true, "desc": "文件id" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "filename", "in": "body", "type": "string", "required": true, "desc": "文件名称" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "sns.postSns", "module": "sns", "title": "发送朋友圈", "summary": "发送朋友圈 • 支持文本 + 图片/视频/视频号/链接等类型的发送，其中图片一次可以发送多个。• 图片/视频/视频号/链接，每次发送最多只能选择其中的一种类型。", "method": "/sns/postSns", "category": [ "API参考", "媒体与运营", "朋友圈模块" ], "docFile": "发送朋友圈.md", "tags": [ "sns", "朋友圈模块", "发送朋友圈", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "postType", "in": "body", "type": "integer", "required": true, "desc": "0图片/视频，1链接/视频号" }, { "name": "content", "in": "body", "type": "string", "required": true, "desc": "消息内容" }, { "name": "visibleUserIdList", "in": "body", "type": "array", "required": true, "desc": "指定好友可见。可不传，此时全部好友可见" }, { "name": "mediaList", "in": "body", "type": "array", "required": true, "desc": "Media列表", "children": [ { "name": "fileType", "in": "body", "type": "integer", "required": false, "desc": "1：图片2: 视频 【注:如果发送视频，则 media_list 必须携带视频缩略图的参数，成对】3: 视频缩略图" }, { "name": "fileSize", "in": "body", "type": "integer", "required": false, "desc": "文件大小" }, { "name": "fileId", "in": "body", "type": "string", "required": false, "desc": "文件id" }, { "name": "videoLength", "in": "body", "type": "integer", "required": false }, { "name": "fileWidth", "in": "body", "type": "integer", "required": false, "desc": "文件宽度" }, { "name": "fileHeight", "in": "body", "type": "integer", "required": false, "desc": "文件高度" } ] }, { "name": "linkInfo", "in": "body", "type": "object", "required": false, "desc": "postType=1时必填；=0时置空即可", "children": [ { "name": "title", "in": "body", "type": "string", "required": false, "desc": "视频号消息回调=channelName" }, { "name": "contentUrl", "in": "body", "type": "string", "required": false, "desc": "消息链接" }, { "name": "wxFinderInfo", "in": "body", "type": "object", "required": false, "desc": "视频号信息", "children": [ { "name": "desc", "in": "body", "type": "string", "required": true, "desc": "视频号消息回调=channelName，or自定义" }, { "name": "coverUrl", "in": "body", "type": "string", "required": true, "desc": "视频号消息回调=coverUrl，or自定义" }, { "name": "thumbUrl", "in": "body", "type": "string", "required": true, "desc": "视频号消息回调=coverUrl，or自定义" }, { "name": "extras", "in": "body", "type": "string", "required": true, "desc": "视频号消息回调=encodeData" }, { "name": "feedId", "in": "body", "type": "string", "required": true, "desc": "视频号消息回调=feedId" }, { "name": "feedNo", "in": "body", "type": "string", "required": true, "desc": "视频号消息回调=feedNo" }, { "name": "avatar", "in": "body", "type": "string", "required": true, "desc": "视频号消息回调=headImgUrl" }, { "name": "nickname", "in": "body", "type": "string", "required": true, "desc": "视频号消息回调=headImgUrl" }, { "name": "feedType", "in": "body", "type": "integer", "required": true, "desc": "视频号=4" } ] } ] } ], "responseHint": "data 字段：snsDetail（朋友圈Detail）；totalSendCount（总数发送数量）" }, { "id": "msg.sendHyperText", "module": "msg", "title": "发送混合文本消息", "summary": "发送纯文本消息 向指定联系人或群聊发送混合文本。发送前请确认接收方 ID（toId 或 roomId）正确。", "method": "/msg/sendHyperText", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送混合文本消息.md", "tags": [ "会话与消息", "发送混合文本消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "content", "in": "body", "type": "array", "required": true, "desc": "消息内容", "children": [ { "name": "subtype", "in": "body", "type": "integer", "required": false, "desc": "=0表示普通文本 =1表示@具体人，text为对方的userId, 当送0时为@所有人 =2表示系统表情 eg:[微笑][憨笑]" }, { "name": "text", "in": "body", "type": "string", "required": false } ] }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendText", "module": "msg", "title": "发送纯文本消息", "summary": "发送纯文本消息 向指定联系人或群聊发送纯文本。发送前请确认接收方 ID（toId 或 roomId）正确。", "method": "/msg/sendText", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送纯文本消息.md", "tags": [ "会话与消息", "msg", "消息模块 ", "发送纯文本消息", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "content", "in": "body", "type": "string", "required": true, "desc": "消息内容" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" }, { "name": "isNoNeedRead", "in": "body", "type": "boolean", "required": true, "desc": "是否禁止回执，默认不禁止 false(true/false)" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendFeedVideo", "module": "msg", "title": "发送视频号消息", "summary": "发送视频号消息 通过群发助手向多个客户批量发送消息，适用于营销通知等场景。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendFeedVideo", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送视频号消息.md", "tags": [ "发送视频号消息", "会话与消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "channelName", "in": "body", "type": "string", "required": true, "desc": "频道名称" }, { "name": "channelUrl", "in": "body", "type": "string", "required": true, "desc": "频道链接" }, { "name": "coverUrl", "in": "body", "type": "string", "required": true, "desc": "封面链接" }, { "name": "encodeData", "in": "body", "type": "string", "required": true, "desc": "编码数据" }, { "name": "headImgUrl", "in": "body", "type": "string", "required": true, "desc": "头像图片链接" }, { "name": "feedId", "in": "body", "type": "string", "required": true, "desc": "动态Id" }, { "name": "feedNo", "in": "body", "type": "string", "required": true, "desc": "动态编号" }, { "name": "username", "in": "body", "type": "string", "required": true, "desc": "用户名" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（是否发送成功）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendVideo", "module": "msg", "title": "发送视频消息", "summary": "发送视频消息 MP4格式", "method": "/msg/sendVideo", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送视频消息.md", "tags": [ "会话与消息", "发送视频消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAesKey", "in": "body", "type": "string", "required": true, "desc": "fileId包含*字符时非必须，为空即可" }, { "name": "fileId", "in": "body", "type": "string", "required": true, "desc": "文件 ID" }, { "name": "fileMd5", "in": "body", "type": "string", "required": true, "desc": "文件md5值" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "filename", "in": "body", "type": "string", "required": true, "desc": "文件名称" }, { "name": "coverImageSize", "in": "body", "type": "integer", "required": true, "desc": "封面图片尺寸" }, { "name": "duration", "in": "body", "type": "integer", "required": true, "desc": "时长（秒）。" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" }, { "name": "previewImgUrl", "in": "body", "type": "string", "required": true, "desc": "fileId包含*字符时上送，否则为空即可" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendVoice", "module": "msg", "title": "发送语音消息", "summary": "发送语音消息 修改消息的已读/未读等状态标记。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendVoice", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送语音消息.md", "tags": [ "会话与消息", "发送语音消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAesKey", "in": "body", "type": "string", "required": true, "desc": "文件密钥" }, { "name": "fileId", "in": "body", "type": "string", "required": true, "desc": "文件id" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "voiceTime", "in": "body", "type": "integer", "required": true, "desc": "Voice时间" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "msg.sendLink", "module": "msg", "title": "发送链接消息", "summary": "发送链接消息 查询指定群聊的置顶消息列表。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendLink", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "发送链接消息.md", "tags": [ "会话与消息", "发送链接消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "title", "in": "body", "type": "string", "required": true, "desc": "标题" }, { "name": "iconUrl", "in": "body", "type": "string", "required": true, "desc": "图标链接" }, { "name": "linkUrl", "in": "body", "type": "string", "required": true, "desc": "链接链接" }, { "name": "desc", "in": "body", "type": "string", "required": true, "desc": "描述" }, { "name": "toId", "in": "body", "type": "string", "required": true, "desc": "接收方 ID，联系人传 userId，群聊传 roomId。" } ], "responseHint": "data 字段：isSendSuccess（是否发送成功）；msgServerId（消息id，用于撤回消息）；msgType（消息类型）；msgUniqueIdentifier（消息唯一标识）；seq（消息序号）；timestamp（时间戳）" }, { "id": "room.roomRemoveAdmin", "module": "room", "title": "取消群管理员", "summary": "取消群管理员 取消群聊管理员身份。", "method": "/room/roomRemoveAdmin", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "取消群管理员.md", "tags": [ "群模块", "room", "取消群管理员", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "memberList", "in": "body", "type": "array", "required": true, "desc": "成员列表。" } ] }, { "id": "contact.agreeContact", "module": "contact", "title": "同意申请", "summary": "同意申请 同意好友或入群等相关申请。", "method": "/contact/agreeContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "同意申请.md", "tags": [ "contact", "联系人模块", "客户管理", "同意申请", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" }, { "name": "corpId", "in": "body", "type": "string", "required": false, "desc": "企业 ID。" } ] }, { "id": "msg.syncMsg", "module": "msg", "title": "同步历史消息分页", "summary": "同步历史消息分页 为外部联系人添加或移除客户标签，用于客户分层管理。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/syncMsg", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "同步历史消息分页.md", "tags": [ "同步历史消息分页", "会话与消息", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "msgSeq", "in": "body", "type": "integer", "required": true, "desc": "分页使用，首次传0，下次传入返回值msgSeq" }, { "name": "limit", "in": "body", "type": "integer", "required": true, "desc": "每页数量" } ], "responseHint": "data 字段：hasMore（是否有更多）；syncMsgList（Sync消息列表）；travelSyncKey（同步 Key）" }, { "id": "contact.updateWxContact", "module": "contact", "title": "外部联系人信息-更新", "summary": "外部联系人信息-更新 更新外部联系人的备注、标签等可编辑信息。", "method": "/contact/updateWxContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "外部联系人信息-更新.md", "tags": [ "contact", "联系人模块", "客户管理", "外部联系人信息-更新", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" }, { "name": "remark", "in": "body", "type": "string", "required": true, "desc": "备注名。" }, { "name": "desc", "in": "body", "type": "string", "required": true, "desc": "描述" }, { "name": "mobileList", "in": "body", "type": "array", "required": true, "desc": "手机号列表" } ] }, { "id": "contact.getWxContactList", "module": "contact", "title": "外部联系人分页", "summary": "外部联系人分页 通过查询 外部联系人分页 获取 userid ，再调用 联系人详情 - 批量 接口进行查询联系人信息。 查询后保存 ，不用一直调用，后续可以根据回调保存数据", "method": "/contact/getWxContactList", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "外部联系人分页.md", "tags": [ "contact", "外部联系人分页", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "currentSeq", "in": "body", "type": "integer", "required": true, "desc": "联系人比较多时，可以用此字段分页查询。首次传0，之后传上一次查询返回的值; 传这个值可以只拉取出现变更的好友;" }, { "name": "limit", "in": "body", "type": "integer", "required": true, "desc": "每页数量" }, { "name": "bizType", "in": "body", "type": "integer", "required": true, "desc": "1、外部联系人信息变动的数据 2、好友申请的数据 收到好友申请通知时，需要通过这个值来拉取好友申请通知。" } ], "responseHint": "data 字段：currentSeq（下次请求时应传入的currentSeq）；contactCount（联系人数量）；hasMore（是否有更多）；contactList（联系人列表）" }, { "id": "label.contactEditLabel", "module": "label", "title": "客户标签-增删", "summary": "客户标签-增删 客户标签说明 客户标签分为两类：企业标签、个人标签。 请求参数 labelIdList 、 labelSuperIdList 、 labelOwnerList 必须一一对应，且数组长度必须保持一致。", "method": "/label/contactEditLabel", "category": [ "API参考", "客户管理", "标签模块" ], "docFile": "客户标签-增删.md", "tags": [ "客户标签-增删", "label", "标签模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "opType", "in": "body", "type": "integer", "required": true, "desc": "1:增加成员 2:删除成员" }, { "name": "paramList", "in": "body", "type": "array", "required": true, "desc": "Param列表", "children": [ { "name": "labelIdList", "in": "body", "type": "array", "required": false, "desc": "标签id列表" }, { "name": "labelSuperIdList", "in": "body", "type": "array", "required": false, "desc": "个人标签所属的分组ID" }, { "name": "labelOwnerList", "in": "body", "type": "array", "required": false, "desc": "个人标签送标签创建人userId，企业标签送corpId" }, { "name": "userId", "in": "body", "type": "string", "required": false, "desc": "用户id" } ] } ] }, { "id": "room.enableChangeRoomName", "module": "room", "title": "开启群改名", "summary": "开启群改名 设置是否允许群成员修改群名称。", "method": "/room/enableChangeRoomName", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "开启群改名.md", "tags": [ "群模块", "room", "客户管理", "开启群改名", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "newFlag", "in": "body", "type": "integer", "required": true, "desc": "从群详情/或群成员变动API中获取，注意区别roomFlag与roomNewFlag" }, { "name": "disable", "in": "body", "type": "boolean", "required": true, "desc": "是否开启" } ] }, { "id": "room.openInviteConfirm", "module": "room", "title": "开启群邀请确认", "summary": "开启群邀请确认 提示： roomFlag 传错可能导致群其它状态错乱", "method": "/room/openInviteConfirm", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "开启群邀请确认.md", "tags": [ "群模块", "room", "开启群邀请确认", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "isOpen", "in": "body", "type": "boolean", "required": true, "desc": "是否开启" }, { "name": "roomFlag", "in": "body", "type": "integer", "required": true, "desc": "群原Flag，可通过群分页或群详情接口获取" } ] }, { "id": "client.restoreClient", "module": "client", "title": "恢复设备", "summary": "恢复设备 • 离线后先调用此接口恢复设备，在调用二维码-获取（步骤2）进行登录扫码操作", "method": "/client/restoreClient", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "恢复设备.md", "tags": [ "基础能力", "恢复设备", "登录模块", "client", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ] }, { "id": "room.agreeInviteByLink", "module": "room", "title": "接受群邀请-By链接", "summary": "接受群邀请-By链接 通过群邀请链接加入群聊。", "method": "/room/agreeInviteByLink", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "接受群邀请-By链接.md", "tags": [ "群模块", "room", "客户管理", "接受群邀请-By链接", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "joinCode", "in": "body", "type": "string", "required": true, "desc": "加入码" }, { "name": "joinType", "in": "body", "type": "integer", "required": true, "desc": "默认2，从回调处信息中获取" } ], "responseHint": "data 字段：status（Success/InviteTicketUsed）；roomId（Success时不为空）；vid（Vid 标识）" }, { "id": "msg.revokeMsg", "module": "msg", "title": "撤回消息", "summary": "撤回消息 查询群发助手可用规则与配额限制。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/revokeMsg", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "撤回消息.md", "tags": [ "会话与消息", "msg", "消息模块 ", "撤回消息", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "chatId", "in": "body", "type": "string", "required": true, "desc": "会话id，=sessionId" }, { "name": "msgServerId", "in": "body", "type": "integer", "required": true, "desc": "消息id" } ] }, { "id": "cloud.cdnWxDownload", "module": "cloud", "title": "文件CDN转URL", "summary": "文件CDN转URL - 返回响应地址是官方CDN地址", "method": "/cloud/cdnWxDownload", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "文件CDN转URL.md", "tags": [ "文件与媒体（下载", "上传）", "文件CDN转URL", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "fileAeskey", "in": "body", "type": "string", "required": true, "desc": "文件Aeskey" }, { "name": "fileId", "in": "body", "type": "string", "required": true, "desc": "文件 ID" }, { "name": "fileMd5", "in": "body", "type": "string", "required": true, "desc": "文件 MD5" } ], "responseHint": "data 字段：coverUrl（缩略图url）；fileUrl（原图url）；fileMd5（原图md5）" }, { "id": "cloud.cloudUpload", "module": "cloud", "title": "文件上传-SDK云存储", "summary": "文件上传-SDK云存储 此接口只是单纯将文件上传到sdk配置对象内容存储服务上，并不会和企业微信服务API交互！！！ 此接口上传数据只能做用短期临时存储，所有数据会定期全部清理", "method": "/cloud/cloudUpload", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "文件上传-SDK云存储.md", "tags": [ "文件上传-SDK云存储", "文件与媒体（下载", "上传）", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "实例id" }, { "name": "file", "in": "body", "type": "string", "required": true, "desc": "文件" } ], "apiPath": "/api/qw/doFileApi", "contentType": "multipart/form-data", "flatParams": true, "responseHint": "data 字段：cloudUrl（云端文件地址。）" }, { "id": "cloud.cdnBigUploadByUrl", "module": "cloud", "title": "文件上传-URL", "summary": "文件上传-URL 通过 URL 上传文件到云端，获取后续消息发送所需的文件标识。", "method": "/cloud/cdnBigUploadByUrl", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "文件上传-URL.md", "tags": [ "文件与媒体（下载", "上传）", "cloud", "文件上传-URL", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "filename", "in": "body", "type": "string", "required": true, "desc": "文件名" }, { "name": "fileUrl", "in": "body", "type": "string", "required": true, "desc": "文件链接" }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "1: jpg图片4: mp4视频5: 文件(也包括语音amr文件)" } ], "responseHint": "data 字段：fileId（文件 ID）；fileKey（文件Key）；fileMd5（文件 MD5）；fileSize（文件大小）；fileThumbSize（文件缩略图尺寸）；cloudUrl（云端文件地址。）；fileAesKey（文件密钥）；filename（文件名）" }, { "id": "sns.upload", "module": "sns", "title": "文件上传", "summary": "文件上传 调用 文件上传 完成相关操作。", "method": "/sns/upload", "category": [ "API参考", "媒体与运营", "朋友圈模块" ], "docFile": "文件上传.md", "tags": [ "sns", "朋友圈模块", "文件上传", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true }, { "name": "file", "in": "body", "type": "string", "required": true }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "文件类型1: 图片2: 视频3: 视频缩略图" } ], "apiPath": "/api/qw/doFileApi", "contentType": "multipart/form-data", "flatParams": true, "responseHint": "data 字段：fileId（文件 ID）；fileKey（文件Key）；fileMd5（文件md5值）；fileSize（文件大小）；cloudUrl（云端文件地址。）；fileConvertId（发送朋友圈消息、聊天消息时取此字段=fileId）；fileWidth（图片格式：jpg，png，gif 时有值）；fileHeight（图片格式：jpg，png，gif 时有值）；previewImgUrl（预览图片链接）；PreviewImgSize（预览图片尺寸）；duration（视频时长，单位：秒）" }, { "id": "user.setProfile", "module": "user", "title": "更新个人信息", "summary": "更新个人信息 修改当前账号的可编辑个人资料字段。", "method": "/user/setProfile", "category": [ "API参考", "基础能力", "个人模块" ], "docFile": "更新个人信息.md", "tags": [ "基础能力", "更新个人信息", "user", "个人模块", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "name", "in": "body", "type": "string", "required": true, "desc": "名字" }, { "name": "alias", "in": "body", "type": "string", "required": true, "desc": "别名" }, { "name": "email", "in": "body", "type": "string", "required": true, "desc": "邮箱" }, { "name": "mobile", "in": "body", "type": "string", "required": true, "desc": "手机号" }, { "name": "address", "in": "body", "type": "string", "required": true, "desc": "地址" }, { "name": "gender", "in": "body", "type": "integer", "required": true, "desc": "性别" } ] }, { "id": "sns.getSnsRecord", "module": "sns", "title": "朋友圈列表分页", "summary": "朋友圈列表分页 分页查询朋友圈动态列表。", "method": "/sns/getSnsRecord", "category": [ "API参考", "媒体与运营", "朋友圈模块" ], "docFile": "朋友圈列表分页.md", "tags": [ "sns", "朋友圈模块", "朋友圈列表分页", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "maxSeq", "in": "body", "type": "integer", "required": true, "desc": "查询 maxSeq 时间戳(毫秒) 之前发布的朋友圈；0：查全部" }, { "name": "limit", "in": "body", "type": "integer", "required": true, "desc": "每页数量" } ], "responseHint": "data 字段：snsDetailList（朋友圈Detail列表）" }, { "id": "cloud.cdnBigUpload", "module": "cloud", "title": "本地文件上传", "summary": "本地文件上传 提示： 上传文件超过2M，建议试用异步上传 :::", "method": "/cloud/cdnBigUpload", "category": [ "API参考", "媒体与运营", "文件与媒体（下载", "上传）" ], "docFile": "本地文件上传.md", "tags": [ "文件与媒体（下载", "本地文件上传", "上传）", "cloud", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "实例id" }, { "name": "file", "in": "body", "type": "string", "required": true, "desc": "文件" }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "1: jpg图片4: mp4视频5: 文件(也包括语音amr文件)" } ], "apiPath": "/api/qw/doFileApi", "contentType": "multipart/form-data", "flatParams": true, "responseHint": "data 字段：fileAesKey（文件密钥）；fileId（文件 ID）；fileKey（文件Key）；fileMd5（文件md5值）；fileSize（文件大小）；fileThumbSize（文件缩略图尺寸）；filename（文件名称）；cloudUrl（云端文件地址。）" }, { "id": "user.getCorpInfo", "module": "user", "title": "查询企业信息", "summary": "查询企业信息 查询当前账号所属企业的基本信息。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/user/getCorpInfo", "category": [ "API参考", "基础能力", "个人模块" ], "docFile": "查询企业信息.md", "tags": [ "基础能力", "user", "个人模块", "查询企业信息", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "corpIdList", "in": "body", "type": "array", "required": true, "desc": "默认为空时，查询当前账号企业" } ], "responseHint": "data 字段：corpAdminId（企业管理员Id）；corpCreateTime（创建时间）；corpFullName（企业主体名称）；corpId（企业ID）；corpName（企业全称）；corpOwnerName（企业负责人名称）；corpLogo（企业 Logo URL。）；corpDesc（企业描述）" }, { "id": "contact.addSearchWxContact", "module": "contact", "title": "添加个微", "summary": "添加个微 通过搜索结果，添加个人微信为外部联系人。", "method": "/contact/addSearchWxContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "添加个微.md", "tags": [ "contact", "联系人模块", "客户管理", "添加个微", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" }, { "name": "unionId", "in": "body", "type": "string", "required": true, "desc": "用户unionId" }, { "name": "verifyText", "in": "body", "type": "string", "required": true, "desc": "验证消息" } ] }, { "id": "contact.addSearchWxWorkContact", "module": "contact", "title": "添加企微", "summary": "添加企微 通过搜索结果，添加企业微信联系人。", "method": "/contact/addSearchWxWorkContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "添加企微.md", "tags": [ "contact", "添加企微", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" }, { "name": "corpId", "in": "body", "type": "string", "required": true, "desc": "企业 ID。" }, { "name": "ticket", "in": "body", "type": "string", "required": true, "desc": "Ticket 凭证" }, { "name": "verifyText", "in": "body", "type": "string", "required": true, "desc": "验证消息" } ] }, { "id": "contact.addCardContact", "module": "contact", "title": "添加企微名片", "summary": "添加企微名片 通过企微名片添加联系人。", "method": "/contact/addCardContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "添加企微名片.md", "tags": [ "contact", "添加企微名片", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "presenterId", "in": "body", "type": "string", "required": true, "desc": "推荐者userid" }, { "name": "fromRoomId", "in": "body", "type": "string", "required": true, "desc": "接收人id" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" }, { "name": "verifyText", "in": "body", "type": "string", "required": true, "desc": "验证消息" } ] }, { "id": "contact.addDeletedContact", "module": "contact", "title": "添加删除联系人", "summary": "添加删除联系人 - 该场景适用于好友已将您删除，需您主动重新发起好友验证申请。", "method": "/contact/addDeletedContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "添加删除联系人.md", "tags": [ "contact", "添加删除联系人", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" }, { "name": "verifyText", "in": "body", "type": "string", "required": true, "desc": "验证消息" } ] }, { "id": "contact.addRoomContact", "module": "contact", "title": "添加群成员好友", "summary": "添加群成员好友 添加群成员为好友。", "method": "/contact/addRoomContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "添加群成员好友.md", "tags": [ "contact", "添加群成员好友", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userId", "in": "body", "type": "string", "required": true, "desc": "用户id" }, { "name": "verifyText", "in": "body", "type": "string", "required": true, "desc": "验证消息" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" } ] }, { "id": "room.roomAddAdmin", "module": "room", "title": "添加群管理员", "summary": "添加群管理员 为群聊添加管理员。", "method": "/room/roomAddAdmin", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "添加群管理员.md", "tags": [ "群模块", "room", "添加群管理员", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "memberList", "in": "body", "type": "array", "required": true, "desc": "成员列表。" } ] }, { "id": "sns.snsLike", "module": "sns", "title": "点赞/取消赞", "summary": "点赞/取消赞 下载企微/个微文件资源，或将 CDN 文件转为可访问 URL。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/sns/snsLike", "category": [ "API参考", "媒体与运营", "朋友圈模块" ], "docFile": "点赞_取消赞.md", "tags": [ "sns", "朋友圈模块", "点赞/取消赞", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "snsId", "in": "body", "type": "number", "required": true, "desc": "朋友圈Id" }, { "name": "snsStatus", "in": "body", "type": "integer", "required": true, "desc": "0点赞，1取消点赞" } ] }, { "id": "user.getQrcodeCard", "module": "user", "title": "生成二维码", "summary": "生成二维码 生成当前账号的个人二维码名片，可用于展示或分享。", "method": "/user/getQrcodeCard", "category": [ "API参考", "基础能力", "个人模块" ], "docFile": "生成二维码.md", "tags": [ "基础能力", "user", "生成二维码", "个人模块", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ], "responseHint": "data 字段：qrcodeUrl（二维码地址）" }, { "id": "login.checkLogin", "module": "login", "title": "用户状态", "summary": "用户状态 用于查询指定设备的当前登录状态，确认是否已在线。", "method": "/login/checkLogin", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "用户状态.md", "tags": [ "基础能力", "登录模块", "用户状态", "login", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ], "responseHint": "data 字段：errorCode（错误码）；errorMsg（错误消息）；userId（用户id）；lastActiveTime（最后活跃时间）；userOnlineStatus（=-1 未登陆，需要扫码登陆 =0 未登陆，可免扫码登陆 =1 已扫码，待确认 =2 登陆成功 =4 用户取消登陆 =10 已扫码确认，待检测6位验证码）；corpLogo（企业 Logo URL。）；corpName（公司名称）；nickname（昵称）" }, { "id": "login.manualLogin", "module": "login", "title": "用户登录（免扫码登录）", "summary": "用户登录（免扫码登录） • 无特殊情况下，无需调用此接口。• 使用条件： 该设备（ GUID ）之前扫码登录过，且手机端没有剔除该设备。", "method": "/login/manualLogin", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "用户登录（免扫码登录）.md", "tags": [ "基础能力", "登录模块", "用户登录（免扫码登录）", "login", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ] }, { "id": "room.prohibitAddMember", "module": "room", "title": "禁止群成员互相添加", "summary": "禁止群成员互相添加 设置是否禁止群成员互相添加好友。", "method": "/room/prohibitAddMember", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "禁止群成员互相添加.md", "tags": [ "禁止群成员互相添加", "群模块", "room", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "disable", "in": "body", "type": "boolean", "required": true, "desc": "是否禁止" }, { "name": "newFlag", "in": "body", "type": "integer", "required": true, "desc": "从群详情/或群成员变动API中获取，注意区别roomFlag与roomNewFlag" } ] }, { "id": "room.prohibitChangeRoomName", "module": "room", "title": "禁止群改名", "summary": "禁止群改名 禁止群成员修改群名称。", "method": "/room/prohibitChangeRoomName", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "禁止群改名.md", "tags": [ "群模块", "room", "禁止群改名", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "目标群聊 ID，可通过群分页或群详情接口获取 roomId" }, { "name": "newFlag", "in": "body", "type": "integer", "required": true, "desc": "是否禁止" }, { "name": "disable", "in": "body", "type": "boolean", "required": true, "desc": "从群详情/或群成员变动API中获取，注意区别roomFlag与roomNewFlag" } ] }, { "id": "room.removeRoomMember", "module": "room", "title": "移除成员", "summary": "移除成员 将成员移出群聊。", "method": "/room/removeRoomMember", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "移除成员.md", "tags": [ "群模块", "room", "移除成员", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "isOuterRoom", "in": "body", "type": "integer", "required": true, "desc": "是否外部群" }, { "name": "memberList", "in": "body", "type": "array", "required": true, "desc": "成员列表。" } ] }, { "id": "room.getRoomQrCode", "module": "room", "title": "群二维码", "summary": "群二维码 获取群聊邀请二维码，可用于分享入群。", "method": "/room/getRoomQrCode", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "群二维码.md", "tags": [ "群模块", "群二维码", "room", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" } ], "responseHint": "data 字段：qrcodeData（二维码数据）；roomHeadimgUrl（群Headimg链接）" }, { "id": "room.getRoomList", "module": "room", "title": "群分页", "summary": "群分页 本接口仅支持查询本人创建的群组。如需查询全部群组，需结合 会话分页 接口使用，包含已保存至通讯录的群聊及其他临时群会话。 sessionType=1 时为群 id。", "method": "/room/getRoomList", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "群分页.md", "tags": [ "群模块", "群分页", "room", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "nextStartIndex", "in": "body", "type": "integer", "required": true, "desc": "分页使用，首次传0，下次传入返回值nextStartIndex" } ], "responseHint": "data 字段：hasMore（是否有更多）；nextStartIndex（下次请求时应传入的nextStartIndex）；roomCount（数量）；roomList（群列表。）" }, { "id": "msg.sendGroupMsgStatus", "module": "msg", "title": "群发助手-状态查询", "summary": "群发助手-状态查询 删除朋友圈动态下的指定评论。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendGroupMsgStatus", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "群发助手-状态查询.md", "tags": [ "会话与消息", "群发助手-状态查询", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "groupMsgId", "in": "body", "type": "string", "required": true, "desc": "群发消息id" }, { "name": "endDetailId", "in": "body", "type": "integer", "required": true, "desc": "用户状态列表最大查询量" } ], "responseHint": "data 字段：customerList（用户状态列表）；hasSend（是否发送）；isEnd（是否End）；total（总数）" }, { "id": "msg.sendGroupMsgRule", "module": "msg", "title": "群发助手-规则查询", "summary": "群发助手-规则查询 对个人标签进行新增、修改或删除操作。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendGroupMsgRule", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "群发助手-规则查询.md", "tags": [ "会话与消息", "msg", "消息模块 ", "群发助手-规则查询", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ], "responseHint": "data 字段：type（1=每日可接收1条；2=每周可接收7条；3=每月可接收条数为当月天数）" }, { "id": "msg.sendGroupMsg", "module": "msg", "title": "群发助手发送", "summary": "群发助手发送 对朋友圈动态发表评论或追评。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/sendGroupMsg", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "群发助手发送.md", "tags": [ "会话与消息", "群发助手发送", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "msgList", "in": "body", "type": "array", "required": true, "desc": "消息列表", "children": [ { "name": "msgData", "in": "body", "type": "object", "required": false, "desc": "【与发送消息里面的字段相同, 不需要'toId'这个字段】", "children": [ { "name": "content", "in": "body", "type": "string", "required": true } ] }, { "name": "type", "in": "body", "type": "integer", "required": false, "desc": "0: 文本 13: 链接 14: 图片 15: 文件 23: 视频 78: 小程序" } ] }, { "name": "sendType", "in": "body", "type": "integer", "required": true, "desc": "0: 表示外部联系人 1: 表示外部群" }, { "name": "toIdList", "in": "body", "type": "array", "required": true, "desc": "发送成员列表" } ], "responseHint": "data 字段：groupMsgId（分组消息Id）" }, { "id": "room.getRoomIncrSync", "module": "room", "title": "群成员变动查询", "summary": "群成员变动查询 •用于解决群成员数量较多时，添加、删除成员同步成本高、工作量大的问题。", "method": "/room/getRoomIncrSync", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "群成员变动查询.md", "tags": [ "群成员变动查询", "群模块", "room", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "ver", "in": "body", "type": "string", "required": true, "desc": "首次为0，查询指定偏移之后所有变动" }, { "name": "nowMemberCount", "in": "body", "type": "string", "required": true, "desc": "群成员数量" } ], "responseHint": "data 字段：roomList（群列表）；msg（返回说明。）" }, { "id": "room.confirmInvitedMemberList", "module": "room", "title": "群成员邀请确认（管理员）", "summary": "群成员邀请确认（管理员） 管理员确认群成员邀请。", "method": "/room/confirmInvitedMemberList", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "群成员邀请确认（管理员）.md", "tags": [ "群成员邀请确认（管理员）", "群模块", "room", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "inviterId", "in": "body", "type": "string", "required": true, "desc": "邀请人 ID" }, { "name": "InviteMsgServerId", "in": "body", "type": "string", "required": true, "desc": "邀请消息服务端Id" }, { "name": "inviteCode", "in": "body", "type": "string", "required": true, "desc": "邀请码" }, { "name": "InvitedMemberList", "in": "body", "type": "array", "required": true, "desc": "Invited成员列表" } ] }, { "id": "msg.roomTopMessageList", "module": "msg", "title": "群消息置顶-列表", "summary": "群消息置顶-列表 发布一条朋友圈动态，可包含文字、图片或视频。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/roomTopMessageList", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "群消息置顶-列表.md", "tags": [ "会话与消息", "群消息置顶-列表", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" } ], "responseHint": "data 字段：list（列表）" }, { "id": "msg.roomTopMessageSet", "module": "msg", "title": "群消息置顶-添加", "summary": "群消息置顶-添加 删除已发布的朋友圈动态。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/roomTopMessageSet", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "群消息置顶-添加.md", "tags": [ "会话与消息", "群消息置顶-添加", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "msgId", "in": "body", "type": "string", "required": true, "desc": "消息 ID，用于引用、撤回。" }, { "name": "msgSenderId", "in": "body", "type": "string", "required": true, "desc": "消息发送人userId" }, { "name": "msgTimestamp", "in": "body", "type": "integer", "required": true, "desc": "消息发送时间戳" }, { "name": "msgData", "in": "body", "type": "object", "required": true, "desc": "消息内容，根据msgType不同，msgData也不同。数据格式详见各个消息的发送api", "children": [ { "name": "content", "in": "body", "type": "string", "required": true } ] }, { "name": "msgType", "in": "body", "type": "integer", "required": true, "desc": "消息类型编号。" } ] }, { "id": "msg.roomTopMessageCancel", "module": "msg", "title": "群消息置顶-移除", "summary": "群消息置顶-移除 对朋友圈动态点赞或取消点赞。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/roomTopMessageCancel", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "群消息置顶-移除.md", "tags": [ "会话与消息", "群消息置顶-移除", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "seq", "in": "body", "type": "integer", "required": true, "desc": "消息序号" } ] }, { "id": "room.dismissRoom", "module": "room", "title": "群解散", "summary": "群解散 解散指定群聊，解散后群聊不可恢复，请谨慎操作。", "method": "/room/dismissRoom", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "群解散.md", "tags": [ "群模块", "room", "群解散", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" } ] }, { "id": "room.batchGetRoomDetail", "module": "room", "title": "群详情-批量", "summary": "群详情-批量 群成员名称需调用 联系人详情 接口获取。 本接口查询群基本信息，支持批量查询。 查询群详情时，先调用 群分页 获取群 roomId ，并将群数据缓存至本地，再根据 roomId 查询详情。", "method": "/room/batchGetRoomDetail", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "群详情-批量.md", "tags": [ "群模块", "room", "群详情-批量", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomIdList", "in": "body", "type": "array", "required": true, "desc": "群id列表" } ], "responseHint": "data 字段：roomList（群列表）" }, { "id": "contact.searchContact", "module": "contact", "title": "联系人搜索", "summary": "联系人搜索 按手机号搜索联系人，可快速定位目标用户。", "method": "/contact/searchContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "联系人搜索.md", "tags": [ "contact", "联系人模块", "客户管理", "联系人搜索", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "keyword", "in": "body", "type": "string", "required": true, "desc": "搜索手机号。" } ], "responseHint": "data 字段：searchStatus（Search状态）；workUserInfo（企微用户信息）；wxUserInfo（微信用户信息）" }, { "id": "contact.searchContact.联系人详情_By二维码", "module": "contact", "title": "联系人详情-By二维码", "summary": "联系人详情-By二维码 调用方需要将个微、企V名片二维码中的url提取出来", "method": "/contact/searchContact", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "联系人详情-By二维码.md", "tags": [ "contact", "联系人详情-By二维码", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "qrUrl", "in": "body", "type": "string", "required": true, "desc": "二维码中的url" } ], "responseHint": "data 字段：recommendContact（企V账号信息）；wxInfo（个V账号信息）" }, { "id": "contact.batchGetUserinfo", "module": "contact", "title": "联系人详情-批量", "summary": "联系人详情-批量 本接口用于查询联系人基本信息，支持批量查询。 允许查询好友、非好友的联系人信息。 查询联系人详情时，需先调用 外部联系人分页 获取用户 userid ，并将联系人数据缓存至本地，再根据 userid 查询详情。", "method": "/contact/batchGetUserinfo", "category": [ "API参考", "客户管理", "联系人模块" ], "docFile": "联系人详情-批量.md", "tags": [ "contact", "联系人详情-批量", "联系人模块", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "userIdList", "in": "body", "type": "array", "required": true, "desc": "用户id列表" } ], "responseHint": "data 字段：contactList（联系人列表）" }, { "id": "user.getProfile", "module": "user", "title": "获取个人信息", "summary": "获取个人信息 获取当前登录账号的个人资料，包括昵称、头像、企业等信息。 guid 即后台登录的设备 ID，是接口调用时标识设备身份的关键参数。", "method": "/user/getProfile", "category": [ "API参考", "基础能力", "个人模块" ], "docFile": "获取个人信息.md", "tags": [ "基础能力", "user", "个人模块", "获取个人信息", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ], "responseHint": "data 字段：acctid（账户id）；alias（别名）；corpId（企业 ID。）；gender（0未，1男，2女）；groupId（分组Id）；internationCode（86）；mobile（手机号）；nickname（昵称）；realName（真实姓名）；userId（用户id）；avatarUrl（头像 URL。）" }, { "id": "sns.getSnsDetail", "module": "sns", "title": "获取详情-批量", "summary": "获取详情-批量 根据 userId 列表批量查询联系人朋友圈详细信息。", "method": "/sns/getSnsDetail", "category": [ "API参考", "媒体与运营", "朋友圈模块" ], "docFile": "获取详情-批量.md", "tags": [ "获取详情-批量", "sns", "朋友圈模块", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "snsIdList", "in": "body", "type": "array", "required": true, "desc": "朋友圈Id列表" } ], "responseHint": "data 字段：snsDetailList（朋友圈Detail列表）" }, { "id": "client.setCallback", "module": "client", "title": "设置回调地址", "summary": "设置回调地址 • 作用范围： 按 Token 配置，一个 Token 下的所有账号共用此回调地址。• 数据隔离： 回调内容包含 guid ，方便您的后端区分是哪个账号收到的消息。• msgType 包含系统、聊天消息类型，详见回调结构说明。 注意：回调地址须为公网可访问的 HTTPS URL 或者 域名。", "method": "/client/setCallback", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "设置回调地址.md", "tags": [ "基础能力", "登录模块", "client", "设置回调地址", "API参考" ], "params": [ { "name": "callbackUrl", "in": "body", "type": "string", "required": true, "desc": "Webhook 回调地址，需公网可访问的 https URL。" }, { "name": "authSecret", "in": "body", "type": "string", "required": true, "desc": "鉴权密钥" }, { "name": "authType", "in": "body", "type": "string", "required": true, "desc": "Authorization" } ] }, { "id": "sns.snsComment", "module": "sns", "title": "评论/追评", "summary": "评论/追评 调用 评论/追评，需传入已登录设备的 guid。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/sns/snsComment", "category": [ "API参考", "媒体与运营", "朋友圈模块" ], "docFile": "评论_追评.md", "tags": [ "评论/追评", "sns", "朋友圈模块", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "snsId", "in": "body", "type": "number", "required": true, "desc": "朋友圈消息对应的id" }, { "name": "content", "in": "body", "type": "string", "required": true, "desc": "消息内容。" }, { "name": "refCommentId", "in": "body", "type": "integer", "required": true, "desc": "默认传0 如果需要回复别人的评论则传别人评论的id 从获取朋友圈列表中获取" } ] }, { "id": "sns.deleteSnsComment", "module": "sns", "title": "评论删除", "summary": "评论删除 调用 评论删除，需传入已登录设备的 guid。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/sns/deleteSnsComment", "category": [ "API参考", "媒体与运营", "朋友圈模块" ], "docFile": "评论删除.md", "tags": [ "sns", "朋友圈模块", "评论删除", "媒体与运营", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "snsId", "in": "body", "type": "number", "required": true, "desc": "朋友圈消息对应的id" }, { "name": "content", "in": "body", "type": "string", "required": true, "desc": "消息内容。" }, { "name": "commentId", "in": "body", "type": "integer", "required": true, "desc": "评论id" } ] }, { "id": "msg.voiceToTextQuery", "module": "msg", "title": "语音转文字-任务查询", "summary": "语音转文字-任务查询 分页拉取朋友圈动态列表。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/voiceToTextQuery", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "语音转文字-任务查询.md", "tags": [ "会话与消息", "语音转文字-任务查询", "msg", "消息模块 ", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "msgServerId", "in": "body", "type": "integer", "required": true, "desc": "消息id" }, { "name": "voiceId", "in": "body", "type": "string", "required": true, "desc": "语音 ID" } ], "responseHint": "data 字段：text（文本）；isEnd（任务是否执行完成）" }, { "id": "msg.voiceToTextApply", "module": "msg", "title": "语音转文字-任务申请", "summary": "语音转文字-任务申请 分页拉取历史聊天记录，适用于消息归档与同步场景。 注意：须传入 guid，为已登录云设备唯一标识，通过创建设备接口获取。", "method": "/msg/voiceToTextApply", "category": [ "API参考", "会话与消息", "消息模块 " ], "docFile": "语音转文字-任务申请.md", "tags": [ "会话与消息", "msg", "消息模块 ", "语音转文字-任务申请", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "msgServerId", "in": "body", "type": "integer", "required": true, "desc": "消息id" } ], "responseHint": "data 字段：voiceId（语音 ID）" }, { "id": "user.logout", "module": "user", "title": "账号退出", "summary": "账号退出 退出当前设备绑定的企微账号登录状态。", "method": "/user/logout", "category": [ "API参考", "基础能力", "登录模块" ], "docFile": "账号退出.md", "tags": [ "基础能力", "登录模块", "账号退出", "user", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" } ] }, { "id": "room.changeRoomMaster", "module": "room", "title": "转让群主", "summary": "转让群主 将群主身份转让给其他群成员。", "method": "/room/changeRoomMaster", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "转让群主.md", "tags": [ "群模块", "room", "转让群主", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "newOwnerId", "in": "body", "type": "string", "required": true, "desc": "新群主id" } ] }, { "id": "room.quitRoom", "module": "room", "title": "退群", "summary": "退群 退出指定群聊。", "method": "/room/quitRoom", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "退群.md", "tags": [ "退群", "群模块", "room", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" } ] }, { "id": "room.inviteRoomMember", "module": "room", "title": "邀请/添加成员", "summary": "邀请/添加成员 向已有群聊邀请或添加新成员。", "method": "/room/inviteRoomMember", "category": [ "API参考", "客户管理", "群模块" ], "docFile": "邀请_添加成员.md", "tags": [ "群模块", "room", "邀请/添加成员", "客户管理", "API参考" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。" }, { "name": "roomId", "in": "body", "type": "string", "required": true, "desc": "群聊 ID。" }, { "name": "isOuterRoom", "in": "body", "type": "integer", "required": true, "desc": "是否外部群" }, { "name": "memberList", "in": "body", "type": "array", "required": true, "desc": "成员列表" } ] }, { "id": "cloud.bigFileDownloadAsync", "module": "cloud", "title": "企微大文件异步下载", "summary": "文件大于 20M 使用此接口；下载地址为临时云资源（7–15 天不定期清理）；异步结果通过回调通知，根据 requestId 匹配。注意：官方文档未公布该接口的 method 路由值，qiwei_api_call 无法直接调用，请参考 docUrl 官方文档确认后用 rawMethod 调用。", "method": null, "category": [ "API参考", "媒体与运营", "文件与媒体（下载/上传）" ], "docFile": "企微大文件异步下载.md", "tags": [ "cloud", "企微大文件异步下载", "媒体与运营", "API参考", "大文件", "下载" ], "params": [ { "name": "guid", "in": "body", "type": "string", "required": true, "desc": "设备唯一标识 guid" }, { "name": "filekey", "in": "body", "type": "string", "required": true, "desc": "当 fileId 以 * 开头时为空；否则不为空" }, { "name": "fileId", "in": "body", "type": "string", "required": true, "desc": "文件 Id" }, { "name": "fileSize", "in": "body", "type": "integer", "required": true, "desc": "文件大小" }, { "name": "fileType", "in": "body", "type": "integer", "required": true, "desc": "22 大视频 35 文件" }, { "name": "filename", "in": "body", "type": "string", "required": true, "desc": "文件名" } ], "responseHint": "data 字段：requestId（请求 Id，用于在回调中匹配异步下载结果）" } ] }