企微中台

# 群发工具

提供群发客户、群发客户群、群发朋友圈、历史朋友圈四大功能。

# 词汇表

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

中文名称 英文名称 英文缩写 值示例 描述
群发客户 groupmsg 可用于企业给客户/客户群发送消息。
企微标签 corp_tag tag 企微客户的公共标签，可用于筛选要发送的客户列表。
群发客户 groupmsg_customer 企微外部联系人，用于发送消息给目标客户。
群发朋友圈任务 job 企业统一创建群发朋友圈任务，由成员确认后发表
群发朋友圈 moment 企微外部联系人，用于发送消息给目标客户。

# 页面插件权限控制

# 群发客户能力编码：groupmsg

使用方法请参见页面插件接入章节

权限代码 权限名称 含义
00 查看 是否可以进入群发客户功能
01 新增 是否可以创建新的群发客户
02 删除 是否可以删除群发任务
03 提醒 是否可以给员工发送群发任务提醒
04 停止任务 是否可以停止群发任务

# 群发客户群能力编码：groupchat_message

使用方法请参见页面插件接入章节

权限代码 权限名称 含义
00 查看 是否可以进入群发客户群功能
01 添加/复制 是否可以添加或复制群发客户群
02 编辑 是否可以编辑群发客户群数据
03 删除 是否可以删除群发客户群数据
04 导出成员列表 是否可以导出成员列表数据
05 导出客户列表 是否可以导出客户列表
06 提醒 是否可以给员工发送群发任务提醒
07 停止任务 是否可以停止群发任务

# 群发朋友圈管理能力编码：moment_manage

使用方法请参见页面插件接入章节

权限代码 权限名称 含义
00 查看 是否可以查看群发朋友圈功能
01 发表群发朋友圈 是否可以发表群发朋友圈
02 编辑群发朋友圈 是否可以编辑群发朋友圈任务
03 查看任务 是否可以查看群发朋友圈任务详情
04 项目选择全部 是否可以项目选择全部
05 导出任务详情成员、客户统计列表 是否可以导出任务详情成员、客户统计列表
06 提醒 是否可以给员工发送群发任务提醒
07 删除群发朋友圈任务 是否可以删除群发朋友圈任务
08 停止任务 是否可以停止群发任务

# 历史朋友圈能力编码：moment_history

使用方法请参见页面插件接入章节

权限代码 权限名称 含义
00 查看 是否可以查看历史朋友圈功能
01 查看详情 是否可以查看历史朋友圈详情

# 领域模型

# 群发朋友圈

nbd-qw-moment

# 对外开放 API

# 群发客户

API 名称 定义 说明
创建群发任务 查看
获取群发任务详情 查看
获取群发任务列表 查看
查询群发成员统计列表 查看
查询客户/群的统计列表 查看
获取移动端群发任务列表 查看
查询单个群发任务结果统计 查看

# 群发朋友圈

API 名称 定义 说明
检查是否创建过朋友圈 查看
创建朋友圈任务 查看
查询朋友圈任务列表 查看
根据任务 id 获取朋友圈任务详情 查看
查询单个任务统计 查看
查询任务成员列表 查看
查询朋友圈任务客户列表 查看
查询移动端朋友圈任务列表 查看

# 接入方需提供的 API

# 获取项目列表

查看

# 获取员工列表

查看

# 查询客户列表

根据成员或企业标签批量查询客户列表

企微中台 API 代码： GetCustomerList

请求方式： POST（HTTPS）

请求参数说明：

参数 必须 说明
app_id 是 企微应用 Id
qw_user_ids 是 企微成员 ID
project_ids 是 项目 ID 列表
qw_tag_ids 否 企微标签 ID（空表示不过滤）
customer_tag_rule 否 标签过滤规则：1-任意满足（默认），2-所有满足，3-不包含
custom_condition 否 自定义参数
custom_condition.code 否 参数编码
custom_condition.values 否 参数值，多个用逗号分隔
is_page 是 是否需要分页，2022-08-22 起恒为 true，接入方无需再支持非分页拉取的情况
pager 是 分页参数
pager.page 是 页码
pager.page_size 是 分页行数

