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

企业内部开发

快速入门服务端API 客户端API 工具与资源附录更新日志联系我们

企业内部开发

服务端API

消息推送

互联企业消息推送

发送应用消息

调试工具

发送应用消息

最后更新：2022/01/20

概述

接口定义

消息类型

文本消息

图片消息

语音消息

视频消息

文件消息

文本卡片消息

图文消息

图文消息（mpnews）

markdown消息

小程序通知消息

概述

互联企业是企业微信提供的满足集团与子公司、企业与上下游供应商进行连接的功能，企业可以共享通讯录以及应用给互联企业，如需要，你可以前往管理后台-通讯录创建互联企业，之后你可以在自建应用的可见范围设置互联企业的通讯录；此接口主要满足开发者给互联企业成员推送消息的诉求。

接口定义

互联企业的应用支持推送文本、图片、视频、文件、图文等类型。

请求方式：POST（HTTPS）
请求地址： https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/message/send?access_token=ACCESS_TOKEN

参数说明：

参数	是否必须	说明
access_token	是	调用接口凭证

各个消息类型的具体POST格式参考以下文档。

返回示例：

{
  "errcode" : 0,
  "errmsg" : "ok",
  "invaliduser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"], // 不区分大小写，返回的列表都统一转为小写
  "invalidparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],
  "invalidtag":["tagid1","tagid2"]
}

如果部分接收人无权限或不存在，发送仍然执行，但会返回无效的部分（即invaliduser或invalidparty），常见的原因是接收人不在应用的可见范围内。

消息类型

文本消息

请求示例：

{
	"touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],
	"toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],
	"totag" : ["tagid1","tagid2"],
	"toall" : 0,
	"msgtype" : "text",
   "agentid" : 1,
   "text" : {
       "content" : "你的快递已到，请携带工卡前往邮件中心领取。\n出发前可查看<a href=\"http://work.weixin.qq.com\">邮件中心视频实况</a>，聪明避开排队。"
   },
   "safe":0
}

参数说明：

参数	是否必须	说明
touser	否	成员ID列表（消息接收者，最多支持1000个）。每个元素的格式为： corpid/userid，其中，corpid为该互联成员所属的企业，userid为该互联成员所属企业中的账号。如果是本企业的成员，则直接传userid即可
toparty	否	部门ID列表，最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型，格式为：linked_id/party_id，其中linked_id是互联id，party_id是在互联圈子中的部门id。如果是本企业的部门，则直接传party_id即可。
totag	否	本企业的标签ID列表，最多支持100个。
toall	否	1表示发送给应用可见范围内的所有人（包括互联企业的成员），默认为0
msgtype	是	消息类型，此时固定为：text
agentid	是	企业应用的id，整型。可在应用的设置页面查看
content	是	消息内容，最长不超过2048个字节
safe	否	表示是否是保密消息，0表示否，1表示是，默认0

注意：linked_id为互联ID，此ID可以在管理后台-通讯录-互联企业-详情里查看

图片消息

请求示例：

{
	"touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],
	"toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],
	"totag" : ["tagid1","tagid2"],
	"toall" : 0,
   "msgtype" : "image",
   "agentid" : 1,
   "image" : {
        "media_id" : "MEDIA_ID"
   },
   "safe":0
}

请求参数：

参数	是否必须	说明
touser	否	成员ID列表（消息接收者，最多支持1000个）。每个元素的格式为： corpid/userid，其中， corpid为该互联成员所属的企业，userid为该互联成员所属企业中的账号。如果是本企业的成员，则直接传userid即可
toparty	否	部门ID列表，最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型，格式为：linked_id/party_id，其中linked_id是互联id，party_id是在互联圈子中的部门id。如果是本企业的部门，则直接传party_id即可。
totag	否	本企业的标签ID列表，最多支持100个。
toall	否	1表示发送给应用可见范围内的所有人（包括互联企业的成员），默认为0
msgtype	是	消息类型，此时固定为：image
agentid	是	企业应用的id，整型。可在应用的设置页面查看
media_id	是	图片媒体文件id，可以调用上传临时素材接口获取
safe	否	表示是否是保密消息，0表示否，1表示是，默认0

语音消息

请求示例：

{
	"touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],
	"toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],
	"totag" : ["tagid1","tagid2"],
	"toall" : 0,
   "msgtype" : "voice",
   "agentid" : 1,
   "voice" : {
        "media_id" : "MEDIA_ID"
   }
}

参数说明：

参数	是否必须	说明
touser	否	成员ID列表（消息接收者，最多支持1000个）。每个元素的格式为： corpid/userid，其中， corpid为该互联成员所属的企业，userid为该互联成员所属企业中的账号。如果是本企业的成员，则直接传userid即可
toparty	否	部门ID列表，最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型，格式为：linked_id/party_id，其中linked_id是互联id，party_id是在互联圈子中的部门id。如果是本企业的部门，则直接传party_id即可。
totag	否	本企业的标签ID列表，最多支持100个。
toall	否	1表示发送给应用可见范围内的所有人（包括互联企业的成员），默认为0
msgtype	是	消息类型，此时固定为：voice
agentid	是	企业应用的id，整型。可在应用的设置页面查看
media_id	是	语音文件id，可以调用上传临时素材接口获取

