# 渠道码
渠道码依赖企业微信的客户联系和消息推送功能，帮助员工拓展客户，并标识客户加入的渠道。以满足对渠道进行分析的管理功能。
# 词汇表
词汇表是统一语言的一部分。英文将用于源代码中。
| 中文名称 | 英文名称 | 英文缩写 | 值示例 | 描述 |
|---|---|---|---|---|
| 渠道 | 吸引、添加客户的方式。例如一个活动、一个广告易拉宝 | |||
| 渠道码 | channel_code | 企微中台的渠道码功能。其包含渠道信息，关联的项目、成员，以及供添加客户并关联具体成员归属的多个渠道二维码。 | ||
| 裂变渠道码 | 多层级裂变的渠道码，将记录上下游裂变关系。接入方可以设置奖励实现类似病毒传播效果 （渠道二维码被扫码添加客户后，客户可以再生成包含其信息的新二维码。） | |||
| 渠道二维码 | qr_code_url | （url） | 供渠道扫码添加企微客户的二维码（对应企微的客户联系「联系我」里的二维码 (opens new window)）。 | |
| 渠道分组 | channel group | 用来做业务分组和后台查看权限 | ||
| 全局渠道码分组 | 标识此分组下的渠道码可以被所有渠道码管理员看到。 | |||
| 项目 | project | 接入方传入的项目，用于标识渠道码的关联 | ||
| 员工 | employee | 接入方的员工。拥有企微帐号属性，以便与企微中台数据打通 | ||
| 企微帐号 | qw_user_id、qw_userid | zhouyong | 企微里的 userid，即所谓的企业微信成员账号(qq.com) (opens new window)。 | |
| 企微客户 id | qw_external_userid | 企微成员添加的客户。在企微内部称之为外部联系人的 userid（关于 ExternalUserId - 企业微信 API (opens new window)） | ||
| 接入方 | organ | 使用企微中台渠道码能力的组织（企微中台服务组织）。 | ||
| 接入方跟踪 id | 接入方跟踪 id | (string) | 供接入方实现裂变跟踪的标识（接入方保证唯一）。此内容由企微中台调用接入方的 API 获取。 |
# 页面插件权限控制
# 能力编码：channel_code
使用方法请参见页面插件接入章节
| 权限代码 | 权限名称 | 含义 |
|---|---|---|
| 00 | 查看 | 是否可以进入渠道码功能 |
| 01 | 新增 | 是否可以创建新的渠道码 |
| 02 | 编辑 | 是否可以编辑已有的渠道码 |
| 03 | 删除 | 是否可以将一个渠道码删除或置为失效 |
| 04 | 分组管理 | 控制是否可以管理分组 |
| 05 | 提醒 | 是否可以操作提醒渠道成员 |
数据权限
| 权限代码 | 权限名称 | 含义 |
|---|---|---|
| hideGlobalproject | 项目选择-全局 | 选择关联项目时是否可选全局 |
# 领域模型
# 裂变渠道码
# 裂变渠道码创建序列
# 裂变渠道码扫码交互序列
# 对外开放 API
| API 名称 | 定义 | 说明 |
|---|---|---|
| 创建渠道码 | 查看 | |
| 编辑渠道码 | 查看 | |
| 失效渠道码 | 查看 | |
| 删除渠道码 | 查看 | |
| 获取渠道分组 | 查看 | |
| 查询渠道码列表 | 查看 | |
| 查询渠道码信息 | 查看 | |
| 获取渠道二维码地址 | 查看 | |
| 获取裂变渠道码列表 | 查看 | |
| 获取裂变渠道二维码 | 查看 | |
| 根据接入方裂变 id 获取渠道码列表 | 查看 | |
| 生成活动关联的裂变渠道码 | 查看 | |
| 查询客户是否已添加企微成员 | 查看 | |
| 成员客户统计 | 查看 | |
| 每日客户统计 | 查看 | |
| 获取员工的渠道码页面 URL | 查看 | |
| 检查是否创建过二维码 | 查看 | |
| 根据 state 和企微成员获取跟踪 Id | 查看 |
# 接入方需提供的 API
| API 名称 | 中台代码 | 是否必须实现 | 定义 | 说明 |
|---|---|---|---|---|
| 获取项目列表 | GetProjectList | 是 | 查看 | |
| 获取员工列表 | GetQwUserList | 是 | 查看 | |
| 获取小程序列表 | GetChannelMiniProgramList | 是 | 查看 | |
| 获取小程序页面列表 | GetChannelMiniProgramPages | 是 | 查看 | |
| 获取接入方跟踪 id | GetOrganTrackId | 否 | 查看 | 在使用裂变渠道码时需提供 |
| 通知裂变 | NotifyFission | 否 | 查看 | 在使用裂变渠道码时需提供 |
| 获取接入方自定义素材类型列表 | GetCustomMaterialTypeList | 否 | 查看 | 在需自定义欢迎语功能时提供 |
| 获取接入方自定义素材列表 | GetCustomMaterialList | 否 | 查看 | |
| 获取接入方素材 | GetCustomMaterial | 否 | 查看 | |
| 获取创建裂变渠道码权限点 | GetAuthorityPointList | 否 | 查看 | 通过裂变活动跳转创建渠道码场景需实现该接口 |
| 获取裂变活动详情 | GetFissionActivity | 否 | 查看 | 通过裂变活动跳转创建渠道码场景需实现该接口 |
| 接入方自定义标签 | OrganCustomTagList | 否 | 查看 | 接入方需要给渠道码打上自定义的标签时需实现 |
# 接收企业微信推送事件
企微中台会将企微推送的事件原样推送给接入方（这块请参阅企微中台的消息处理章节内容），接入方按需注册自己的事件处理 API。 涉及的事件请参阅企业微信 API (qq.com) (opens new window)中与“企业客户”相关的事件。
# 支持订阅的企微中台事件
| 事件 | 定义 | 说明 |
|---|---|---|
| 渠道码变更事件 | 查看 |