请求方式: 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不能同时为空;
权限说明:
返回结果:
{
"errcode": 0,
"errmsg": "ok",
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |