文档首页/ 应用与数据集成平台 ROMA Connect/ 用户指南（新版）/ 连接器/ SaaS应用/ 企业微信

更新时间：2024-04-23 GMT+08:00

企业微信

企业微信连接器用于实现在工作流中通过配置操作企业微信相关功能。

企业微信是腾讯微信团队打造的企业通讯与办公工具，具有与微信一致的沟通体验，丰富的OA应用，和连接微信生态的能力，可帮助企业连接内部、连接生态伙伴、连接消费者。专业协作、安全管理、人即服务。

创建企业微信连接

登录新版ROMA Connect控制台。
在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。
选择“企业微信”连接器。

在弹窗中配置连接器信息，完成后单击“确定”。

参数	说明
连接名称	填写连接器实例名称。
连接类型	选择连接类型。机器人：若需要使用机器人推送消息功能，选择机器人；应用：其他功能选择应用。
企业ID	仅当“连接类型”选择“应用”时需要配置。每个企业都拥有唯一的corpid，详情见企业微信《企业内部开发服务端API文档》“基本概念介绍”章节。
应用凭证密钥	仅当“连接类型”选择“应用”时需要配置。每一个应用都有一个独立的访问密钥，详情见企业微信《企业内部开发服务端API文档》“基本概念介绍”章节。
机器人Key	仅当“连接类型”选择“机器人”时需要配置。机器人webhook中的请求参数key的值。
描述	填写连接器的描述信息，用于识别不同的连接器。

支持的动作

获取部门ID列表
创建部门
更新部门
删除部门
获取成员ID列表
创建成员
更新成员
删除成员
获取群聊会话
创建群聊会话
修改群聊会话
推送文本消息
推送markdown消息
推送文件消息
推送图片消息
推送图文消息
推送文本卡片消息
撤回应用消息
推送文本消息到群聊
推送markdown消息到群聊
推送文件消息到群聊
推送图片消息到群聊
推送图文消息到群聊
推送文本卡片消息到群聊
机器人推送文本消息
机器人推送markdown消息
机器人推送文件消息
机器人推送图片消息
机器人推送图文消息

配置参数

表1 获取部门ID列表
参数	说明
部门ID	获取指定部门及其下的子部门（以及子部门的子部门等等，递归）。如果不填，默认获取全量组织架构。

表2 创建部门
参数	说明
部门名称	同一个层级的部门名称不能重复。长度限制为1~32个UTF-8字符，字符不能包括:*?"<>｜
英文名称	同一个层级的部门名称不能重复。需要在管理后台开启多语言支持才能生效。长度限制为1~64个字符，字符不能包括:*?"<>｜
父部门ID	父部门id，32位整型。
次序	在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)。
部门ID	32位整型，指定时必须大于1。若不填该参数，将自动生成id。

表3 更新部门
参数	说明
部门ID	部门id。
部门名称	长度限制为1~32个UTF-8字符，字符不能包括:*?"<>｜
英文名称	需要在管理后台开启多语言支持才能生效。长度限制为1~64个字符，字符不能包括:*?"<>｜
父部门ID	父部门id。
次序	在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)。

表4 删除部门
参数	说明
部门ID	部门id。

表5 获取成员ID列表
参数	说明
分页游标	用于分页查询的游标，字符串类型，由上一次调用返回，首次调用不填。
分页数据量	分页，预期请求的数据量，取值范围 1 ~ 10000。

表6 创建成员
参数	说明
成员ID	成员UserID。对应管理端的账号，企业内必须唯一。长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。系统进行唯一性检查时会忽略大小写。
成员名称	长度为1~64个utf8字符。
成员别名	长度1~64个utf8字符。
性别	1表示男性，2表示女性。
是否启用成员	1表示启用成员，0表示禁用成员。
主部门ID	主部门id。
职务	职务信息。长度为0~128个字符。
所属部门ID列表	成员所属部门id列表，不超过100个。用英文逗号分隔。
部门内的排序值列表	部门内的排序值，默认为0，成员次序以创建时间从小到大排列。个数必须和参数department的个数一致，数值越大排序越前面。有效的值范围是[0, 2^32)。用英文逗号分隔。
是否为部门领导列表	个数必须和参数department的个数一致，表示在所在的部门内是否为部门负责人。1表示为部门负责人，0表示非部门负责人。在审批（自建、第三方）等应用里可以用来标识上级审批人。用英文逗号分隔。
直属上级ID列表	直属上级UserID，设置范围为企业内成员，可以设置最多5个上级。用英文逗号分隔。
座机	32字节以内，由纯数字、“-”、“+”或“,”组成。
手机号码	企业内必须唯一，手机号码/邮箱二者不能同时为空。
邮箱	长度6~64个字节，且为有效的email格式。企业内必须唯一，手机号码/邮箱二者不能同时为空。
企业邮箱	仅对开通企业邮箱的企业有效。长度6~64个字节，且为有效的企业邮箱格式。企业内必须唯一。未填写则系统会为用户生成默认企业邮箱（由系统生成的邮箱可修改一次）。
地址	长度最大128个字符。

