微信小程序API 接收消息和事件
接收消息和事件
在页面中使用 <button open-type="contact" /> 可以显示进入客服会话按钮。
当用户在客服会话发送消息、或由某些特定的用户操作引发事件推送时，微信服务器会将消息或事件的数据包发送到开发者填写的 URL，如果使用的是云开发，则可以推送到指定的云函数（详情请参考消息推送）。开发者收到请求后可以使用 发送客服消息 接口进行异步回复。
各消息类型的推送JSON、XML数据包结构如下。
文本消息
用户在客服会话中发送文本消息时将产生如下数据包：
XML 格式
<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1482048670</CreateTime>
<MsgType><![CDATA[text]]></MsgType>
<Content><![CDATA[this is a test]]></Content>
<MsgId>1234567890123456</MsgId>
</xml>
JSON 格式
{
"ToUserName": "toUser",
"FromUserName": "fromUser",
"CreateTime": 1482048670,
"MsgType": "text",
"Content": "this is a test",
"MsgId": 1234567890123456
}
参数说明
| 参数 | 说明 |
|---|---|
| ToUserName | 小程序的原始ID |
| FromUserName | 发送者的openid |
| CreateTime | 消息创建时间(整型） |
| MsgType | text |
| Content | 文本消息内容 |
| MsgId | 消息id，64位整型 |
图片消息
用户在客服会话中发送图片消息时将产生如下数据包：
XML 格式
<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1482048670</CreateTime>
<MsgType><![CDATA[image]]></MsgType>
<PicUrl><![CDATA[this is a url]]></PicUrl>
<MediaId><![CDATA[media_id]]></MediaId>
<MsgId>1234567890123456</MsgId>
</xml>
JSON 格式
{
"ToUserName": "toUser",
"FromUserName": "fromUser",
"CreateTime": 1482048670,
"MsgType": "image",
"PicUrl": "this is a url",
"MediaId": "media_id",
"MsgId": 1234567890123456
}
参数说明
| 参数 | 说明 |
|---|---|
| ToUserName | 小程序的原始ID |
| FromUserName | 发送者的openid |
| CreateTime | 消息创建时间(整型） |
| MsgType | image |
| PicUrl | 图片链接（由系统生成） |
| MediaId | 图片消息媒体id，可以调用[获取临时素材]((getTempMedia)接口拉取数据。 |
| MsgId | 消息id，64位整型 |
小程序卡片消息
用户在客服会话中发送小程序卡片消息时将产生如下数据包：
XML 格式
<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1482048670</CreateTime>
<MsgType><![CDATA[miniprogrampage]]></MsgType>
<MsgId>1234567890123456</MsgId>
<Title><![CDATA[Title]]></Title>
<AppId><![CDATA[AppId]]></AppId>
<PagePath><![CDATA[PagePath]]></PagePath>
<ThumbUrl><![CDATA[ThumbUrl]]></ThumbUrl>
<ThumbMediaId><![CDATA[ThumbMediaId]]></ThumbMediaId>
</xml>
JSON 格式
{
"ToUserName": "toUser",
"FromUserName": "fromUser",
"CreateTime": 1482048670,
"MsgType": "miniprogrampage",
"MsgId": 1234567890123456,
"Title":"title",
"AppId":"appid",
"PagePath":"path",
"ThumbUrl":"",
"ThumbMediaId":""
}
参数说明
| 参数 | 说明 |
|---|---|
| ToUserName | 小程序的原始ID |
| FromUserName | 发送者的openid |
| CreateTime | 消息创建时间(整型） |
| MsgType | miniprogrampage |
| MsgId | 消息id，64位整型 |
| Title | 标题 |
| AppId | 小程序appid |
| PagePath | 小程序页面路径 |
| ThumbUrl | 封面图片的临时cdn链接 |
| ThumbMediaId | 封面图片的临时素材id |
进入会话事件
用户在小程序“客服会话按钮”进入客服会话时将产生如下数据包：
XML 格式
<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1482048670</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[user_enter_tempsession]]></Event>
<SessionFrom><![CDATA[sessionFrom]]></SessionFrom>
</xml>
JSON 格式
{
"ToUserName": "toUser",
"FromUserName": "fromUser",
"CreateTime": 1482048670,
"MsgType": "event",
"Event": "user_enter_tempsession",
"SessionFrom": "sessionFrom"
}
参数说明
| 参数 | 说明 |
|---|---|
| ToUserName | 小程序的原始ID |
| FromUserName | 发送者的openid |
| CreateTime | 事件创建时间(整型） |
| MsgType | event |
| Event | 事件类型，user_enter_tempsession |
| SessionFrom | 开发者在客服会话按钮设置的 session-from 属性 |