创建企业群发

POST

http://127.0.0.1/cgi-bin/externalcontact/add_msg_template

第三方应用开发/客户联系/消息推送

最后修改时间：2022-08-30 03:03:36

责任人：未设置

企业跟第三方应用可通过此接口添加企业群发消息的任务并通知成员发送给相关客户或客户群。（注：企业微信终端需升级到2.7.5版本及以上）
注意：调用该接口并不会直接发送消息给客户/客户群，需要成员确认后才会执行发送（客服人员的企业微信需要升级到2.7.5及以上版本）
旧接口创建企业群发已经废弃，接口升级后支持发送视频文件，并且支持最多同时发送9个附件。
同一个企业每个自然月内仅可针对一个客户/客户群发送4条消息，超过接收上限的客户将无法再收到群发消息。

text和attachments不能同时为空
attachments中每个附件信息必须与msgtype一致，例如，msgtype指定为image，则需要填写image.pic_url或者image.media_id，否则会报错。
media_id和pic_url只需填写一个，两者同时填写时使用media_id，二者不可同时为空
权限说明:

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
自建应用只能给应用可见范围内的成员进行推送。
第三方应用需具有“企业客户权限->客户联系->群发消息给客户和客户群”权限。
当只提供sender参数时，相当于选取了这个成员所有的客户。
注意：2019-8-1之后，取消了 “无法向未回复消息的客户发送企业群发消息” 的限制。

文档ID: 15836
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/92698
https://open.work.weixin.qq.com/api/doc/90000/90135/92135

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

chat_type

string

可选

群发任务的类型，默认为single，表示发送给客户，group表示发送给客户群

external_userid

array[string]

可选

客户的外部联系人id列表，仅在chat_type为single时有效，不可与sender同时为空，最多可传入1万个客户

attachments

array [object {2}]

可选

附件，最多支持添加9个附件

file

object

必需

文件的media_id，可以通过素材管理接口获得

msgtype

string

必需

附件类型，可选image、link、miniprogram或者video

sender

string

可选

发送企业群发消息的成员userid，当类型为发送给客户群时必填

text

object

可选

content

string

可选

示例

{
  "chat_type": "single",
  "external_userid": [
    "woAJ2GCAAAXtWyujaWJHDDGi0mACAAAA",
    "wmqfasd1e1927831123109rBAAAA"
  ],
  "sender": "zhangsan",
  "text": {
    "content": "文本消息内容"
  },
  "attachments": [
    {
      "msgtype": "image",
      "image": {
        "media_id": "MEDIA_ID",
        "pic_url": "http://p.qpic.cn/pic_wework/3474110808/7a6344sdadfwehe42060/0"
      }
    },
    {
      "msgtype": "link",
      "link": {
        "title": "消息标题",
        "picurl": "https://example.pic.com/path",
        "desc": "消息描述",
        "url": "https://example.link.com/path"
      }
    },
    {
      "msgtype": "miniprogram",
      "miniprogram": {
        "title": "消息标题",
        "pic_media_id": "MEDIA_ID",
        "appid": "wx8bd80126147dfAAA",
        "page": "/path/index.html"
      }
    },
    {
      "msgtype": "video",
      "video": {
        "media_id": "MEDIA_ID"
      }
    },
    {
      "msgtype": "file",
      "file": {
        "media_id": "MEDIA_ID"
      }
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://127.0.0.1/cgi-bin/externalcontact/add_msg_template?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chat_type": "single",
    "external_userid": [
        "woAJ2GCAAAXtWyujaWJHDDGi0mACAAAA",
        "wmqfasd1e1927831123109rBAAAA"
    ],
    "sender": "zhangsan",
    "text": {
        "content": "文本消息内容"
    },
    "attachments": [
        {
            "msgtype": "image",
            "image": {
                "media_id": "MEDIA_ID",
                "pic_url": "http://p.qpic.cn/pic_wework/3474110808/7a6344sdadfwehe42060/0"
            }
        },
        {
            "msgtype": "link",
            "link": {
                "title": "消息标题",
                "picurl": "https://example.pic.com/path",
                "desc": "消息描述",
                "url": "https://example.link.com/path"
            }
        },
        {
            "msgtype": "miniprogram",
            "miniprogram": {
                "title": "消息标题",
                "pic_media_id": "MEDIA_ID",
                "appid": "wx8bd80126147dfAAA",
                "page": "/path/index.html"
            }
        },
        {
            "msgtype": "video",
            "video": {
                "media_id": "MEDIA_ID"
            }
        },
        {
            "msgtype": "file",
            "file": {
                "media_id": "MEDIA_ID"
            }
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

fail_list

array[string]

可选

无效或无法发送的external_userid列表

errmsg

string

可选

对返回码的文本描述内容

msgid

string

可选

企业群发消息的id，可用于获取群发消息发送结果

示例

{
  "errcode": 0,
  "fail_list": [
    "string"
  ],
  "errmsg": "string",
  "msgid": "string"
}

修改于 2022-08-30 03:03:36

获取企业的全部群发记录-获取企业群发成员执行结果

发送新客户欢迎语