Appearance
企微自建应用插件
当您需要使用企微自建应用插件时，可以参考以下文档进行配置和使用。
1. 插件介绍
1.1 功能介绍
通过此接口，您可以向指定的成员或部门发送文本消息、Markdown格式信息、
文本卡片等多种类型的消息。
1.2 效果展示
注意：这里只展示了markdown类型的消息效果。
其它类型的效果将在后面展示。
2. 使用前配置
2.1 登录企业微信管理后台
使用企业所有者的企微账号登录企业微信管理后台。
点击应用管理,向下滑,找到自建应用部分
2.2 创建自建应用
- 点击创建应用。
- 配置应用的基本信息，如应用名称、头像、权限等。
提示
温馨提示：权限选择根部门就可访问全部部门和成员。
2.3 为自建应用配置网页授权和可信IP
- 进入自建应用详情。
- 向下滑,找到配置网页授权和可信IP。
- 点击
网页授权及JS-SDK的配置,设置可信域名为会众云平台部署服务器的域名。
- 点击
企业可信IP的配置,设置可信IP为会众云平台部署服务器的IP地址。
2.4 在平台中新增自建应用记录
- 在自建应用的详情中获取自建应用的基础信息。
- 在我的企业中获取企微corpsecret。
- 回到平台，选择 自建应用信息表单。
- 点击右上方的 “+记录” 按钮，填写相关信息后(不用填写accessToken)点击 “提交”。
- 选择刚刚新增的自建应用信息,点击 “手动刷新token” 按钮。
注意
温馨提示：所有自建应用的token每隔一小时会自动刷新,如果没有刷新可以手动刷新或检查一下自建应用的基础信息是否正确。
3. 通讯录相关接口使用说明
3.1 获取指定应用的部门信息接口
获取指定应用权限范围里指定部门的所有子部门信息。
接口调用效果如下:
输入参数说明
接口调用时，需要传入以下 参数：
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| 企微corpid | 文本 | ✔️ | 应用唯一标识,可用于获取应用的基本信息、配置信息、数据等。 |
| 部门id | 数值 | 部门id。获取指定部门及其下的子部门（以及子部门的子部门等等，递归）。 如果不填，默认获取全量组织架构。 |
输出参数说明
调用此功能时，可获取如下返回参数：
| 参数名 | 类型 | 描述 |
|---|---|---|
| 部门列表 | 子表 | 部门数据的子表,下面的参数是子表的内容 |
| 部门id | 数值 | 创建的部门id |
| 部门名称 | 文本 | 部门的名称 |
| 部门英文名称 | 文本 | 部门的英文名称 |
| 父部门id | 数值 | 父部门id。根部门为1 |
使用示例
- 选择 “自建应用配置”。
- 点击 “获取并更新应用所有部门” 按钮。
- 选择 “企业部门信息” ,查看更新的部门信息。
注意
说明：只能拉取token对应的应用的权限范围内的部门列表
3.2 获取指定应用的所有成员信息接口
获取指定应用权限范围里所有的成员信息。
接口调用效果如下:
输入参数说明
接口调用时，需要传入以下 参数：
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| 企微corpid | 文本 | ✔️ | 应用唯一标识,可用于获取应用的基本信息、配置信息、数据等。 |
输出参数说明
调用此功能时，可获取如下返回参数：
| 参数名 | 类型 | 描述 |
|---|---|---|
| 成员列表 | 子表 | 成员数据的子表,下面的参数是子表的内容 |
| 姓名 | 文本 | 成员的名称 |
| 所属部门 | 文本 | 成员所属的部门的名称 |
| 成员id | 文本 | 成员的id |
使用示例
- 选择 自建应用配置。
- 点击 “获取并更新应用所有成员” 按钮。
- 选择 成员信息 ,查看更新的成员信息。
注意
温馨提示：返回的数据可能会存在相同的成员信息,只是成员所在的部门不同。
4. 消息通知相关接口使用说明
消息通知接口是以某个应用的名义推送到员工的工作通知消息，例如生日祝福、入职提醒等。具体消息类型和样例在后面介绍。
4.1 推送文本消息接口
将文本类型的数据推送到员工的工作通知消息。
接口调用效果如下:
提示
示例通知内容: 你的快递已到，请携带工卡前往邮件中心领取。\n出发前可查看<a href=\"https://work.weixin.qq.com\">邮件中心视频实况</a>，聪明避开排队。
参数说明
接口调用时，需要传入以下 参数：
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| 通知内容(文本类型) | 文本 | ✔️ | 消息内容，最长不超过2048个字节，超过将截断。 |
| 通知成员列表 | 子表 | 接收者的用户id列表，最多支持1000个。 | |
| 通知部门列表 | 子表 | 接收者的部门id列表，最多支持100个。 | |
| 是否发送给企业全部用户 | 是否 | ✔️ | 是否发送给企业全部用户。 |
| 企微corpid | 文本 | 应用唯一标识,不选默认自建应用表单第一个应用。 |
提示
说明：当是否发送给企业全部用户设置为否时必须指定通知成员列表或通知部门列表其中一个参数的值。
使用示例
- 选择名为 “推送文本消息” 功能表单
- 点击右上方的 “+记录” 按钮
- 按照
引导填写相关数据，点击 “提交” 按钮。 - 选择刚刚新增的记录,点击 “推送文本信息” 按钮。
4.2 推送markdown消息接口
将markdown类型的数据推送到员工的工作通知消息。
接口调用效果如下:
提示
示例通知内容:您的会议室已经预定，稍后会同步到邮箱 \n>**事项详情** \n>事 项：<font color=\"info\">开会</font> \n>组织者：@miglioguan \n>参与者：@miglioguan、@kunliu、@jamdeezhou、@kanexiong、@kisonwang \n> \n>会议室：<font color=\"info\">广州TIT 1楼 301</font> \n>日 期：<font color=\"warning\">2018年5月18日</font> \n>时 间：<font color=\"comment\">上午9:00-11:00</font> \n> \n>请准时参加会议。 \n> \n>如需修改会议信息，请点击：[修改会议信息](https://work.weixin.qq.com)
参数说明
接口调用时，需要传入以下 参数：
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| 通知内容(markdown文本) | 文本 | ✔️ | markdown格式的消息，最大不超过5000字符。 |
| 通知成员列表 | 子表 | 接收者的用户id列表，最多支持1000个。 | |
| 通知部门列表 | 子表 | 接收者的部门id列表，最多支持100个。 | |
| 是否发送给企业全部用户 | 是否 | ✔️ | 是否发送给企业全部用户。 |
| 企微corpid | 文本 | 应用唯一标识,不选默认自建应用表单第一个应用。 |
提示
说明：当是否发送给企业全部用户设置为否时必须指定通知成员列表或通知部门列表其中一个参数的值。
使用示例
- 选择名为 “推送markdown消息” 功能表单
- 点击右上方的 “+记录” 按钮
- 按照
引导填写相关数据，点击 “提交” 按钮。 - 选择刚刚新增的记录,点击 “推送markdown信息” 按钮。
提示
温馨提醒：markdown语法在引导中有简单介绍
4.3 推送消息卡片接口
将消息卡片类型的数据推送到员工的工作通知消息。
接口调用效果如下:
提示
示例通知内容:<div class=\"gray\">2016年9月26日</div> <div class=\"normal\">恭喜你抽中iPhone 7一台，领奖码：xxxx</div><div class=\"highlight\">请于2016年10月10日前联系行政同事领取</div>
参数说明
接口调用时，需要传入以下 参数：
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| 通知内容 | 文本 | ✔️ | 消息的内容，支持html标签，不超过512个字符 |
| 通知成员列表 | 子表 | 接收者的userid列表，最大用户列表长度100。 | |
| 通知部门列表 | 子表 | 接收者的部门id列表，最大列表长度20。 | |
| 是否发送给企业全部用户 | 是否 | ✔️ | 是否发送给企业全部用户。 |
| 标题 | 文本 | ✔️ | 标题，不超过128个字节，超过会自动截断 |
| 跳转关键字 | 文本 | 按钮文字。 默认为“详情”， 不超过4个文字 | |
| 跳转地址 | 文本 | ✔️ | 点击后跳转的链接。最长2048字节，请确保包含了协议头(http/https) |
| 企微corpid | 文本 | 应用唯一标识,不选默认自建应用表单第一个应用。 |
提示
说明：当是否发送给企业全部用户设置为否时必须指定通知成员列表或通知部门列表其中一个参数的值。
使用示例
- 选择名为 “推送消息卡片消息” 功能表单
- 点击右上方的 “+记录” 按钮
- 按照
引导填写相关数据，点击 “提交” 按钮。 - 选择刚刚新增的记录,点击 “推送消息卡片” 按钮。
5. 常见问题
Q1: 如何检查接口是否成功调用？
- 答：您可以在工作流中查看调用业务流程的日志，看HTTP请求的状态。