# 企业微信（服务端）
企业微信（服务端）提供企业管理员对企业服务及企业微信的集成，包含"获取群聊会话"、"推送应用文本消息"等执行动作。
#### 连接参数
企业微信（服务端）连接器使用APIkey认证，连接时连接参数说明如[表1]所示。
 表1连接参数说明 
| 名称     | 必填 | 说明           | 示例值/默认值                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| 连接名称   | 是  | 设置连接名称。      | 企业微信（服务端）的连接。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| 描述     | 否  | 对于连接的信息描述说明。 | description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| 企业ID   | 是  | 应用标识Key。     | 1. 登录<https://developer.work.weixin.qq.com/>后，注册账号，以企业管理员身份登录企业微信管理后台。  2. 在管理后台"我的企业 \> 企业信息"下查看"企业ID"。  3. 企业管理密钥是企业应用里面用于保障数据安全的钥匙，每一个应用都有一个独立的访问密钥。密钥包含：自建应用secret、基础应用secret、通讯录管理secret和外部联系人管理secret。 获取密钥的方法请参见<https://developer.work.weixin.qq.com/document/path/90665#corpid>。    |
| 企业管理密钥 | 是  | 应用的密钥。       | 1. 登录<https://developer.work.weixin.qq.com/>后，注册账号，以企业管理员身份登录企业微信管理后台。  2. 在管理后台"我的企业 \> 企业信息"下查看"企业ID"。  3. 企业管理密钥是企业应用里面用于保障数据安全的钥匙，每一个应用都有一个独立的访问密钥。密钥包含：自建应用secret、基础应用secret、通讯录管理secret和外部联系人管理secret。 获取密钥的方法请参见<https://developer.work.weixin.qq.com/document/path/90665#corpid>。    |
   
#### 获取群聊会话
用户可通过调用该接口与机器人进行会话。
- 输入参数 获取群聊会话执行动作，相关参数说明如[表2]所示。
   表2获取群聊会话输入参数说明 
  | 参数   | 必填 | 说明    |
  |:---|:---|:---|
  | 群聊id | 是  | 群聊ID。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表3]。
   表3获取群聊会话输出参数说明 
  | 参数      | 说明       |
  |:---|:---|
  | 群聊信息    | 群聊信息。    |
  | 群聊id    | 群聊ID。    |
  | 群聊名     | 群聊名。     |
  | 群主id    | 群主ID。    |
  | 群成员id列表 | 群成员ID列表。 |
  | -成员id   | 成员ID。    |
     
  
 
#### 推送应用文本消息
推送应用文本消息。
- 输入参数 推送应用文本消息执行动作，相关参数说明如[表4]所示。
   表4推送应用文本消息输入参数说明 
  | 参数        | 必填 | 说明                  |
  |:---|:---|:---|
  | 指定收件人     | 否  | 收件人ID，多个用"\|"分隔。    |
  | 指定接收消息的部门 | 否  | 部门ID，多个用"\|"分隔。     |
  | 企业应用的id   | 是  | 推送消息的企业应用。          |
  | 消息内容      | 是  | 最长不超过2048个字节，超过将截断。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表5]。
   表5推送应用文本消息输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 消息id | 消息ID。 |
     
  
 
#### 获取部门成员
获取部门成员。
- 输入参数 获取部门成员执行动作，相关参数说明如[表6]所示。
   表6获取部门成员输入参数说明 
  | 参数       | 必填 | 说明        |
  |:---|:---|:---|
  | 待查询的部门id | 是  | 待查询的部门ID。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表7]。
   表7获取部门成员输出参数说明 
  | 参数             | 说明              |
  |:---|:---|
  | 成员列表           | 成员列表。           |
  | 成员UserID       | 成员UserID。       |
  | 成员名称           | 成员名称。           |
  | 成员所属部门列表       | 成员所属部门列表。       |
  | -部门ID          | 部门ID。           |
  | 成员的open_userid | 成员的open_userid。 |
     
  
 
#### 获取部门列表
获取部门列表。
- 输入参数 获取部门列表执行动作，相关参数说明如[表8]所示。
   表8获取部门列表输入参数说明 
  | 参数       | 必填 | 说明             |
  |:---|:---|:---|
  | 指定部门ID查询 | 否  | 不填，默认获取全量组织架构。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表9]。
   表9获取部门列表输出参数说明 
  | 参数           | 说明             |
  |:---|:---|
  | 部门列表数据       | 部门列表数据。        |
  | 部门id         | 部门ID。          |
  | 部门名称         | 部门名称。          |
  | 部门英文名称       | 部门英文名称。        |
  | 部门负责人的UserID | 部门负责人的UserID 。 |
  | 父部门id        | 父部门ID，根部门为1。   |
  | 父部门中的次序值     | 父部门中的次序值。      |
     
  
 