请求示例：

{
  "app_id": "39febd1b-3293-1c24-6539-b3babc06ac2b",
  "qw_user_ids": ["SuiFeng"],
  "project_ids": ["39d5981b-40e3-5428-cf4f-4c5e1f9cf0da"],
  "qw_tag_ids": ["L(oMKB"],
  "customer_tag_rule": 1,
  "custom_condition": [
    {
      "code": "customer_status",
      "values": "2,3"
    }
  ],
  "is_page": true,
  "pager": {
    "page": 1,
    "page_size": 10
  }
}

返回数据：

{
  "errcode": 0,
  "errmsg": "ok",
  "ext_user_list": [
    {
      "ext_user_id": "wm-TUtCAAAG07kKgnR-PwfYLXVqu4IOw",
      "name": "随風"
    },
    {
      "ext_user_id": "wm-TUtCAAAcAkqTbJLQBIzSsudI_-Faw",
      "name": "qx9"
    }
  ],
  "pager": {
    "page": 1,
    "page_size": 10,
    "total_rows": 2
  }
}

返回参数说明：

名称 说明
ext_user_list 客户列表
ext_user_list.ext_user_id 外部联系人 Id
ext_user_list.name 外部联系人名称
pager 分页参数
pager.page 页码
pager.page_size 分页行数
pager.total_rows 总记录数

# 接入方自定义标签

可以通过接入方的自定义标签来进行接入方数据按标签条件查询、给企微中台数据打上标签等。（列表只需提供具体选项值，无需提供”全部“项）

⚠️ 用于请求接入方查询客户列表时筛选客户使用的。如无需求则不必实现。

image-20210820183118925

企微中台 API 代码： GetCustomerCondition

企微中台 API 代码： OrganCustomTagList

请求方式： POST（HTTPS）

请求参数说明：

名称 类型 必须 说明
app_id string 是 企微应用 ID
organ_proj_id string 是 项目 id,多个以逗号分隔
scene int32 是 场景代码：0-群发客户标签筛选（默认），1-渠道码自定义标签

请求示例：

{
  "app_id": "xxxx",
  "organ_proj_id": "xxx",
  "scene": 0
}

返回数据：

