群发任务创建

最后更新:2024/12/11

企业可通过此接口来创建群发任务。

组合素材内除文本以外的附件需满足以下需求:
群发客户/群发客户群最多9个附件,小程序附件需绑定到企业微信工作台
群发朋友圈支持9图或1个其他非小程序的附件

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/mass_send/corp/msg_task/create

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "text_content": "fake_data",
  "material_id_list": [
    62
  ],
  "create_user_id": "fake_data",
  "type": 13,
  "range_filter_extra_type": 1,
  "task_name": "fake_data",
  "is_all_customer": true,
  "task_end_time": 12345,
  "extra": "{\"params\":[{\"userid\":\"tommy\",\"external_userid\":[\"woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA\"]}]}",
  "material_send_dto": [
    {
      "material_id": 2583047807773007618,
      "send_type": 1
    },
    {
      "material_id": 3583047852610117377,
      "send_type": 2
    }
  ],
  "send_self": 1
}
参数 类型 必填 说明
text_content string 发送内容(发送内容与素材id不能同时为空)
task_name string 群发任务名称,默认任务名称为:[客户触达任务],最大长度为30个字符
material_id_list array 素材id集合,素材ID类型为long,集合长度最大为9,发送内容与素材id不能同时为空
create_user_id string 创建者id
如sendself为1,如extra中userid和创建人create_user_id不同,则创建人取值为extra::userid
type int 群发任务类型
10:群发客户-员工一键发送(原企业群发客户);
11:群发客户群-员工一键发送(原企业群发客户群);
12:群发朋友圈-员工一键发送(原企业群发朋友圈);
13:群发客户-通知员工转发(原个人群发客户);
14:群发客户群-通知员工转发(原个人群发客户群);
15:群发朋友圈-通知员工转发(原个人群发朋友圈);
range_filter_extra_type int 筛选条件扩展类型,1-员工与部门,2-员工与客户 或 员工与客户群.默认值:1
extra string 扩展属性
is_all_customer bool 是否群发全部客户,默认false.
当type为10,12,13,15时候,该字段生效;
当该字段为true,extra字段的数据失效,当该字段为false,extra字段的数据生效;
is_all_customer_group bool 是否群发全部客户群,默认false.
当type为11,14时候,该字段生效;
当该字段为true,extra字段的数据失效,当该字段为false,extra字段的数据生效;
task_end_time long 群发任务结束时间,格式:时间戳,精度:秒,不填则默认当前时间+48小时。结束时间需大于开始时间最少59分钟,且自动提醒时间不得小于开始时间。
如senself为1,则任务结束时间-任务开始时间不得大于48小时。
material_send_dto Object[] 素材信息集合,最大长度为9。不支持传入文本类型素材
  material_id long 素材id
  send_type int 素材发送方式1.轨迹形式;2.普通形式;(仅文章/网页/文件/视频类型素材支持)
allow_select bool 是否允许成员在待发送客户列表中重新进行选择,默认为false。仅企业群发客户和客户群支持
send_self int 发送我的客户,开启则填写1;仅群发客户-员工一键发送(type=10)和群发朋友圈-员工一键发送(type=12)这两种任务类型填写后生效。
time_config int 自动提醒时间配置 (1代表15分钟,2代表30分钟,3代表1小时,4代表2小时。默认为2)

注:当material_send_dto有传入素材信息时,material_id_list可以为空

extra参数说明:

type=10 企业群发客户

参数 类型 必填 说明
params array 当前params集合中所有客户id总数之和不能超过1万个
userid string 用户id,如sendself为1时,则仅支持传入1个员工
external_userid array 客户id
{
  "params": [
    {
      "userid": "tommy",
      "external_userid": [
        "woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA"
      ]
    }
  ]
}

type=11并且range_filter_extra_type=1 企业群发客户群-员工与部门