#### 更新成员
更新成员。
- 输入参数 更新成员执行动作，相关参数说明如[表10]所示。
   表10更新成员输入参数说明 
  | 参数         | 必填 | 说明                                          |
  |:---|:---|:---|
  | 成员UserID   | 否  | 对应管理端的账号，企业内必须唯一。                           |
  | 成员名称       | 否  | 长度为0\~64个字符。                                |
  | 成员别名       | 否  | 长度为0\~64个字符。                                |
  | 手机号码       | 否  | 手机号码，企业内必须唯一。                               |
  | 成员所属部门id列表 | 否  | 成员所属部门ID列表。                                 |
  | 职务信息       | 否  | 长度为0\~128个字符。                               |
  | 性别         | 否  | 1表示男性，2表示女性。                                |
  | 邮箱         | 否  | 长度6\~64个字节，且为有效的email格式。                    |
  | 企业邮箱       | 否  | 长度6\~64个字节，且为有效的企业邮箱格式。                     |
  | 是否为部门负责人   | 否  | 1表示为部门负责人，0表示非部门负责人。个数必须和参数department的个数一致。 |
  | 直属上级UserID | 否  | 设置范围为企业内成员，可以设置最多5个上级。                      |
  | 启用/禁用成员    | 否  | 1表示启用成员，0表示禁用成员。                            |
  | 座机         | 否  | 32字节以内，由纯数字、"-"、"+"或","组成。                  |
  | 地址         | 否  | 长度最大128个字符。                                 |
  | 主部门        | 否  | 主部门。                                        |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表11]。
   表11更新成员输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 返回码  | 返回码。  |
  | 返回信息 | 返回信息。 |
     
  
 
#### 获取成员ID列表
获取成员ID列表。
- 输入参数 获取成员ID列表执行动作，相关参数说明如[表12]所示。
   表12获取成员ID列表输入参数说明 
  | 参数    | 必填 | 说明             |
  |:---|:---|:---|
  | 分页数据量 | 是  | 取值范围为1\~10000。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表13]。
   表13获取成员ID列表输出参数说明 
  | 参数        | 说明         |
  |:---|:---|
  | 用户-部门关系列表 | 用户-部门关系列表。 |
  | 用户userid  | 用户userid。  |
  | 用户所属部门    | 用户所属部门。    |
     
  
 
#### 删除部门
删除部门（注：不能删除根部门，不能删除含有子部门、成员的部门）。
- 输入参数 删除部门执行动作，相关参数说明如[表14]所示。
   表14删除部门输入参数说明 
  | 参数       | 必填 | 说明          |
  |:---|:---|:---|
  | 要删除的部门id | 是  | 指定要删除的部门ID。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表15]。
   表15删除部门输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 返回码  | 返回码。  |
  | 返回信息 | 返回信息。 |
     
  
 
#### 创建成员
创建成员。
- 输入参数 创建成员执行动作，相关参数说明如[表16]所示。
   表16创建成员输入参数说明 
  | 参数         | 必填 | 说明                                          |
  |:---|:---|:---|
  | 成员UserID   | 否  | 对应管理端的账号，企业内必须唯一。                           |
  | 成员名称       | 否  | 长度为0\~64个字符                                 |
  | 成员别名       | 否  | 长度为0\~64个字符                                 |
  | 手机号码       | 否  | 手机号码，企业内必须唯一。                               |
  | 成员所属部门id列表 | 否  | 成员所属部门ID列表。                                 |
  | 职务信息       | 否  | 长度为0\~128个字符。                               |
  | 性别         | 否  | 1表示男性，2表示女性。                                |
  | 邮箱         | 否  | 长度6\~64个字节，且为有效的email格式。                    |
  | 企业邮箱       | 否  | 长度6\~64个字节，且为有效的企业邮箱格式。                     |
  | 是否为部门负责人   | 否  | 1表示为部门负责人，0表示非部门负责人。个数必须和参数department的个数一致。 |
  | 直属上级UserID | 否  | 设置范围为企业内成员，可以设置最多5个上级。                      |
  | 启用/禁用成员    | 否  | 1表示启用成员，0表示禁用成员。                            |
  | 座机         | 否  | 32字节以内，由纯数字、"-"、"+"或","组成。                  |
  | 地址         | 否  | 长度最大128个字符。                                 |
  | 主部门        | 否  | 主部门。                                        |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表17]。
   表17创建成员输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 返回码  | 返回码。  |
  | 返回信息 | 返回信息。 |
     
  
 
#### 修改群聊会话
修改群聊会话。
- 输入参数 修改群聊会话执行动作，相关参数说明如[表18]所示。
   表18修改群聊会话输入参数说明 
  | 参数        | 必填 | 说明         |
  |:---|:---|:---|
  | 群聊id      | 否  | 群聊ID。      |
  | 新的群聊名     | 否  | 新的群聊名。     |
  | 新群主的id    | 否  | 新群主的ID。    |
  | 添加成员的id列表 | 否  | 添加成员的ID列表。 |
  | 踢出成员的id列表 | 否  | 踢出成员的ID列表。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表19]。
   表19修改群聊会话输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 返回码  | 返回码。  |
  | 返回信息 | 返回信息。 |
     
  
 
