客户群发创建

POST

/open-api/group_msg/add

调用此接口需购买基础席位。

请求参数

Query 参数

access_token

string

调用接口凭证

必需

默认值:

Body 参数application/json

name

string

群发名称

必需

allow_select

boolean

允许员工筛选客户

可选

staff_eu_list

array [object {2}]

可选

指定员工id群发客户列表（此项和外部联系人id和unionid只能传入一类）

staff_ext_id

array[string]

可选

员工id，最多上传100个员工

eu_ext_ids

array[string]

可选

客户id，单个员工最多上传1万个客户id

unionids

array[string]

可选

客户的unionid，单次上传最大2w个，通过绑定了微信开发平台的服务号获取（外部联系人id和unionid只能传入一类）

eu_ext_ids

array[string]

可选

外部联系人id，单次上传最大2w个（外部联系人id和unionid只能传入一类）

attachments

array [object {5}]

附件

可选

msgtype

string

附件类型

可选

image

object

图片类型

可选

link

object

链接类型

可选

miniprogram

object

小程序类型

可选

video

object

可选

视频类型，只能上传小于10MB的视频

text

string

群发的文本

可选

create_staff_ext_id

string

群发创建人的id

可选

external_user_filter

object

客户筛选条件

可选

eu_distinct

boolean

可选

是否去重 true为开启 false为关闭默认开启

staff_ext_id_list

array[string]

可选

发送员工id列表，当传入了eu_ext_ids或者unionid的时候此id不生效任意挑选一个成员发送

gender

integer

可选

性别 1-男 2-女 0-未知

tag_condition

object

标签筛选类型

可选

kanban_stage_id_list

array[integer]

可选

客户所处旅程id，提供此字段需要传入staff_ext_id_list（可通过“获取客户阶段状态”接口获取）

group_ext_id_list

array[string]

可选

客户所在群聊的群id，提供此字段需要传入staff_ext_id_list

start_time

integer

可选

添加时间（起始）提供此字段需要传入staff_ext_id_list

end_time

integer

添加时间（结束）

可选

示例

{
  "name": "str",
  "unionids": [
    "1",
    "2"
  ],
  "eu_ext_ids": [
    "1",
    "2"
  ],
  "staff_eu_list": [
    {
      "staff_ext_id": "111",
      "eu_ext_ids": [
        "wmeo9iCwAABlltHI_nZj0o4OZfcUsVkA"
      ]
    },
    {
      "staff_ext_id": "222",
      "eu_ext_ids": [
        "wmeo9iCwAA3AzcTb2r-i7EzAS1SJBuhA",
        "22"
      ]
    }
  ],
  "attachments": [
    {
      "msgtype": "str",
      "image": {
        "title": "str",
        "url": "str"
      },
      "link": {
        "title": "str",
        "url": "str",
        "desc": "str",
        "picurl": "str"
      },
      "miniprogram": {
        "appid": "str",
        "title": "str",
        "page": "str",
        "cover": "str"
      },
      "video": {
        "title": "str",
        "url": "str",
        "picture": "str"
      }
    }
  ],
  "text": "str",
  "create_staff_ext_id": "str",
  "external_user_filter": {
    "eu_distinct": true,
    "staff_ext_id_list": [
      "JiangGuoHui"
    ],
    "gender": 1,
    "tag_condition": {
      "or_tag_list": [
        3000357127
      ],
      "not_or_tag_list": [
        3000356924,
        3000357131
      ]
    },
    "kanban_stage_id_list": [
      1001205192
    ],
    "group_ext_id_list": [
      "wreo9iCwAAf6rovHHHx82I4wMWOlDc8Q"
    ],
    "start_time": 1698854400,
    "end_time": 1699631999
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.weibanzhushou.com/open-api/group_msg/add?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "str",
    "unionids": [
        "1",
        "2"
    ],
    "eu_ext_ids": [
        "1",
        "2"
    ],

     "staff_eu_list": [
        {"staff_ext_id": "111", "eu_ext_ids": ["wmeo9iCwAABlltHI_nZj0o4OZfcUsVkA"]},
        {"staff_ext_id": "222", "eu_ext_ids": ["wmeo9iCwAA3AzcTb2r-i7EzAS1SJBuhA", "22"]}
        ],
    "attachments": [
        {
            "msgtype": "str",
            "image": {
                "title": "str",
                "url": "str"
            },
            "link": {
                "title": "str",
                "url": "str",
                "desc": "str",
                "picurl": "str"
            },
            "miniprogram": {
                "appid": "str",
                "title": "str",
                "page": "str",
                "cover": "str"
            },
            "video": {
                "title": "str",
                "url": "str",
                "picture": "str"
            }
        }
    ],
    "text": "str",
    "create_staff_ext_id": "str",
    "external_user_filter": {
        "eu_distinct": true,
        "staff_ext_id_list": [
            "JiangGuoHui"
        ],
        "gender": 1,
        "tag_condition": {
            "or_tag_list": [
                3000357127
            ],
            "not_or_tag_list": [
                3000356924,
                3000357131
            ]
        },
        "kanban_stage_id_list": [
            1001205192
        ],
        "group_ext_id_list": [
            "wreo9iCwAAf6rovHHHx82I4wMWOlDc8Q"
        ],
        "start_time": 1698854400,
        "end_time": 1699631999
    }
    
}'

返回响应

🟢200成功

application/json

Body

errcode

integer

必需

errmsg

string

必需

mission_id

integer

群发任务id

必需

示例

{
  "errcode": 0,
  "errmsg": "string",
  "mission_id": 0
}

🟢200正常返回

获取人群包数据详情

群发任务列表