{
  "errcode": 0,
  "errmsg": "ok",
  "scene": 0,
  "list": [
    {
      "title": "留电状态",
      "code": "mobile_status",
      "type": "radio",
      "desc": "这是描述文字",
      "items": [
        {
          "name": "未留电",
          "value": "1"
        },
        {
          "name": "已留电",
          "value": "2"
        }
      ]
    },
    {
      "title": "客户状态",
      "code": "customer_status",
      "type": "checkbox",
      "desc": "这是描述文字",
      "items": [
        {
          "name": "未关联",
          "value": "-1"
        },
        {
          "name": "问询中",
          "value": "2"
        },
        {
          "name": "来访",
          "value": "3"
        },
        {
          "name": "认筹",
          "value": "4"
        },
        {
          "name": "认购",
          "value": "5"
        },
        {
          "name": "签约",
          "value": "6"
        }
      ]
    },
    {
      "title": "自动标签",
      "code": "cdp_tag",
      "type": "cascade",
      "desc": "这是描述文字",
      "first_selector": {
        "items": [
          {
            "name": "满足所有选中的标签",
            "value": "1",
            "code": "cdp_tag_rule"
          },
          {
            "name": "满足任意选中的标签",
            "value": "2",
            "code": "cdp_tag_rule"
          },
          {
            "name": "不包含选中的标签",
            "value": "3",
            "code": "cdp_tag_rule"
          }
        ],
        "title": "自动标签筛选规则",
        "code": "cdp_tag_rule",
        "type": "select"
      },
      "items": [
        {
          "name": "基础信息",
          "code": "base_info",
          "value": "1001",
          "items": [
            {
              "name": "性别",
              "code": "sex",
              "value": "1001001",
              "items": [
                {
                  "name": "男",
                  "code": "sex",
                  "value": "0"
                },
                {
                  "name": "女",
                  "code": "sex",
                  "value": "1"
                }
              ]
            },
            {
              "name": "年龄段",
              "code": "age",
              "value": "1001001",
              "items": [
                {
                  "name": "80后",
                  "code": "age",
                  "value": "1"
                },
                {
                  "name": "90后",
                  "code": "age",
                  "value": "2"
                },
                {
                  "name": "00后",
                  "code": "age",
                  "value": "3"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

返回参数说明：

名称 类型 说明
scene int32 场景代码
list object [] 标签模块列表
list.title string 模块标题
list.code string 模块编码
list.type string 类型：radio-单选，checkbox-多选，cascade-级联多选
list.desc string 描述文本
list.first_selector object 首选条件，级联选择器下可用于圈标签范围，选填
list.first_selector.title string 筛选模块标题
list.first_selector.code string 编码
list.first_selector.type string 类型：select-单选
list.first_selector.items object [] 筛选子项
list.first_selector.items.name string 选项名称，用于页面展示
list.first_selector.items.code string 选项编码，用于回传给接入方
list.first_selector.items.value string 选项值，用于回传给接入方
list.items object [] 筛选子项
list.items.name string 选项名称，用于页面展示
list.items.code string 选项编码，用于回传给接入方
list.items.value string 选项值，用于回传给接入方
list.items.items object [] 子级列表，级联选择器时可以放数据
list.items.items.name string 子级选项名称，用于页面展示
list.items.items.code string 子级选项编码，用于回传给接入方
list.items.items.value string 子级选项值，用于回传给接入方

# 获取群发客户发送成员（非必需）

当客户存在多个归属成员时，根据接入方特定逻辑指定客户由哪位成员来发送群发消息。 如果没有提供该查询接口，中台将由采用随机方式进行发送。

企微中台 API 代码： GetGroupMsgSender

请求方式： POST（HTTPS）

请求参数说明：

参数 类型 必须 说明
app_id string 是 企微应用 Id
project_ids string[] 是 项目 Id 列表（创建群发客户时的项目）
list object[] 是 客户列表，数组长度最大 100
list.external_userid string 是 客户 ID
list.qw_user_ids string[] 是 群发备选企微成员 id 列表

请求示例：

{
  "app_id": "39febd1b-3293-1c24-6539-b3babc06ac2b",
  "project_ids": ["39d5981b-40e3-5428-cf4f-4c5e1f9cf0da"],
  "list": [
    {
      "external_userid": "wm-TUtCAAAINkcMAY_Nml0ZAYxrM64lw",
      "qw_user_ids": ["WuTingTing", "sun", "weishaoyong", "WangMing", "ZengShanCheng1", "jjjjjjj"]
    },
    {
      "external_userid": "wm-TUtCAAAjUeLSWw_rdcGrVFQVCBcpw",
      "qw_user_ids": ["godfrey", "weishaoyong", "NongCuiMei", "ZengShanCheng1"]
    }
  ]
}

返回数据：

{
  "errcode": 0,
  "errmsg": "ok",
  "list": [
    {
      "external_userid": "wm-TUtCAAAINkcMAY_Nml0ZAYxrM64lw",
      "qw_user_id": "weishaoyong"
    },
    {
      "external_userid": "wm-TUtCAAAG07kKgnR-PwfYLXVqu4IOw",
      "qw_user_id": "godfrey"
    }
  ]
}

返回参数说明：

参数 类型 说明
list object[] 客户列表，数组长度最大 100
list.external_userid string 客户 ID
list.qw_user_id string 使用该企微成员 id 进行发送

# 获取接入方自定义的素材库

请参见这里

# 获取接入方自定义的素材类型列表

请参见这里

# 获取接入方自定义分类下素材列表

请参见这里

# 包装素材

请参见这里

← 聊天管控 →