企微中台

# 聊天管控

员工与客户之间的单聊、群聊信息查看、统计与审计。

2022-04-24：支持对聊天信息进行 NLP 分析，自动给客户打上标签，便于客户画像。

⚠️ 接入方要使用企微中台的统计规则相关功能（如在聊天记录查看界面中展示聊天记录命中了哪些统计规则），接入方需通过接口将自己的统计规则同步到企微中台。

# 依赖配置

  • 允许代开发应用：应用需授权企业客户权限下管理敏感词的权限。

# 配置客户联系

image-20220104153942287

企业微信管理员登录企业微信管理后台，按上图所示，取得 Secret、Token、EncodingAESKey，调用更新企微能力信息接口将这些配置信息同步到企微中台；

此外，还需将接收事件服务器地址配置为企微中台的回调地址；

客户联系的接收事件服务器地址可通过接口获取企微企业回调地址 获取。

# 配置会话存档

image-20220104155007545image-20220104155156510

企业微信管理员登录企业微信管理后台，按上图所示，取得 Secret、Token、EncodingAESKey，配置消息加密公钥、消息加密私钥，调用更新企微能力信息接口将这些配置信息同步到企微中台；

还需配置可信 IP 地址，涉及的 IP 地址为详见企微中台服务器出口 IP 地址；

此外，还需将接收事件服务器地址配置为企微中台的回调地址；

会话存档的接收事件服务器地址可通过接口获取企微企业回调地址 获取。

# 词汇表

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

中文名称 英文名称 英文缩写 值示例 描述
聊天 chat - （GUID） 员工与外部联系人进行的沟通，分为单聊、群聊
聊天记录 chat_record - 聊天中的每一条消息
会话 session - （GUID） 会话指员工和客户的一段聊天记录（单聊），每段会话相互独立，多个会话间不存在重叠
同一个企微中台企业不同企微中台应用的 session_interval 是不一样的，也就是说同一个聊天在不同的企微中台应用的会话列表是不一样的
会话定义间隔 session_interval - 15 单位/分钟，同一聊天中存在两条消息相隔 session_interval 即可划分会话
自然语言处理 Natural Language Processing NLP
拦截规则 sensitive_word_rule 企微成员所发送消息的拦截规则
敏感词 sensitive_word 所拦截的关键词

# 拦截规则说明

  • 一个企微企业最多设置 100 条拦截规则。即企微中台最多允许启用 100 条拦截规则，其余的规则将启用失败，置为禁用状态。
  • 一条拦截规则，允许最多设置 300 个敏感词。
  • 一个企微中台拦截规则，可以关联 0 个到多个项目，如果没有关联项目则该条规则为“全部”，否则为指定项目。
  • 非企微中台创建的企微拦截规则，会定时同步到企微中台，此类数据无法进行编辑、启用/禁用、删除等操作，仅做展示。企微中台内创建的拦截规则可以进行增删改查等操作。

# 页面插件接入

# 聊天记录页面

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

权限代码 权限名称 含义
00 查看 是否可以进入聊天记录功能

# 员工聊天管控页面

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

权限代码 权限名称 含义
00 查看 是否可以进入员工聊天管控功能
01 添加拦截规则 是否可以添加拦截规则
02 编辑拦截规则 是否可以编辑拦截规则
03 删除拦截规则 是否可以删除拦截规则
04 添加统计规则 是否可以添加统计规则
05 添加统计规则分类 是否可以添加统计规则分类
06 删除统计规则 是否可以删除统计规则
07 编辑统计规则 是否可以编辑统计规则
08 删除统计规则分类 是否可以删除统计规则分类
09 编辑统计规则分类 是否可以编辑统计规则分类
10 修改拦截规则状态 是否可以修改拦截规则状态
11 修改统计规则状态 是否可以修改统计规则状态
12 导出触发记录 是否可以导出触发记录
13 查看触发记录会话 是否可以查看触发记录会话

# 客户聊天管控页面

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

权限代码 权限名称 含义
00 查看 是否可以进入员工聊天管控功能
01 添加统计规则 是否可以添加统计规则
02 添加统计规则分类 是否可以添加统计规则分类
03 编辑统计规则 是否可以编辑统计规则
04 删除统计规则 是否可以删除统计规则
05 删除统计规则分类 是否可以删除统计规则分类
06 编辑统计规则分类 是否可以编辑统计规则分类
07 修改统计规则状态 是否可以修改统计规则状态
08 导出触发记录 是否可以导出触发记录
09 查看触发记录会话 是否可以查看触发记录会话

# 聊天超时统计

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

  • 注意：需开通会话存档才能使用此功能
权限代码 权限名称 含义
00 查看 是否可以进入聊天超时统计功能
01 新增超时提醒规则 是否可以新增超时提醒规则
02 编辑超时提醒规则 是否可以编辑超时提醒规则
03 删除超时提醒规则 是否可以删除超时提醒规则
04 导出超时统计明细数据 是否可以导出超时统计明细数据

# 前端交互

# 自定义搜索客户条件

接入方可添加自定义筛选条件，通过 postMessage 方法使用特定的事件 type，将筛选数据传入企微中台页面。custom_condition 字段的具体值与格式，由接入方前后端自行约定格式。 示例：

// postMessage 方法
const postMessage = (
  target: Window,
  msg: {
    type: string
    [props: string]: any
  }
): void => {
  const message = JSON.stringify(msg)
  target?.postMessage(message, '*')
}
// iframe对象
const target = iframeRef.current.getEleInstance()
postMessage(target.contentWindow, {
    type: 'CHAT_RECORD_SEARCH_PARAMS_CHANGE', // 聊天记录页面postMessage的type值
    payload: [{key:"project_id", value:"12345"}] // 里面的key值需要接入方前后端自行约定，value为对应的key的数据
})

img

# 领域模型

（暂无）

# 对外开放 API

API 名称 定义 说明
注册统计规则分类 查看
更新统计规则分类 查看
删除统计规则分类 查看
注册统计规则 查看
更新统计规则 查看
删除统计规则 查看
启用统计规则 查看
禁用统计规则 查看
迁移已有统计规则触发记录 查看
获取指定客户的单聊列表 查看
获取产生过聊天记录的客户 id 列表 查看
写入聊天记录 查看
获取单聊详情 查看
获取指定成员的群聊列表 查看
获取企微中台支持分析的 NLP 标签组列表 查看
配置应用的聊天记录 NLP 分析 查看
获取聊天会话列表 查看
查询聊天会话详情 查看
批量查询聊天会话详情 查看
获取客户的 NLP 标签列表 查看
拉取聊天记录 查看
获取指定聊天记录 查看
获取统计规则的触发记录 查看
拉取统计规则的触发记录 查看
获取指定外部联系人的关键词触发情况 查看
查询群聊信息 查看
搜索聊天记录 查看
拉取指定聊天的聊天记录 查看
查询开通会话存档的所有员工 id 查看

# 接入方需提供的 API

API 名称 中台代码 是否必须实现 定义 说明
获取项目列表 GetProjectList 是 查看
获取员工列表 GetQwUserList 是 查看
获取聊天记录页的客户列表 ListChatExternalUser 是 查看
获取聊天记录页的员工列表 ListChatEmployee 是 查看

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

事件 定义 说明
会话产生事件 查看
会话 NLP 分析成功事件 查看
聊天消息产生事件 查看
触发记录产生事件 查看

← 公费电话 →