微信开发者文档.docx
- 文档编号:10557868
- 上传时间:2023-02-21
- 格式:DOCX
- 页数:47
- 大小:50.54KB
微信开发者文档.docx
《微信开发者文档.docx》由会员分享,可在线阅读,更多相关《微信开发者文档.docx(47页珍藏版)》请在冰豆网上搜索。
微信开发者文档
接收事件推送
目录
1关注/取消关注事件
2扫描带参数二维码事件
3上报地理位置事件
4自定义菜单事件
5点击菜单拉取消息时的事件推送
6点击菜单跳转链接时的事件推送
关注/取消关注事件
用户在关注与取消关注公众号时,微信会把这个事件推送到开发者填写的URL。
方便开发者给用户下发欢迎消息或者做帐号的解绑。
微信服务器在五秒内收不到响应会断掉连接,并且重新发起请求,总共重试三次
关于重试的消息排重,推荐使用FromUserName+CreateTime排重。
假如服务器无法保证在五秒内处理并回复,可以直接回复空串,微信服务器不会对此作任何处理,并且不会发起重试。
推送XML数据包示例:
[CDATA[toUser]]>
[CDATA[FromUser]]>
[CDATA[event]]>
[CDATA[subscribe]]>
参数说明:
参数描述
ToUserName开发者微信号
FromUserName发送方帐号(一个OpenID)
CreateTime消息创建时间(整型)
MsgType消息类型,event
Event事件类型,subscribe(订阅)、unsubscribe(取消订阅)
扫描带参数二维码事件
用户扫描带场景值二维码时,可能推送以下两种事件:
1.如果用户还未关注公众号,则用户可以关注公众号,关注后微信会将带场景值关注事件推送给开发者。
2.如果用户已经关注公众号,则微信会将带场景值扫描事件推送给开发者。
1.用户未关注时,进行关注后的事件推送
推送XML数据包示例:
[CDATA[toUser]]>
[CDATA[FromUser]]>
[CDATA[event]]>
[CDATA[subscribe]]>
[CDATA[qrscene_123123]]>
[CDATA[TICKET]]>
参数说明:
参数描述
ToUserName开发者微信号
FromUserName发送方帐号(一个OpenID)
CreateTime消息创建时间(整型)
MsgType消息类型,event
Event事件类型,subscribe
EventKey事件KEY值,qrscene_为前缀,后面为二维码的参数值
Ticket二维码的ticket,可用来换取二维码图片
2.用户已关注时的事件推送
推送XML数据包示例:
[CDATA[toUser]]>
[CDATA[FromUser]]>
[CDATA[event]]>
[CDATA[SCAN]]>
[CDATA[SCENE_VALUE]]>
[CDATA[TICKET]]>
参数说明:
参数描述
ToUserName开发者微信号
FromUserName发送方帐号(一个OpenID)
CreateTime消息创建时间(整型)
MsgType消息类型,event
Event事件类型,SCAN
EventKey事件KEY值,是一个32位无符号整数,即创建二维码时的二维码scene_id
Ticket二维码的ticket,可用来换取二维码图片
上报地理位置事件
用户同意上报地理位置后,每次进入公众号会话时,都会在进入时上报地理位置,或在进入会话后每5秒上报一次地理位置,公众号可以在公众平台网站中修改以上设置。
上报地理位置时,微信会将上报地理位置事件推送到开发者填写的URL。
推送XML数据包示例:
[CDATA[toUser]]>
[CDATA[fromUser]]>
[CDATA[event]]>
[CDATA[LOCATION]]>
参数说明:
参数描述
ToUserName开发者微信号
FromUserName发送方帐号(一个OpenID)
CreateTime消息创建时间(整型)
MsgType消息类型,event
Event事件类型,LOCATION
Latitude地理位置纬度
Longitude地理位置经度
Precision地理位置精度
使用网页调试工具调试该接口
自定义菜单事件
用户点击自定义菜单后,微信会把点击事件推送给开发者,请注意,点击菜单弹出子菜单,不会产生上报。
点击菜单拉取消息时的事件推送
推送XML数据包示例:
[CDATA[toUser]]>
[CDATA[FromUser]]>
[CDATA[event]]>
[CDATA[CLICK]]>
[CDATA[EVENTKEY]]>
参数说明:
参数描述
ToUserName开发者微信号
FromUserName发送方帐号(一个OpenID)
CreateTime消息创建时间(整型)
MsgType消息类型,event
Event事件类型,CLICK
EventKey事件KEY值,与自定义菜单接口中KEY值对应
点击菜单跳转链接时的事件推送
推送XML数据包示例:
[CDATA[toUser]]>
[CDATA[FromUser]]>
[CDATA[event]]>
[CDATA[VIEW]]>
[CDATA[]]>
参数说明:
参数描述
ToUserName开发者微信号
FromUserName发送方帐号(一个OpenID)
CreateTime消息创建时间(整型)
MsgType消息类型,event
Event事件类型,VIEW
EventKey事件KEY值,设置的跳转URL
开通语音识别功能
用户每次发送语音给公众号时,微信会在推送的语音消息XML数据包中,增加一个Recongnition字段。
注:
由于客户端缓存,开发者开启或者关闭语音识别功能,对新关注者立刻生效,对已关注用户需要24小时生效。
开发者可以重新关注此帐号进行测试。
开启语音识别后的语音XML数据包如下:
[CDATA[toUser]]>
[CDATA[fromUser]]>
[CDATA[voice]]>
[CDATA[media_id]]>
[CDATA[Format]]>
[CDATA[腾讯微信团队]]>
参数说明:
参数描述
ToUserName开发者微信号
FromUserName发送方帐号(一个OpenID)
CreateTime消息创建时间(整型)
MsgType语音为voice
MediaID语音消息媒体id,可以调用多媒体文件下载接口拉取该媒体
Format语音格式:
amr
Recognition语音识别结果,UTF8编码
MsgID消息id,64位整型
发送被动响应消息
对于每一个POST请求,开发者在响应包(Get)中返回特定XML结构,对该消息进行响应(现支持回复文本、图片、图文、语音、视频、音乐)。
请注意,回复图片等多媒体消息时需要预先上传多媒体文
件到微信服务器,只支持认证服务号。
微信服务器在五秒内收不到响应会断掉连接,并且重新发起请求,总共重试三次,如果在调试中,发现用户无法收到响应的消息,可以检查是否消息处理超时。
关于重试的消息排重,有msgid的消息推荐使用msgid排重。
事件类型消息推荐使用FromUserName+CreateTime排重。
假如服务器无法保证在五秒内处理并回复,必须直接回复空串(是指回复一个空字符串,而不是一个XML结构体中content字段的内容为空,请切勿误解),微信服务器不会对此作任何处理,并且不会发
起重试。
。
这种情况下,可以使用客服消息接口进行异步回复。
请开发者注意,一旦遇到以下情况,微信都会在公众号会话中,向用户下发系统提示“该公众号暂时无法提供服务,请稍后再试”:
1、开发者在5秒内未回复任何内容
2、开发者回复了异常数据,比如JSON数据等
各消息类型需要的XML数据包结构如下。
目录1回复文本消息
2回复图片消息
3回复语音消息
4回复视频消息
5回复音乐消息
6回复图文消息
回复文本消息
[CDATA[toUser]]>
[CDATA[fromUser]]>
[CDATA[text]]>
[CDATA[你好]]>
参数是否必须描述
ToUserName是接收方帐号(收到的OpenID)
FromUserName是开发者微信号
CreateTime是消息创建时间(整型)
MsgType是text
Content是回复的消息内容(换行:
在content中能够换行,微信客户端就支持换行显示)
回复图片消息
[CDATA[toUser]]>
[CDATA[fromUser]]>
[CDATA[image]]>
[CDATA[media_id]]>
参数是否必须说明
ToUserName是接收方帐号(收到的OpenID)
FromUserName是开发者微信号
CreateTime是消息创建时间(整型)
MsgType是image
MediaId是通过上传多媒体文件,得到的id。
回复语音消息
[CDATA[toUser]]>
[CDATA[fromUser]]>
[CDATA[voice]]>
[CDATA[media_id]]>
参数是否必须说明
ToUserName是接收方帐号(收到的OpenID)
FromUserName是开发者微信号
CreateTime是消息创建时间戳(整型)
MsgType是语音,voice
MediaId是通过上传多媒体文件,得到的id
回复视频消息
[CDATA[toUser]]>
[CDATA[fromUser]]>
[CDATA[video]]>
[CDATA[media_id]]>
[CDATA[title]]>
[CDATA[description]]>
参数是否必须说明
ToUserName是接收方帐号(收到的OpenID)
FromUserName是开发者微信号
CreateTime是消息创建时间(整型)
MsgType是video
MediaId是通过上传多媒体文件,得到的id
Title否视频消息的标题
Description否视频消息的描述
回复音乐消息
[CDATA[toUser]]>
[CDATA[fromUser]]>
[CDATA[music]]>
[CDATA[TITLE]]>
[CDATA[DESCRIPTION]]>
[CDATA[MUSIC_Url]]>
[CDATA[HQ_MUSIC_Url]]>
[CDATA[media_id]]>
参数是否必须说明
ToUserName是接收方帐号(收到的OpenID)
FromUserName是开发者微信号
CreateTime是消息创建时间(整型)
MsgType是music
Title否音乐标题
Description否音乐描述
MusicURL否音乐链接
HQMusicUrl否高质量音乐链接,WIFI环境优先使用该链接播放音乐
ThumbMediaId是缩略图的媒体id,通过上传多媒体文件,得到的id
回复图文消息
[CDATA[toUser]]>
[CDATA[fromUser]]>
[CDATA[news]]>
[CDATA[title1]]>
[CDATA[description1]]>
[CDATA[picurl]]>
[CDATA[url]]>
[CDATA[title]]>
[CDATA[description]]>
[CDATA[picurl]]>
[CDATA[url]]>
参数是否必须说明
ToUserName是接收方帐号(收到的OpenID)
FromUserName是开发者微信号
CreateTime是消息创建时间(整型)
MsgType是news
ArticleCount是图文消息个数,限制为10条以内
Articles是多条图文消息信息,默认第一个item为大图,注意,如果图文数超过10,则将会无响应
Title否图文消息标题
Description否图文消息描述
PicUrl否图片链接,支持JPG、PNG格式,较好的效果为大图360*200,小图200*200
Url否点击图文消息跳转链接
发送客服消息
出自微信公众平台开发者文档
当用户主动发消息给公众号的时候(包括发送信息、点击自定义菜单、订阅事件、扫描二维码事件、支付成功事件、用户维权),微信将会把消息数据推送给开发者,开发者在一段时间内(目前修改为48小时)可以调用客服消息接口,通过POST一个JSON数据包来发送消息给普通用户,在48小时内不限制发送次数。
此接口主要用于客服等有人工消息处理环节的功能,方便开发者为用户提供更加优质的服务。
接口调用请求说明
http请求方式:
POST
各消息类型所需的JSON数据包如下。
发送文本消息
{
"touser":
"OPENID",
"msgtype":
"text",
"text":
{
"content":
"HelloWorld"
}
}
参数
是否必须
说明
access_token
是
调用接口凭证
touser
是
普通用户openid
msgtype
是
消息类型,text
content
是
文本消息内容
发送图片消息
{
"touser":
"OPENID",
"msgtype":
"image",
"image":
{
"media_id":
"MEDIA_ID"
}
}
参数
是否必须
说明
access_token
是
调用接口凭证
touser
是
普通用户openid
msgtype
是
消息类型,image
media_id
是
发送的图片的媒体ID
发送语音消息
{
"touser":
"OPENID",
"msgtype":
"voice",
"voice":
{
"media_id":
"MEDIA_ID"
}
}
参数
是否必须
说明
access_token
是
调用接口凭证
touser
是
普通用户openid
msgtype
是
消息类型,voice
media_id
是
发送的语音的媒体ID
发送视频消息
{
"touser":
"OPENID",
"msgtype":
"video",
"video":
{
"media_id":
"MEDIA_ID",
"thumb_media_id":
"MEDIA_ID",
"title":
"TITLE",
"description":
"DESCRIPTION"
}
}
参数
是否必须
说明
access_token
是
调用接口凭证
touser
是
普通用户openid
msgtype
是
消息类型,video
media_id
是
发送的视频的媒体ID
thumb_media_id
是
缩略图的媒体ID
title
否
视频消息的标题
description
否
视频消息的描述
发送音乐消息
{
"touser":
"OPENID",
"msgtype":
"music",
"music":
{
"title":
"MUSIC_TITLE",
"description":
"MUSIC_DESCRIPTION",
"musicurl":
"MUSIC_URL",
"hqmusicurl":
"HQ_MUSIC_URL",
"thumb_media_id":
"THUMB_MEDIA_ID"
}
}
参数
是否必须
说明
access_token
是
调用接口凭证
touser
是
普通用户openid
msgtype
是
消息类型,music
title
否
音乐标题
description
否
音乐描述
musicurl
是
音乐链接
hqmusicu
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 开发者 文档