视频消息

请求示例：

{
	"touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],
	"toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],
	"totag" : ["tagid1","tagid2"],
	"toall" : 0,
   "msgtype" : "video",
   "agentid" : 1,
   "video" : {
        "media_id" : "MEDIA_ID",
        "title" : "Title",
       "description" : "Description"
   },
   "safe":0
}

参数说明：

参数	是否必须	说明
touser	否	成员ID列表（消息接收者，最多支持1000个）。每个元素的格式为： corpid/userid，其中， corpid为该互联成员所属的企业，userid为该互联成员所属企业中的账号。如果是本企业的成员，则直接传userid即可
toparty	否	部门ID列表，最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型，格式为：linked_id/party_id，其中linked_id是互联id，party_id是在互联圈子中的部门id。如果是本企业的部门，则直接传party_id即可。
totag	否	本企业的标签ID列表，最多支持100个。
toall	否	1表示发送给应用可见范围内的所有人（包括互联企业的成员），默认为0
msgtype	是	消息类型，此时固定为：video
agentid	是	企业应用的id，整型。可在应用的设置页面查看
media_id	是	视频媒体文件id，可以调用上传临时素材接口获取
title	否	视频消息的标题，不超过128个字节，超过会自动截断
description	否	视频消息的描述，不超过512个字节，超过会自动截断
safe	否	表示是否是保密消息，0表示否，1表示是，默认0

文件消息

请求示例：

{
	"touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],
	"toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],
	"totag" : ["tagid1","tagid2"],
	"toall" : 0,
   "msgtype" : "file",
   "agentid" : 1,
   "file" : {
        "media_id" : "1Yv-zXfHjSjU-7LH-GwtYqDGS-zz6w22KmWAT5COgP7o"
   },
   "safe":0
}

参数说明：

参数	是否必须	说明
touser	否	成员ID列表（消息接收者，最多支持1000个）。每个元素的格式为： corpid/userid，其中， corpid为该互联成员所属的企业，userid为该互联成员所属企业中的账号。如果是本企业的成员，则直接传userid即可
toparty	否	部门ID列表，最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型，格式为：linked_id/party_id，其中linked_id是互联id，party_id是在互联圈子中的部门id。如果是本企业的部门，则直接传party_id即可。
totag	否	本企业的标签ID列表，最多支持100个。
toall	否	1表示发送给应用可见范围内的所有人（包括互联企业的成员），默认为0
msgtype	是	消息类型，此时固定为：file
agentid	是	企业应用的id，整型。可在应用的设置页面查看
media_id	是	文件id，可以调用上传临时素材接口获取
safe	否	表示是否是保密消息，0表示否，1表示是，默认0

文件消息展现：

文本卡片消息

请求示例：

{
	"touser" : ["userid1","userid2","CorpId1/userid1","CorpId2/userid2"],
	"toparty" : ["partyid1","partyid2","LinkedId1/partyid1","LinkedId2/partyid2"],
	"totag" : ["tagid1","tagid2"],
	"toall" : 0,
   "msgtype" : "textcard",
   "agentid" : 1,
   "textcard" : {
            "title" : "领奖通知",
            "description" : "<div class=\"gray\">2016年9月26日</div> <div class=\"normal\">恭喜你抽中iPhone 7一台，领奖码：xxxx</div><div class=\"highlight\">请于2016年10月10日前联系行政同事领取</div>",
            "url" : "URL",
			"btntxt":"更多"
   }
}

参数说明：

参数	是否必须	说明
touser	否	成员ID列表（消息接收者，最多支持1000个）。每个元素的格式为： corpid/userid，其中， corpid为该互联成员所属的企业，userid为该互联成员所属企业中的账号。如果是本企业的成员，则直接传userid即可
toparty	否	部门ID列表，最多支持100个。partyid在互联圈子内唯一。每个元素都是字符串类型，格式为：linked_id/party_id，其中linked_id是互联id，party_id是在互联圈子中的部门id。如果是本企业的部门，则直接传party_id即可。
totag	否	本企业的标签ID列表，最多支持100个。
toall	否	1表示发送给应用可见范围内的所有人（包括互联企业的成员），默认为0
msgtype	是	消息类型，此时固定为：textcard
agentid	是	企业应用的id，整型。可在应用的设置页面查看
title	是	标题，不超过128个字节，超过会自动截断
description	是	描述，不超过512个字节，超过会自动截断
url	是	点击后跳转的链接。
btntxt	否	按钮文字。默认为“详情”，不超过4个文字，超过自动截断。

文本卡片消息展现：

特殊说明：
卡片消息的展现形式非常灵活，支持使用br标签或者空格来进行换行处理，也支持使用div标签来使用不同的字体颜色，目前内置了3种文字颜色：灰色(gray)、高亮(highlight)、默认黑色(normal)，将其作为div标签的class属性即可，具体用法请参考上面的示例。