#### 更新部门
更新部门。
- 输入参数 更新部门执行动作，相关参数说明如[表20]所示。
   表20更新部门输入参数说明 
  | 参数     | 必填 | 说明             |
  |:---|:---|:---|
  | 部门id   | 是  | 部门ID。          |
  | 部门名称   | 否  | 部门中文名称。        |
  | 部门英文名称 | 否  | 部门英文名称。        |
  | 父部门id  | 否  | 32位整型，指定关联父部门。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表21]。
   表21更新部门输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 返回码  | 返回码。  |
  | 返回信息 | 返回信息。 |
     
  
 
#### 撤回应用消息
撤回应用消息。
- 输入参数 撤回应用消息执行动作，相关参数说明如[表22]所示。
   表22撤回应用消息输入参数说明 
  | 参数   | 必填 | 说明    |
  |:---|:---|:---|
  | 消息ID | 否  | 消息ID。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表23]。
   表23撤回应用消息输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 返回码  | 返回码。  |
  | 返回信息 | 返回信息。 |
     
  
 
#### 创建部门
创建部门。
- 输入参数 创建部门执行动作，相关参数说明如[表24]所示。
   表24创建部门输入参数说明 
  | 参数     | 必填 | 说明                              |
  |:---|:---|:---|
  | 部门名称   | 是  | 部门中文名称。                         |
  | 部门英文名称 | 否  | 部门英文名称。                         |
  | 父部门id  | 是  | 32位整型，指定关联父部门。                  |
  | 部门id   | 否  | 32位整型，指定时必须大于1。如果不填该参数，将自动生成ID。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表25]。
   表25创建部门输出参数说明 
  | 参数      | 说明       |
  |:---|:---|
  | 创建的部门id | 创建的部门ID。 |
     
  
 
#### 删除成员
删除成员。
- 输入参数 删除成员执行动作，相关参数说明如[表26]所示。
   表26删除成员输入参数说明 
  | 参数           | 必填 | 说明            |
  |:---|:---|:---|
  | 待删除的成员UserID | 是  | 待删除的成员UserID。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表27]。
   表27删除成员输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 返回码  | 返回码。  |
  | 返回信息 | 返回信息。 |
     
  
 
#### 创建群聊会话
创建群聊会话。
- 输入参数 创建群聊会话执行动作，相关参数说明如[表28]所示。
   表28创建群聊会话输入参数说明 
  | 参数      | 必填 | 说明       |
  |:---|:---|:---|
  | 群聊名     | 否  | 群聊名。     |
  | 指定群主的id | 否  | 指定群主的ID。 |
  | 群成员id列表 | 否  | 群成员ID列表。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表29]。
   表29创建群聊会话输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 群聊id | 群聊ID。 |
     
  
 
#### 发送图片消息
发送图片消息。
- 输入参数 创建发送图片消息执行动作，相关参数说明如[表30]所示。
   表30发送图片消息输入参数说明 
  | 参数        | 必填 | 说明                                                                     |
  |:---|:---|:---|
  | 指定收件人     | 否  | 指定收件人。                                                                 |
  | 指定接收消息的部门 | 否  | 指定接收消息的部门。                                                             |
  | 企业应用的id   | 是  | 企业应用的ID。                                                               |
  | 图片媒体文件id  | 是  | 图片媒体文件ID。                                                              |
  | 表示是否是保密消息 | 否  | 表示是否是保密消息。 0表示可对外分享，1表示不能分享且内容显示水印，默认为0。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表31]。
   表31发送图片消息输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 消息id | 消息ID。 |
     
  
 
#### 发送图文消息
发送图文消息。
- 输入参数 创建发送图文消息执行动作，相关参数说明如[表32]所示。
   表32发送图文消息输入参数说明 
  | 参数        | 必填 | 说明                                                          |
  |:---|:---|:---|
  | 指定收件人     | 否  | 指定收件人。                                                      |
  | 指定接收消息的部门 | 否  | 指定接收消息的部门。                                                  |
  | 企业应用的id   | 是  | 企业应用的ID。                                                    |
  | 图文消息      | 是  | 一条图文消息支持1到8条图文。 支持输入框和数组两种模式。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表33]。
   表33发送图文消息输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 消息id | 消息ID。 |
     
  
 
#### 发送文件消息
发送文件消息。
- 输入参数 创建发送文件消息执行动作，相关参数说明如[表34]所示。
   表34发送文件消息输入参数说明 
  | 参数        | 必填 | 说明               |
  |:---|:---|:---|
  | 指定收件人     | 否  | 指定收件人。           |
  | 指定接收消息的部门 | 否  | 指定接收消息的部门。       |
  | 企业应用的id   | 是  | 企业应用的ID。         |
  | 文件id      | 是  | 可以从调用上传临时素材接口获取。 |
     
  
- 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表35]。
   表35发送文件消息输出参数说明 
  | 参数   | 说明    |
  |:---|:---|
  | 消息id | 消息ID。 |