企业内部开发 服务端API 客户联系 消息推送 发送新客户欢迎语
发送新客户欢迎语
  • 企业微信在向企业推送添加外部联系人事件时,会额外返回一个welcome_code,企业以此为凭据调用接口,即可通过成员向新添加的客户发送个性化的欢迎语。
  • 为了保证用户体验以及避免滥用,企业仅可在收到相关事件后20秒内调用,且只可调用一次。
    如果企业已经在管理端为相关成员配置了可用的欢迎语,则推送添加外部联系人事件时不会返回welcome_code。
  • 每次添加新客户时可能有多个企业自建应用/第三方应用收到带有welcome_code的回调事件,但仅有最先调用的可以发送成功。后续调用将返回41051(externaluser has started chatting)错误,请用户根据实际使用需求,合理设置应用可见范围,避免冲突。
  • 旧接口发送新客户欢迎语已经废弃,接口升级后支持发送视频文件,并且最多支持同时发送9个附件

请求方式: POST(HTTP)

请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/send_welcome_msg?access_token=ACCESS_TOKEN

请求示例

{
	"welcome_code": "CALLBACK_CODE",
	"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"
		}
	}]
}

参数说明:

参数必须说明
access_token调用接口凭证
welcome_code通过添加外部联系人事件推送给企业的发送欢迎语的凭证,有效期为20秒
text.content消息文本内容,最长为4000字节
attachments附件,最多可添加9个附件
attachments.msgtype附件类型,可选image、link、miniprogram或者video
image.media_id图片的media_id,可以通过素材管理接口获得
image.pic_url图片的链接,仅可使用上传图片接口得到的链接
link.title图文消息标题,最长为128字节
link.picurl图文消息封面的url
link.desc图文消息的描述,最长为512字节
link.url图文消息的链接
miniprogram.title小程序消息标题,最长为64字节
miniprogram.pic_media_id小程序消息封面的mediaid,封面图建议尺寸为520*416
miniprogram.appid小程序appid,必须是关联到企业的小程序应用
miniprogram.page小程序page路径
video.media_id视频的media_id,可以通过素材管理接口获得
file.media_id文件的media_id, 可以通过素材管理接口获得
* text和attachments不能同时为空;
  • text与附件信息可以同时发送,此时将会以多条消息的形式触达客户
  • attachments中每个附件信息必须与msgtype一致,例如,msgtype指定为image,则需要填写image.pic_url或者image.media_id,否则会报错。
  • media_id和pic_url只需填写一个,两者同时填写时使用media_id,二者不可同时为空。

 

权限说明:

 

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
上一篇
获取企业的全部群发记录
下一篇
入群欢迎语素材管理