表7 更新成员
参数	说明
成员ID	成员UserID。对应管理端的账号，企业内必须唯一。不区分大小写，长度为1~64个字节。
成员名称	长度为1~64个utf8字符。
成员别名	长度为1-64个utf8字符。
性别	1表示男性，2表示女性。
是否启用成员	1表示启用成员，0表示禁用成员。
主部门ID	主部门id。
职务	长度为0~128个utf8字符。
所属部门ID列表	成员所属部门id列表，不超过100个。用英文逗号分隔。
部门内的排序值列表	部门内的排序值，默认为0。当有传入department时有效。数量必须和department一致，数值越大排序越前面。有效的值范围是[0, 2^32)。用英文逗号分隔。
是否为部门领导列表	部门负责人字段，个数必须和department一致，表示在所在的部门内是否为负责人。0表示否，1表示是。用英文逗号分隔。
直属上级ID列表	直属上级，可以设置企业范围内成员为直属上级，最多设置5个，用英文逗号分隔。
座机	由1-32位的纯数字、“-”、“+”或“,”组成。
手机号码	手机号码。企业内必须唯一。若成员已激活企业微信，则需成员自行修改（此情况下该参数被忽略，但不会报错）。
邮箱	邮箱。长度不超过64个字节，且为有效的email格式。企业内必须唯一。若是绑定了腾讯企业邮箱的企业微信，则需要在腾讯企业邮箱中修改邮箱（此情况下该参数被忽略，但不会报错）。
企业邮箱	企业邮箱。仅对开通企业邮箱的企业有效。长度6~64个字节，且为有效的企业邮箱格式。企业内必须唯一。企业邮箱为系统自动生成的成员可修改一次。
地址	长度最大128个字符。

表8 删除成员
参数	说明
成员ID	成员UserID。

表9 获取群聊会话
参数	说明
群聊ID	群聊id。

**表10** 创建群聊会话
参数	说明
群聊名称	群聊名，最多50个utf8字符，超过将截断。
群主ID	指定群主的id。如果不指定，系统会随机从成员列表中选一人作为群主。
群成员ID列表	群成员id列表。至少2人，至多2000人。用英文逗号分隔。
群聊ID	群聊的唯一标志，不能与已有的群重复；字符串类型，最长32个字符。只允许字符0-9及字母a-zA-Z。如果不填，系统会随机生成群id。

**表11** 修改群聊会话
参数	说明
群聊ID	群聊id。
群聊名称	新的群聊名。若不需更新，请忽略此参数。最多50个utf8字符，超过将截断。
群主ID	新群主的id。若不需更新，请忽略此参数。课程群聊群主必须在设置的群主列表内。
添加成员ID列表	添加成员的id列表。
踢出成员ID列表	踢出成员的id列表。

**表12** 推送文本消息
参数	说明
接收人ID	指定接收消息的成员，成员ID列表（多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为“@all”，则向该企业应用的全部成员发送。
接收部门ID	指定接收消息的部门，部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为“@all”时忽略本参数。
企业应用ID	企业应用的id，整型。可在应用的设置页面查看。
消息内容	消息内容，最长不超过2048个字节，超过将截断（支持id转译）。
是否是保密消息	表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，默认为0。

**表13** 推送markdown消息
参数	说明
接收人ID	指定接收消息的成员，成员ID列表（多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为“@all”，则向该企业应用的全部成员发送。
接收部门ID	指定接收消息的部门，部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为“@all”时忽略本参数。
企业应用ID	企业应用的id，整型。可在应用的设置页面查看。
消息内容	markdown内容，最长不超过2048个字节，必须是utf8编码。

**表14** 推送文件消息
参数	说明
接收人ID	指定接收消息的成员，成员ID列表（多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为“@all”，则向该企业应用的全部成员发送。
接收部门ID	指定接收消息的部门，部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为“@all”时忽略本参数。
企业应用ID	企业应用的id，整型。可在应用的设置页面查看。
文件ID	可以调用上传临时素材接口获取。
是否是保密消息	表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，默认为0。

**表15** 推送图片消息
参数	说明
接收人ID	指定接收消息的成员，成员ID列表（多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为“@all”，则向该企业应用的全部成员发送。
接收部门ID	指定接收消息的部门，部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为“@all”时忽略本参数。
企业应用ID	企业应用的id，整型。可在应用的设置页面查看。
图片媒体文件ID	可以调用上传临时素材接口获取。
是否是保密消息	表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，默认为0。

