微信预置事件

事件英文变量名

事件显示名

属性英文变量名

事件属性显示名

属性值类型

属性值示例或说明

触发时机

备注

$WechatReceiveMsgFromUser


微信用户给公众号发消息

$app_id

应用唯一标识

字符串


当普通微信用户向公众账号发消息时,微信服务器将 POST 消息的 XML 数据包到开发者填写的 URL 上,后端基于接收到的 XML 数据包上报事件


$app_name

应用/公众号名称

字符串


$app_type_info

应用/公众号类型

字符串


$mp_receive_msg_type

公众号用户发送消息类型

字符串

TEXT,对应“文字消息”;

IMAGE,对应“图片消息”;

VOICE,对应“语音消息”;

VIDEO,对应“视频消息”;

SHORTVIDEO,对应“小视频消息”;

LOCATION,对应“地理位置信息”;

LINK,对应“链接消息”。

$mp_content

公众号消息文本内容

字符串


$mp_msg_id

公众号用户发送消息 ID

字符串

64 位整型

$mp_pic_url

公众号消息图片链接

字符串


$mp_media_id

公众号消息媒体 ID

字符串


$mp_voice_format

公众号语音格式

字符串

amr,speex

$mp_voice_recognition

公众号消息语音识别结果

字符串

UTF 编码

$mp_thumb_media_id

公众号消息缩略图媒体 ID

字符串


$latitude

纬度

数值


$longitude

经度

数值


$map_scale

地图缩放大小

数值


$location_info

地理位置信息

字符串


$mp_title

公众号消息标题

字符串


$mp_description

公众号消息描述

字符串


$mp_url

公众号消息链接

字符串


$WechatFollow

关注微信公众号

$is_first_time

是否首次

布尔值


用户在关注与取消关注公众号时,微信会把这个事件( XML 数据包)推送到开发者填写的 URL ,后端基于接收到的 XML 数据包上报事件。


$app_id

应用唯一标识

字符串


$app_name

应用/公众号名称

字符串


$app_type_info

应用/公众号类型

字符串


$mp_event_key

公众号事件 KEY

字符串

(1)主动关注

(2)参数二维码引导的关注:qrscene_为前缀,后面为二维码的参数值

$WechatUnfollow

取关微信公众号

$is_first_time

是否首次

布尔值


用户在关注与取消关注公众号时,微信会把这个事件( XML 数据包)推送到开发者填写的 URL ,后端基于接收到的 XML 数据包上报事件。


$app_id

应用唯一标识

字符串


$app_name

应用/公众号名称

字符串


$app_type_info

应用/公众号类型

字符串


$WechatScanQrcodeScene

扫描微信参数二维码

$app_id

应用唯一标识

字符串


用户扫描带场景值二维码时,

1)用户已经关注公众号,直接基于微信推送的 XML 数据包进行上报。

2)若用户未关注公众号,则关注后才会收到微信推送的 XML 事件,将拆成 2 个事件上报,关注公众号和扫描参数二维码

具体场景为:用户扫描了该公众号账号的二维码

$app_name

应用/公众号名称

字符串


$app_type_info

应用/公众号类型

字符串


$mp_event_key

公众号事件 KEY

字符串

两种类型:

(1)一个32位无符号整数,即创建二维码时的二维码 scene_id;

(2)1到64长度的字符串。

$mp_channel_qrcode_id微信服务号渠道二维码ID字符串
$mp_fission_activity_id微信服务号裂变活动ID字符串
$mp_fission_inviter_nickname微信服务号裂变邀请者昵称字符串

$WechatUpdateUserLocation

上报微信用户地理位置(可根据客户实际需求,目前没有明确场景)

$app_id

应用唯一标识

字符串


用户同意上报地理位置后,每次进入公众号会话时,都会在进入时上报地理位置,或在进入会话后每5秒上报一次地理位置,公众号可以在公众平台网站中修改以上设置。上报地理位置时,微信会将上报地理位置事件推送到开发者填写的 URL 。后端基于接收到的 XML 数据包上报事件。


$app_name

应用/公众号名称

字符串


$app_type_info

应用/公众号类型

字符串


$latitude

纬度

数值


$longitude

经度

数值


$location_precision

地理位置精度

数值


$WechatClickMenu


点击微信公众号菜单

$app_id

应用唯一标识

字符串


用户点击自定义菜单后,微信会把点击事件推送给开发者,后端基于接收到的 XML 数据包上报事件。(请注意,点击菜单弹出子菜单,不会产生上报)


$app_name

应用/公众号名称

字符串


$app_type_info

应用/公众号类型

字符串


$mp_click_menu_type

公众号菜单事件类型

字符串

CLICK,对应“拉取消息”;

