网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2023-11-10 GMT+08:00
分享

企业微信(服务端)

企业微信(服务端)提供企业管理员对企业服务及企业微信的集成,包含“获取群聊会话”、“推送应用文本消息”等执行动作。

连接参数

企业微信(服务端)连接器使用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

企业管理密钥

应用的密钥。

获取群聊会话

用户可通过调用该接口与机器人进行会话。

  • 输入参数

    获取群聊会话执行动作,相关参数说明如表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。

相关文档