API接口文档

创建无限版群发

POST

https://aa-hub.ddregion.com/api/v2/broadcast/create

功能说明：

通过本接口可以创建无限版群发任务

💡

私聊群发，type=1，使用参数botUserId和externalUserId  
群聊群发，type=2，使用参数 botUserId和wecomChatId（或者使用imBotId和wxids）

请求参数

Query 参数

token

string

必需

Body 参数application/json

string

群发id，分页后续必传

可选

续写任务时需传

name

string

群发名称

必需

初次创建任务时需传

messages

array [object {2}]

消息内容

必需

type

enum<number>

必需

枚举值:

752612113914

payload

必需

scheduledTimestamp

integer

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

必需

members

array [object {6}]

必需

botUserId

string

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

必需

（botUserId和externalUserId或wecomChatld是一对），如果同企业内有相同的botUserId，需要添加corpId来确定唯一的bot

corpId

string

企业id

必需

externalUserId

array[string]

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

可选

wecomChatId

array[string]

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

可选

imBotId

string

本系统对应成员ID

必需

（imBotld和wxids是一对）

wxids

array[string]

本系统群聊ID（imRoomid）

必需

type

enum<integer>

必需

枚举值:

atAll

boolean

艾特所有人

必需

sendAnnouncement

boolean

群公告

必需

示例

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://aa-hub.ddregion.com/api/v2/broadcast/create?token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "name": "string",
    "messages": [
        {
            "type": 7,
            "payload": {
                "text": "string"
            }
        }
    ],
    "scheduledTimestamp": 0,
    "members": [
        {
            "botUserId": "string",
            "corpId": "string",
            "externalUserId": [
                "string"
            ],
            "wecomChatId": [
                "string"
            ],
            "imBotId": "string",
            "wxids": [
                "string"
            ]
        }
    ],
    "type": 1,
    "atAll": true,
    "sendAnnouncement": true
}'

返回响应

🟢200成功

application/json

Body

code

enum<integer>

必需

枚举值:

12400504-5-1

msg

string

必需

data

object

必需

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

必需

示例

{
  "code": 1,
  "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
  }
}

获取群发详情

取消无限版群发任务