发起群发消息

POST

https://console.wecomapi.com/wecom/finder/api

接口提示

发起群发消息任务。

该接口会产生实际业务动作，正式环境建议做好权限校验、频率控制和操作日志。

每天只能对每个客户或群执行一次群发；群主可直接创建消息并发送。

msgList 中每项通过 type 指定消息类型，msgData 使用相应发送消息接口的业务字段，无需传 toId。消息体随类型变化，请按对应类型提供字段；当前结构中的 content 说明适用于文本消息。

请求参数

Header 参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

请求成功时返回统一响应结构，具体字段以 data 内容为准。

Bodyapplication/json

请求示例

Shell

JavaScript

Java

Swift

curl --location 'https://console.wecomapi.com/wecom/finder/api' \
--header 'WECOM-TOKEN: ' \
--header 'Content-Type: application/json' \
--data '{
  "method": "/msg/sendGroupMsg",
  "params": {
    "guid": "",
    "msgList": [
      {
        "msgData": {
          "content": "我是群发-文本类型"
        },
        "type": 0
      }
    ],
    "sendType": 1,
    "toIdList": [
      "{{toId}}"
    ]
  }
}'

响应示例

{
  "code": 0,
  "data": {
    "groupMsgId": 1120366371070430
  },
  "msg": "成功"
}

移除群消息置顶

查询群发状态