创建群发 - API接口文档

请求参数

Body 参数application/json

id

string

群发id，分页后续必传

必需

token

string

调用接口凭证

必需

messages

array [object {4}]

消息内容

必需

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

type

enum<number>

参考发送消息的messageType

可选

枚举值:

01234578

payload

参考发送消息的payload

可选

isAnnouncement

boolean

是否为群公告

可选

表示该条消息是群公告（需保证一次群发只允许有一条群公告消息），只在type是群聊且机器人为群主时生效

isAtAll

boolean

是否@所有人

可选

表示该条消息是@所有人（需保证一次群发只允许有一条群公告消息），只在type是群聊且机器人为群主时生效

scheduledTimestamp

integer

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

必需

members

array [object {3}]

必需

botUserId

string

托管账号的企业微信员工id

可选

wxids

array[string]

发送对象的系统联系人id列表

可选

unionIds

array[string]

该机器人发送对象的开放平台Id列表

可选

多组时会整合去重. 当wxids存在时, unionId无效,

hasMore

boolean

当分页时为true，最后一个是false或者不传

必需

type

enum<number>

类型

必需

枚举值:

56

示例

{
    "id": "string",
    "token": "string",
    "messages": [
        {
            "type": 0,
            "payload": {
                "text": "string",
                "mention": "string",
                "wecomMention": "string"
            },
            "isAnnouncement": true,
            "isAtAll": true
        }
    ],
    "scheduledTimestamp": 0,
    "members": [
        {
            "botUserId": "string",
            "wxids": [
                "string"
            ],
            "unionIds": [
                "string"
            ]
        }
    ],
    "hasMore": true,
    "type": 5
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://aa-hub.ddregion.com/broadcast/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "token": "string",
    "messages": [
        {
            "type": 0,
            "payload": {
                "text": "string",
                "mention": "string",
                "wecomMention": "string"
            },
            "isAnnouncement": true,
            "isAtAll": true
        }
    ],
    "scheduledTimestamp": 0,
    "members": [
        {
            "botUserId": "string",
            "wxids": [
                "string"
            ],
            "unionIds": [
                "string"
            ]
        }
    ],
    "hasMore": true,
    "type": 5
}'

返回响应

🟢200成功

application/json

Body

code

enum<number>

返回码

必需

枚举值:

-1-2-3-4-5-6-7

data

object

可选

id

string

群发id

可选

memberNumber

number

群发对象人数

必需

scheduledTimestamp

number

（毫秒）定时任务时存在

可选

isCreated

boolean

该群发是否创建成功

可选

messageNumber

number

发送消息数

必需

failedMembers

array [object {3}]

未创建成功的成员,参数参照请求的members字段

可选

failedMemberCount

number

未创建成功的成员数量

可选

示例

{
    "code": -1,
    "data": {
        "id": "string",
        "memberNumber": 0,
        "scheduledTimestamp": 0,
        "isCreated": true,
        "messageNumber": 0,
        "failedMembers": [
            {
                "botUserId": "string",
                "wxids": [
                    "string"
                ],
                "unionIds": [
                    "string"
                ]
            }
        ],
        "failedMemberCount": 0
    }
}