# 创建群发任务

请求方式: POST(HTTPS

请求地址: https://nbd-api.myscrm.cn/open-nbd-qw-groupmsg/v1/groupmsg/add

请求参数说明:

名称 类型 必须 说明
app_id string 企微中台应用 id
proj_list array 项目列表
proj_list.organ_proj_id string 项目 id
proj_list.organ_proj_name string 项目名称
custom_condition array 自定义筛选群发客户条件
custom_condition.code string 条件编码
custom_condition.values string 条件值,多个逗号分割
msg_name string 消息名称
msg_text string 消息文本(文本和附件不能同时为空)
customer_filter_type int32 客户筛选类型:1-按条件筛选,2-全部客户
customer_tag_rule int32 标签规则类型:1-任意满足,2-所有满足,3-不包含
groupmsg_employee_list array 关联员工的企微用户
groupmsg_employee_list.qw_user_id string 企微成员 id
groupmsg_employee_list.qw_user_name string 企微成员姓名
corp_tags string[] 群发客户标签 id 列表(按标签筛选时,标签不能为空)
chat_type string 群发任务类型:single-单聊(默认),group-客户群
qw_external_userids string[] 企微客户 id 列表
creator_id string 创建人 id
creator_name string 创建人名称
groupmsg_attachment_list array 消息附件
groupmsg_attachment_list.type int32 附件类型:1-图片,2-小程序,3-H5,4-视频,5-文件
groupmsg_attachment_list.img_url string 图片 URL(附件类型为图片时必填)
groupmsg_attachment_list.h5_href string h5 链接(附件类型为 h5 时必填)
groupmsg_attachment_list.h5_title string h5 标题
groupmsg_attachment_list.h5_description string h5 描述(附件类型为 h5 时必填)
groupmsg_attachment_list.h5_cover_url string h5 封面(附件类型为 h5 时必填)
groupmsg_attachment_list.video_url string 视频 url(附件类型为视频时必填)
groupmsg_attachment_list.file_url string 文件 url(附件类型为文件时必填)
groupmsg_attachment_list.is_custom_miniprogram bool 是否自定义小程序
groupmsg_attachment_list.miniprogram_title string 小程序标题
groupmsg_attachment_list.miniprogram_appid string 小程序 appid(附件类型为小程序时必填)
groupmsg_attachment_list.miniprogram_page_group string 选择已有小程序时的页面分类
groupmsg_attachment_list.miniprogram_page_name string 选择已有小程序时的页面名称
groupmsg_attachment_list.miniprogram_url string 小程序路径(附件类型为小程序时必填)
groupmsg_attachment_list.miniprogram_pic_url string 小程序封面 url(附件类型为小程序时必填)
create_source int32 创建来源:1-企业创建,2-个人创建
creator_type int32 创建人类型:1-后台登录用户id,2-企微成员id

请求示例:

{
  "app_id": "39fdf97b-2bc3-010d-82cd-e12d78b15714",
  "create_source": 1,
  "creator_type": 1,
  "custom_condition": [
    {
      "code": "sdaf",
      "values": "brew,nte"
    },
    {
      "code": "489",
      "values": "g432g"
    }
  ],
  "proj_list": [
    {
      "organ_proj_id": "345",
      "organ_proj_name": "123"
    },
    {
      "organ_proj_id": "8496",
      "organ_proj_name": "2g42"
    }
  ],
  "msg_name": "123",
  "msg_text": "456789",
  "customer_filter_type": 1,
  "customer_tag_rule": 1,
  "groupmsg_employee_list": [
    {
      "qw_user_id": "godfrey",
      "qw_user_name": "godfrey"
    }
  ],
  "corp_tags": ["456"],
  "chat_type": "single",
  "qw_external_userids": ["wm-TUtCAAAdw4KNTqJJUttqJda9K5vdg"],
  "creator_id": "string",
  "creator_name": "string",
  "groupmsg_attachment_list": [
    {
      "type": 1,
      "img_url": "https://img.myscrm.cn/dist/fe-nbd-qw-guide-202111260832-test/assets/img/kf-domain.f8396b65.png"
    }
  ]
}

返回数据:

{
  "errcode": 0,
  "errmsg": "ok",
  "groupmsg_id": "3a007784-085e-2039-4c86-6261fe641d20"
}

返回参数说明:

参数 类型 说明
groupmsg_id string 创建的群发客户 id