VIEW,对应“跳转链接”;
scancode_push,对应“扫码推事件”;
scancode_waitmsg,对应“扫码推事件且弹出’消息接收中’提示框“;
pic_sysphoto:对应“弹出系统拍照发图”;
pic_photo_or_album:对应“弹出拍照或者相册发图“;
pic_weixin:对应“弹出微信相册发图器”;
location_select:对应“弹出地理位置选择器”;
view_miniprogram:对应”点击菜单跳转小程序“。

$mp_event_key

公众号事件 KEY

字符串

拉取消息:自定义菜单接口中 KEY 值对应

跳转链接:设置的跳转 URL

$mp_menu_id

公众号菜单 ID

字符串

如果是个性化菜单,则可以通过这个字段,知道是哪个规则的菜单被点击了

$mp_scan_type

微信用户扫描的类型

字符串

示例值:qrcode

$mp_scan_result

微信用户扫描的结果

字符串

示例值:https://cli.im/
扫描结果可能是二维码地址

$mp_send_pics_count

微信用户发送的图片数量

数值

示例值:10

$mp_send_pics_md5_list

微信用户发送图片的 md5 值列表

List

示例值:["first", “second"]

$mp_poi_name

微信用户的 POI 名称

字符串

示例值:大运村公寓(北京市海淀区知春路29号)

$WechatClickMsgmenu

点击微信菜单会话

$app_id

应用唯一标识

字符串


用户点击菜单选项时,微信会把点击事件推送给开发者,后端基于接收到的 XML 数据包上报事件。

具体场景为:当用户接收到带有菜单选项的客服消息,并且点击了其中某一个菜单选项。

$app_name

应用/公众号名称

字符串


$app_type_info

应用/公众号类型

字符串


$mp_content

公众号消息文本内容

字符串


$mp_msg_id

公众号接收消息 ID

字符串


$mp_bizmsgmenu_id

公众号菜单会话选项

字符串


$WechatSubscribeMsgPopup


 

 

 

 

触发订阅消息弹框


 

 

 

 

$app_id

应用唯一标识

字符串


当用户在小程序内触发了订阅消息弹框时,微信服务器将 POST 消息的 XML 数据包到开发者填写的 URL 上,后端基于接收到的 XML 数据包上报事件






$app_name

应用/公众号名称

字符串


$mp_template_id

订阅消息模板ID

字符串

订阅消息模板的ID

$mp_subscribe_status

订阅结果

字符串

accept(接收);reject(拒收)

$mp_popup_scene

授权弹窗请求场景

字符串

0(小程序页面内)

$WechatSubscribeMsgChange


 

 

 

管理订阅消息


 

 

 

$app_id

应用唯一标识

字符串


当用户在服务通知内点击消息卡片右上角“...”管理消息时,微信服务器将 POST 消息的 XML 数据包到开发者填写的 URL 上,后端基于接收到的 XML 数据包上报事件





$app_name

应用/公众号名称

字符串


$mp_template_id

订阅消息模板ID

字符串

订阅消息模板的ID

$mp_subscribe_status

订阅结果

字符串

reject(拒收)

微信预置用户属性

属性英文变量名属性显示名属性值类型属性值示例或说明备注

$mp_{appid}_openid

公众号/小程序名称 用户 openid

字符串

示例值:oH5XvtwZNMb-OlS3xbja-T9vHCn0


$mp_nickname

公众号/小程序用户昵称

字符串

示例值:iWithery


$mp_{appid}_remark

公众号/小程序 用户备注

字符串

示例值:pangzi


$mp_{appid}_is_in_blacklist

用户是否在黑名单中

布尔值

示例值:true


$mp_{appid}_subscribe

用户是否关注公众号

布尔值

示例值:true


$mp_sex

公众号/小程序用户性别

数值

示例值:0


$mp_headimgurl 

公众号/小程序用户头像链接

字符串

示例值:http://thirdwx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/0


$mp_headimg_cdn_url

公众号/小程序用户头像 cdn 链接

字符串

示例值:https://reso.eqh5.com/FtSPfOom4RUclvEKtAjarI1whlV3


$mp_{appid}_tagid_list

用户标签列表

List

示例值:[128,2]


$mp_language

公众号/小程序用户的语言

字符串

示例值:zh_CN


$mp_country

公众号/小程序用户所在国家

字符串

示例值:中国


$mp_province

公众号/小程序用户所在省份

字符串

示例值:广东


$mp_city

公众号/小程序用户所在城市

字符串

示例值:广州


$mp_{appid}_subscribe_scene

用户关注来源

字符串

示例值:ADD_SCENE_QR_CODE


$mp_{appid}_subscribe_time

用户最近关注时间

日期

示例值:1585804006956


$mp_{appid}_latest_interactive_time

用户最近互动时间

日期

示例值:1585804006956


$mp_unionid 

公众号/小程序用户 unionid

字符串

示例值:o6_bmasdasdsad6_2sgVt7hMZOPfL


$mp_{appid}_qr_scene

用户二维码扫码场景

数值

示例值:98765


$mp_{appid}_qr_scene_str

二维码扫码场景描述

字符串

示例值:"scene_sample"