发送应用模板消息 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

第三方应用开发

快速入门服务端API 客户端API 运营规范附录更新日志联系我们

第三方应用开发服务端API 消息推送发送应用模板消息

发送应用模板消息

最后更新：2021/09/23

在发送应用消息接口的基础上，第三方应用支持一种新的消息类型：模板消息，msgtype指定为template_msg。
模板消息是一种固定格式的消息。

- 此消息类型目前仅第三方应用支持，自建应用不支持。服务商需在管理端申请模版。接口传参的内容必须与申请的模版匹配；
- 成员授权模式下，对于不在可见范围内的成员，第三方应用没有userid或open_userid，但可以通过传入合法且未过期的selected_ticket_list来推送模板消息，selected_ticket_list可通过返回ticket的选人接口获得。注意，管理员授权模式下，仅能给可见范围之内的成员推送消息，不在可见范围的成员将不能收到消息；
- 对于应用可见范围内的成员，直接通过touser指定即可，无须传入selected_ticket_list；
- 支持id转译，将userid/部门id转成对应的用户名/部门名。具体支持的范围和语法，请查看附录id转译说明。

请求示例：

{
   "touser" : "zhangsan|lisi",
   "toparty" : "PartyID1|PartyID2",
   "totag" : "TagID1 | TagID2",
   "agentid" : 10086,
   "msgtype" : "template_msg",
   "selected_ticket_list":["xxx","yyy"],
   "template_msg" : {
        "template_id": "ttxxlGlgIAwJrCTFjtndfgHPoIySyk6w",
        "url": "http://www.qq.com",
		"miniprogram":
		{
			"appid":"APPID",
			"pagepath":"/index.html"
		},
        "content_item": [
            {
                "key": "会议室",
                "value": "402"
            },
            {
                "key": "会议地点",
                "value": "广州TIT-402会议室"
            },
            {
                "key": "会议时间",
                "value": "2018年8月1日 09:00-09:30"
            }
        ]
    },
	"enable_id_trans": 0,
	"only_unauth":true
}

示例效果：

参数说明：

参数	是否必须	说明
touser	否	指定接收消息的成员，成员ID列表（多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为"@all"，则向该企业应用的全部可见成员发送
toparty	否	指定接收消息的部门，部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为"@all"时忽略本参数，成员授权模式下不应该传该参数
totag	否	指定接收消息的标签，标签ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为"@all"时忽略本参数，成员授权模式下不应该传该参数
msgtype	是	消息类型，此时固定为：template_msg
template_msg	是	消息内容
template_id	是	模板ID。第三方管理端创建模板后获得。对于正式授权的应用，需要审批通过后才可使用。最长64字节
url	否	点击模板消息后的跳转链接。最长2048字节。注意，url必须带协议头 "http://" 或 "https://" 。url和miniprogram 至少要填一个,都填时优先miniprogram。
content_item	是	消息内容键值对，允许个数范围：1~5，实际由申请的模板样式决定
key	是	1~20个utf8字符。注意，必须与template_id对应模板匹配
value	是	1~40个utf8字符
selected_ticket_list	否	选人sdk或者选人jsapi返回的ticket列表，列表不超过10个。接收者不包含selected_tikcet的操作者，若要发送给操作者，可将操作者填到touser字段。
enable_id_trans	否	表示是否开启id转译，0表示否，1表示是，默认0。
only_unauth	否	仅向selected_ticket_list中未授权的用户发送模板消息，仅当selected_ticket_list存在时该字段生效。如果该字段为true，则自动忽略touser，toparty，totag
miniprogram	否	点击后需要跳转的小程序，miniprogram和url至少要填一个，都填时优先miniprogram。
miniprogram.appid	否	在miniprogram节点中该字段必填，小程序appid，必须是与当前应用关联的小程序
miniprogram.pagepath	否	在miniprogram节点中该字段必填，表示点击消息卡片后的小程序页面，仅限本小程序内的页面。

发送应用消息

更新模版卡片消息

本节内容

发送应用模板消息