创建极速群发任务 - API接口文档

请求参数

Query 参数

token

string

必需

来源于：企业控制台-API接入

Body 参数application/json

id

string

群发id，分页后续必传

可选

续写任务时需传

name

string

群发名称

可选

初次创建任务时需传

token

string

调用接口凭证

必需

messages

array [object {2}]

消息内容

必需

当hseMore不传或者为false时，必须存在一组messages,多存在多组时,后面会覆盖前面的messages

type

enum<number>

参考发送消息的messageType

可选

枚举值:

76121913

payload

参考发送消息的payload

可选

scheduledTimestamp

integer

（毫秒）当定时任务时必传，否则不传

可选

members

array [object {5}]

必需

botUserId

string

托管账号的企业微信员工id（明文）

必需

externalUserId

array[string]

发送对象的企业微信外部联系人id（明文）

可选

wecomChatId

array[string]

发送对象的企业微信外部群聊id

可选

imBotId

string

托管账号的botid

必需

和botuserid二选一

wxids

array[string]

群发对象，和imBotId是绑定的

必需

type=1的时候，传imcontactId
type=2时候传imRoomid

type

enum<number>

群发类型（私聊、群聊）

必需

枚举值:

12

示例

{
    "id": "string",
    "name": "string",
    "token": "string",
    "messages": [
        {
            "type": 7,
            "payload": {
                "text": "string"
            }
        }
    ],
    "scheduledTimestamp": 0,
    "members": [
        {
            "botUserId": "string",
            "externalUserId": [
                "string"
            ],
            "wecomChatId": [
                "string"
            ],
            "imBotId": "string",
            "wxids": [
                "string"
            ]
        }
    ],
    "type": 1
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v2/wecomMessage/batchSend?token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "name": "string",
    "token": "string",
    "messages": [
        {
            "type": 7,
            "payload": {
                "text": "string"
            }
        }
    ],
    "scheduledTimestamp": 0,
    "members": [
        {
            "botUserId": "string",
            "externalUserId": [
                "string"
            ],
            "wecomChatId": [
                "string"
            ],
            "imBotId": "string",
            "wxids": [
                "string"
            ]
        }
    ],
    "type": 1
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

id

string

群发id

必需

orgId

string

必需

nameId

string

必需

name

string

必需

count

integer

必需

successCount

integer

必需

failedCount

integer

必需

lostCount

integer

必需

botIds

array[string]

必需

groupIds

array[string]

必需

createdAt

integer

必需

updatedAt

integer

必需

startAt

integer

必需

finishAt

integer

必需

cancelCount

integer

必需

sendAnnouncement

boolean

必需

memberNumber

integer

必需

scheduledTimestamp

integer

必需

failedMembers

array [object {3}]

必需

botUserId

string

可选

externalUserId

array[string]

可选

wecomChatId

array[string]

可选

示例

{
    "code": 0,
    "msg": "string",
    "data": {
        "id": "string",
        "orgId": "string",
        "nameId": "string",
        "name": "string",
        "count": 0,
        "successCount": 0,
        "failedCount": 0,
        "lostCount": 0,
        "botIds": [
            "string"
        ],
        "groupIds": [
            "string"
        ],
        "createdAt": 0,
        "updatedAt": 0,
        "startAt": 0,
        "finishAt": 0,
        "cancelCount": 0,
        "sendAnnouncement": true,
        "memberNumber": 0,
        "scheduledTimestamp": 0
    },
    "failedMembers": [
        {
            "botUserId": "string",
            "externalUserId": [
                "string"
            ],
            "wecomChatId": [
                "string"
            ]
        }
    ]
}