**表16** 推送图文消息
参数	说明
接收人ID	指定接收消息的成员，成员ID列表（多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为“@all”，则向该企业应用的全部成员发送。
接收部门ID	指定接收消息的部门，部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为“@all”时忽略本参数。
企业应用ID	企业应用的id，整型。可在应用的设置页面查看。
消息标题	不超过128个字节，超过会自动截断。
消息缩略图	图文消息缩略图ID。可以通过素材管理接口获得，即上传接口返回的media_id。
消息内容	支持html标签，不超过666K个字节。
消息作者	不超过64字节。
原文链接	单击“阅读原文”之后的页面链接。
消息描述	不超过512个字节，超过会自动截断。
是否是保密消息	表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，2表示仅限在企业内分享，默认为0。

**表17** 推送文本卡片消息
参数	说明
接收人ID	指定接收消息的成员，成员ID列表（多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为“@all”，则向该企业应用的全部成员发送。
接收部门ID	指定接收消息的部门，部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为“@all”时忽略本参数。
企业应用ID	企业应用的id，整型。可在应用的设置页面查看。
消息标题	不超过128个字节，超过会自动截断。
消息描述	不超过512个字节，超过会自动截断。
点击后跳转链接	最长2048字节，请确保包含了协议头(http/https)。
按钮文字	默认为“详情”，不超过4个文字，超过自动截断。

**表18** 撤回应用消息
参数	说明
消息ID	从应用发送消息接口响应获得。

**表19** 推送文本消息到群聊
参数	说明
群聊ID	群聊ID所代表的群必须是连接对应的应用所创建。
消息内容	消息内容，最长不超过2048个字节，超过将截断。
是否是保密消息	表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，默认为0。

**表20** 推送markdown消息到群聊
参数	说明
群聊ID	群聊ID所代表的群必须是连接对应的应用所创建。
消息内容	markdown内容，最长不超过2048个字节，必须是utf8编码。

**表21** 推送文件消息到群聊
参数	说明
群聊ID	群聊ID所代表的群必须是连接对应的应用所创建。
文件ID	可以调用上传临时素材接口获取。
是否是保密消息	表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，默认为0。

**表22** 推送图片消息到群聊
参数	说明
群聊ID	群聊ID所代表的群必须是连接对应的应用所创建。
图片媒体文件ID	可以调用上传临时素材接口获取。
是否是保密消息	表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，默认为0。

**表23** 推送图文消息到群聊
参数	说明
群聊ID	群聊ID所代表的群必须是连接对应的应用所创建。
消息标题	消息标题，不超过128个字节，超过会自动截断。
消息缩略图	图文消息缩略图ID。可以通过素材管理接口获得，即上传接口返回的media_id。
消息内容	消息内容，支持html标签，不超过666K个字节。
消息作者	消息作者，不超过64字节。
原文链接	单击“阅读原文”之后的页面链接。
消息描述	消息描述，不超过512个字节，超过会自动截断。
是否是保密消息	表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，2表示仅限在企业内分享，默认为0。

**表24** 推送文本卡片消息到群聊
参数	说明
群聊ID	群聊ID所代表的群必须是连接对应的应用所创建。
消息标题	消息标题，不超过128个字节，超过会自动截断。
消息描述	消息描述，不超过512个字节，超过会自动截断。
点击后跳转链接	最长2048字节，请确保包含了协议头(http/https)。
按钮文字	默认为“详情”，不超过4个文字，超过自动截断。

**表25** 机器人推送文本消息
参数	说明
消息内容	消息内容，最长不超过2048个字节。
提醒用户ID列表	提醒群中的指定成员(@某个成员)，@all表示提醒所有人。用户ID之间使用英文逗号分隔。
提醒用户手机号列表	提醒手机号对应的群成员(@某个成员)，@all表示提醒所有人。手机号之间使用英文逗号分隔。

**表26** 机器人推送markdown消息
参数	说明
消息内容	markdown内容，最长不超过4096个字节，必须是utf8编码。

**表27** 机器人推送文件消息
参数	说明
文件ID	文件ID，可通过群机器人文件上传接口获取。

**表28** 机器人推送图片消息
参数	说明
图片内容Base64编码	图片内容的base64编码。
图片内容MD5值	图片内容（base64编码前）的md5值。

**表29** 机器人推送图文消息
参数	说明
消息标题	消息标题，不超过128个字节，超过会自动截断。
消息描述	消息描述，不超过512个字节，超过会自动截断。
跳转链接	单击后跳转的链接。
图片链接	图文消息的图片链接，支持JPG、PNG格式，较好的效果为大图 1068455，小图150150。

父主题： SaaS应用

上一篇：Jira Software

下一篇：钉钉

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消