创建极速群发任务
POST
/api/v2/wecomMessage/batchSend
请求参数
Query 参数
token
string
必需
Body 参数application/json
id
string
群发id,分页后续必传
name
string
群发名称
token
string
调用接口凭证
messages
array [object {2}]
消息内容
type
enum<number>
参考发送消息的messageType
枚举值:
76121913
payload
参考发送消息的payload
scheduledTimestamp
integer
(毫秒)当定时任务时必传,否则不传
members
array [object {3}]
必需
botUserId
string
托管账号的企业微信员工id(明文)
externalUserId
array[string]
发送对象的企业微信外部联系人id(明文)
wecomChatId
array[string]
发送对象的企业微信外部群聊id
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"
]
}
],
"type": 1
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
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"
]
}
],
"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"
]
}
]
}
修改于 2025-04-02 10:59:35