发送新客户欢迎语
POST
/cgi-bin/externalcontact/send_welcome_msg
服务端API企业内部开发第三方应用开发
为了保证用户体验以及避免滥用,企业仅可在收到相关事件后20秒内调用,且只可调用一次。
如果企业已经在管理端为相关成员配置了可用的欢迎语,则推送添加外部联系人事件时不会返回welcome_code。
每次添加新客户时可能有多个企业自建应用/第三方应用收到带有welcome_code的回调事件,但仅有最先调用的可以发送成功。后续调用将返回41051(externaluser has started chatting)错误,请用户根据实际使用需求,合理设置应用可见范围,避 免冲突。
旧接口发送新客户欢迎语已经废弃,接口升级后支持发送视频文件,并且最多支持同时发送9个附件
text与附件信息可以同时发送,此时将会以多条消息的形式触达客户
attachments中每个附件信息必须与msgtype一致,例如,msgtype指定为image,则需要填写image.pic_url或者image.media_id,否则会报错。
media_id和pic_url只需填写一个,两者同时填写时使用media_id,二者不可同时为空。
权限说明:
第三方应用需要拥有“企业客户权限->客户联系->给客户发送欢迎语”权限
企业成员需在应用的可见范围内
原文档地址:
https://open.work.weixin.qq.com/api/doc/90000/90135/92137
https://open.work.weixin.qq.com/api/doc/90001/90143/92599
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/externalcontact/send_welcome_msg?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
"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"
}
}
]
}'
响应示例响应示例
{
"errcode": 0,
"errmsg": "string"
}
请求参数
Query 参数
access_token
调用接口凭证
示例值:
{{accesstoken}}
Body 参数application/json
返回响应
修改于 2023-01-31 09:17:50