参数 类型 必填 说明
user_ids array 用户ID数组,用户ID类型为string
dept_ids array 部门ID数组,部门ID类型为long
group_names array 客户群名称数组,客户群名称类型为string
tag_ids array 标签ID数组,标签ID类型为string
tag_operator int tag_ids标签集合内的运算规则,1:满足任意一个标签;2:同时满足所有标签;3:无标签客户,默认值:1
exclude_tag_ids array 剔除标签ID数组,标签ID类型为string
exclude_tag_operator int exclude_tag_ids标签集合内的运算规则,1:满足任意一个标签;2:同时满足所有标签;3:无标签客户,默认值:1
{
  "user_ids": [
    "test_2f98805fd705"
  ],
  "dept_ids": [
    98
  ],
  "group_names": [
    "test_ffa696ddc47e"
  ],
  "tag_ids": [
    "test_7e7b4071c902"
  ],
  "tag_operator": 1,
  "exclude_tag_ids": [
    "test_58d63ee969a9"
  ],
  "exclude_tag_operator": 2
}

type=11并且range_filter_extra_type=2 企业群发客户群-员工与客户群

参数 类型 必填 说明
params array
userid string 用户id,如sendself为1时,则仅支持传入1个员工
chat_id array 客户群id
{
  "params": [
    {
      "userid": "test_0c85c64997df",
      "chat_id": [
        "test_b318a467fbc0"
      ]
    }
  ]
}

type=12 企业群发朋友圈

参数 类型 必填 说明
user_ids array 用户ID数组,用户ID类型为string,如sendself为1,则仅支持传入1个员工
dept_ids array 部门ID数组,标签ID类型为long
tag_group_infos array 标签组信息
tag_group_id string 标签组ID
tag_infos array 仅支持企微标签,不支持业务标签、内部标签
tag_id string 标签ID
{
  "user_ids": [
    "fake_data"
  ],
  "dept_ids": [
    123
  ],
  "tag_group_infos": [
    {
      "tag_group_id": "fake_data",
      "tag_infos": [
        {
          "tag_id": "fake_data"
        }
      ]
    }
  ]
}

type=13并且range_filter_extra_type=1 个人群发客户-员工与部门

参数 类型 必填 说明
user_ids array 用户ID数组,用户ID类型为string
dept_ids array 部门ID数组,标签ID类型为long
tag_group_infos array 标签组信息
tag_group_id string 标签组ID
tag_infos array 仅支持企微标签、业务标签,不支持内部标签
tag_id string 标签ID
{
  "user_ids": [
    "fake_data"
  ],
  "dept_ids": [
    123
  ],
  "tag_group_infos": [
    {
      "tag_group_id": "fake_data",
      "tag_infos": [
        {
          "tag_id": "fake_data"
        }
      ]
    }
  ]
}

type=13并且range_filter_extra_type=2 个人群发客户-员工与客户

参数 类型 必填 说明
params array 当前params集合中所有客户id总数之和不能超过1万个
userid string 用户id,如sendself为1时,则仅支持传入1个员工
external_userid array 客户id
{
  "params": [
    {
      "userid": "tommy",
      "external_userid": [
        "woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA"
      ]
    }
  ]
}

type=14 个人群发客户群

参数 类型 必填 说明
user_ids array 用户ID数组,用户ID类型为string
dept_ids array 部门ID数组,标签ID类型为long
group_names array 群名称关键词数组,群名称关键字为string
tag_ids array 企业标签ID数组,标签ID类型为string
{
  "user_ids": [
    "fake_data"
  ],
  "dept_ids": [
    123
  ],
  "group_names": [
    "fake_data"
  ],
  "tag_ids": [
    "fake_data"
  ]
}

type=15 个人群发朋友圈

参数 类型 必填 说明
user_ids array 用户ID数组,用户ID类型为string
dept_ids array 部门ID数组,标签ID类型为long
tag_group_infos array 标签组信息
tag_group_id string 标签组ID
tag_infos array 仅支持企微标签、业务标签,不支持内部标签
tag_id string 标签ID
{
  "user_ids": [
    "fake_data"
  ],
  "dept_ids": [
    123
  ],
  "tag_group_infos": [
    {
      "tag_group_id": "fake_data",
      "tag_infos": [
        {
          "tag_id": "fake_data"
        }
      ]
    }
  ]
}

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": {
    "task_id": 5
  }
}

返回说明:

参数 类型 说明
code int 出错返回码,为0表示成功,非0表示调用失败
msg string 返回码描述
data object
task_id string 群发id

results matching ""

    No results matching ""