创建拉群任务

创建定时拉群任务，支持批量邀请客户入群，可设置执行时间、邀请间隔等参数。支持多个机器人和多个群聊的批量邀请。

请求参数说明

参数名	类型	必填	描述	示例值
token	String	是	访问令牌	"88099beda5d1f872243d17e96ed4cd8a"
name	String	是	任务名称	"test_pull_group"
taskType	Integer	是	1-定时任务，2-周期任务，本接口固定1	1
startTime	Long	是	开始执行时间，开始时间戳，毫秒	1680570000000
endTm	String	否	"HH:mm:ss"格式的时间点，如果设置了endTm，到达结束时间点后，即使没有完成也会结束	"22:30:00"
commandType	String	是	指令类型，消息群发默认wxwork.robot.group.invitation	"wxwork.robot.group.invitation"
taskRule	Integer	是	2-自定义策略	2
suitCount	Integer	是	1-固定值，每批处理数量	1
invites	String	是	群切换的人数，当群聊人数和邀请人数之和满450人后自动切换邀请客户至下一个群聊	"450"
perSuitSecond	Integer	是	邀请间隔	60
taskData	Object	是	入群邀请数据，由groupInvitations组成	-
groupInvitations	Array	是	按照机器人定义的邀请数据构成的数组	-

groupInvitations 结构

参数名	类型	必填	描述	示例值
speechCraft	Object	是	入群邀请语	-
robotKey	String	是	机器人robotKey	"154eeda74e2d4d60a5bb36c5584cd924"
userIds	Array	是	被邀请的客户userId，通过接口2.44筛选	[7881300295092205]
conversationIds	Array	是	需要进的群ID数组	["R:10696051295069137"]

speechCraft 结构

参数名	类型	必填	描述	示例值
msgType	Integer	是	1-表示文本类型	1
content	String	是	邀请语内容，不超过50个汉字	"入群说明"

响应参数说明

参数名	类型	描述	示例值
msg	String	响应消息	"OK"
code	String	响应码	"0"
wxworkMultipleTaskId	Integer	任务ID	10007843

注意事项

需要有效的访问令牌

任务类型固定为1（定时任务）

群聊人数满450人后会自动切换邀请客户至下一个群聊

支持设置邀请间隔，避免频繁操作

时间戳为毫秒级

可通过接口2.44筛选被邀请的客户

邀请语内容不超过50个汉字

支持多个机器人和多个群聊的批量邀请

请求参数

Authorization

Header 参数

Body 参数application/json

示例

创建拉群任务简单拉群任务

{
    "token": "88099beda5d1f872243d17e96ed4cd8a",
    "name": "test_pull_group",
    "taskType": 1,
    "startTime": 1680570000000,
    "endTm": "22:30:00",
    "commandType": "wxwork.robot.group.invitation",
    "taskRule": 2,
    "suitCount": 1,
    "invites": "450",
    "perSuitSecond": 60,
    "taskData": {
        "groupInvitations": [
            {
                "speechCraft": {
                    "msgType": "1",
                    "content": "入群说明"
                },
                "robotKey": "154eeda74e2d4d60a5bb36c5584cd924",
                "userIds": [
                    7881300295092205,
                    7881303149922469,
                    7881301391032008,
                    7881300715900704,
                    7881303443987887,
                    7881300763898374,
                    7881300731914225
                ],
                "conversationIds": [
                    "R:10696051295069137",
                    "R:10696049764038770",
                    "R:10696049764038898",
                    "R:10696049764038587"
                ]
            },
            {
                "speechCraft": {
                    "msgType": "1",
                    "content": "入群说明"
                },
                "robotKey": "307c9ad9336143f48c71ba84abda6ec6",
                "userIds": [
                    1688853471030776,
                    1688853531233980,
                    7881300389006710,
                    1688851094693341,
                    7881300295092205
                ],
                "conversationIds": [
                    "R:10974920096549669",
                    "R:10696050369044959"
                ]
            }
        ]
    }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

请求参数说明#

groupInvitations 结构#

speechCraft 结构#

响应参数说明#

注意事项#