企微中台

# 成员服务

# 依赖配置

# 配置应用的回调事件

请参见这里

# 配置通讯录的回调事件

如果接入方使用的是自建应用，还需将通讯录的回调配置为企微中台的回调地址，包括成员添加、成员删除、成员编辑事件；

自建应用的通讯录回调地址可通过接口获取企微企业回调地址 获取。

# 配置客户联系

非密文代开发应用需配置客户联系，请参见这里

# 词汇表

词汇表是统一语言的一部分。英文将用于源代码中。

中文名称 英文名称 英文缩写 值示例 描述
在职员工 member 在企业微信中未离职的员工
原跟进成员企微 id qw_userid_handover 离职成员企微 userId。即企业微信成员账号 (opens new window)
接替成员企微 userId qw_userid_takeover 分配成员企微 userId。即企业微信成员账号 (opens new window)
企微外部联系人 id qw_external_userid 企微成员添加的客户。在企微内部称之为外部联系人的 userid（关于 ExternalUserId - 企业微信 API (opens new window)）

# 页面插件接入

# 离职继承

能力编码：quit_inherit，离职继承（员工）、离职继承（客户）页面权限相同。使用方法请参见页面插件接入章节

权限代码 权限名称 含义
00 查看 是否可以进入离职继承功能
01 分配客户/分配群聊 是否可以分配客户或群聊

⚠️ 页面筛选栏需要接入方实现，接入方通过 postMessage 方法使用特定的事件 type，将筛选数据传入能力页面：

img

离职继承(客户)的 type 为固定值 leave-inherit-customer-search，传参示例：

{
  "type": "leave-inherit-customer-search",
  "payload": {
    "assigned_end_time": "2022-06-11 23:59:59", // 分配结束时间
    "assigned_start_time": "2022-06-01 00:00:00", // 分配开始时间
    "assigner_id": "39ccde38-9e4e-8abc-0d83-e8498d55e948", // 分配人信息
    "condition": "[{\"key\":\"project_id\",\"value\":\"39d599cd-f4ab-a9a4-f8c2-d9be20d5b88b\"},{\"key\":\"mobile_status\",\"value\":1},{\"key\":\"customer_status\",\"value\":2}]", // 接入方自定义条件，传入接入方后台能识别的 json 字符串
    "customer_name": "大", // 搜索客户名称
    "transfer_status": 1 // 继承状态
  }
}

离职继承(员工)的 type 为固定值 leave-inherit-employee-search，传参示例：

{
  "type": "leave-inherit-employee-search",
  "payload": {
    "former_end_time": "2022-07-07", // 筛选离职结束时间
    "former_start_time": "2022-06-03", // 筛选离职开始时间
    "qw_user_name": "大", // 员工名称
    "condition": "[{\"key\":\"project_id\",\"value\":\"39d599cd-f4ab-a9a4-f8c2-d9be20d5b88b\"}]" // 接入方自定义条件，传入接入方后台能识别的 json 字符串
  }
}

# 在职继承

能力编码：on_job_inherit。使用方法请参见页面插件接入章节

权限代码 权限名称 含义
00 查看 是否可以进入在职继承功能
01 分配客户 是否可以分配客户

# 客户流失提醒

能力编码：customer_churn_statistics。使用方法请参见页面插件接入章节

权限代码 权限名称 含义
00 查询 是否可以进入"客户流失统计"
01 流失提醒规则 是否可以操作流失提醒规则
02 流失统计 是否可以查看流失统计
03 流失记录 是否可以查看流失记录
04 新增提醒规则 是否可以操作新增提醒规则
05 编辑提醒规则 是否可以操作编辑提醒规则
06 删除提醒规则 是否可以操作删除提醒规则

# 领域模型

（暂无）

# 对外开放 API

API 名称 定义 说明
获取在职员工信息 查看
获取在职员工列表 查看
批量获取在职员工信息 查看
更新员工敏感信息 查看 接入方需在员工 oauth2 授权后，将敏感信息上报到企微中台
删除员工 查看
获取客户详情 查看
通过 unionid 获取客户详情 查看
获取客户归属成员列表 查看
绑定 external_userid 和 unionid 查看 代开发应用需接入方在获取到 external_userid 和 unionid 的关联关系后，将其上报至企微中台
密文 qw_user_id 转换为明文 查看
明文 qw_user_id 转换为密文 查看
密文 external_userid 转换为明文 查看
明文 external_userid 转换为密文 查看
获取企业标签库 查看
添加企业客户标签 查看
编辑企业客户标签 查看
删除企业客户标签 查看
编辑客户企业标签 查看
批量获取客户归属成员 查看
创建离职继承 查看
查询离职员工的继承情况 查看
创建在职继承 查看

# 接入方需提供的 API

API 名称 中台代码 是否必须实现 定义 说明
获取项目列表 GetProjectList 否 查看 接入离职继承、在职继承时必须实现
获取员工列表 GetQwUserList 否 查看 接入在职继承时必须实现
获取符合自定义条件的离职员工列表 GetFormerQwUserList 否 查看 接入离职继承时必须实现
获取符合自定义条件的客户列表 ListCustomer 否 查看 接入离职继承时必须实现
批量获取客户信息 BatchGetCustomer 否 查看

# 支持订阅的企微中台事件

事件 定义 说明
客户继承状态变更事件 查看 适用于离职继承和在职继承

← 消息服务 →