2022年使用公众平台接口进行开发文件 .pdf

使用公众平台接口进行开发查看文档使用公众平台的开发接口， 公众号可在自身服务器上接收用户的微信消息，并可按需回复。 此外，我们还提供了更多更高级的功能和体验，如会话界面的自定义菜单、获取更多类型的消息等。消息接口指南返回出自开放平台跳转到：导航, 搜索目录 隐藏 1 简介2 申请消息接口3 网址接入4 消息推送o4.1 文本消息o4.2 图片消息o4.3 地理位置消息o4.4 链接消息o4.5 事件推送5 消息回复o5.1 回复文本消息o5.2 回复音乐消息o5.3 回复图文消息6 注意事项7 示例代码简介名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 15 页 - - - - - - - - - 公众平台消息接口为开发者提供了一种新的消息处理方式。申请消息接口点击申请，填写网址 url和 token ，其中 token 可由开发者可以任意填写，用作生成签名。网址接入公众平台用户提交信息后， 微信服务器将发送GET 请求到填写的 URL上，并且带上四个参数：参数描述signature 微信加密签名timestamp 时间戳nonce 随机数名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 15 页 - - - - - - - - - echostr 随机字符串开发者通过检验 signature对请求进行校验（下面有校验方式）。若确认此次GET请求来自微信服务器，请原样返回echostr 参数内容，则接入生效，否则接入失败。signature结合了开发者填写的token 参数和请求中的timestamp 参数、 nonce参数。加密/ 校验流程：1. 将 token 、timestamp 、nonce 三个参数进行字典序排序2. 将三个参数字符串拼接成一个字符串进行sha1 加密3. 开发者获得加密后的字符串可与signature对比，标识该请求来源于微信消息推送当普通微信用户向公众账号发消息时，微信服务器将POST 该消息到填写的 URL上。结构如下：文本消息 1348831860 1234567890123456 参数描述ToUserName 开发者 微信号FromUserName 发送方帐号（一个OpenID ）CreateTime 消息创建时间（整型）MsgType text Content 文本消息内容MsgId 消息 id ，64 位整型名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 15 页 - - - - - - - - - 图片消息 1348831860 1234567890123456 参数描述ToUserName 开发者 微信号FromUserName 发送方帐号（一个OpenID ）CreateTime 消息创建时间（整型）MsgType image PicUrl 图片链接MsgId 消息 id ，64 位整型地理位置消息 1351776360 23.134521 113.358803 20 1234567890123456 参数描述ToUserName 开发者 微信号FromUserName 发送方帐号（一个OpenID ）CreateTime 消息创建时间（整型）MsgType location 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 15 页 - - - - - - - - - Location_X 地理位置纬度Location_Y 地理位置经度Scale 地图缩放大小Label 地理位置信息MsgId 消息 id ，64 位整型链接消息 1351776360 1234567890123456 参数描述ToUserName 接收方微信号FromUserName 发送方微信号，若为普通用户，则是一个OpenID CreateTime 消息创建时间MsgType 消息类型， link Title 消息标题Description 消息描述Url 消息链接MsgId 消息 id ，64 位整型事件推送事件推送只支持微信4.5 版本，目前开启自定义菜单接口事件推送、关注与取消关注事件推送。其余功能即将开放，敬请期待。 123456789 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页，共 15 页 - - - - - - - - - 参数描述ToUserName 接收方微信号FromUserName 发送方微信号，若为普通用户，则是一个OpenID CreateTime 消息创建时间MsgType 消息类型， event Event 事件类型， subscribe( 订阅) 、unsubscribe( 取消订阅 ) 、CLICK(自定义菜单点击事件 ) EventKey 事件 KEY值，与自定义菜单接口中KEY值对应消息回复对于每一个 POST 请求，开发者在响应包中返回特定xml 结构，对该消息进行响应（现支持回复文本、 图文、语音、视频、音乐和对收到的消息进行星标操作）。微信服务器在 五秒内 收不到响应会断掉连接。回复 xml 结构如下：回复文本消息 12345678 0 参数描述ToUserName 接收方帐号（收到的OpenID ）FromUserName 开发者微信号CreateTime 消息创建时间MsgType text 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页，共 15 页 - - - - - - - - - Content 回复的消息内容 , 长度不超过 2048字节FuncFlag 位 0 x0001被标志时，星标刚收到的消息。回复音乐消息 12345678 0 参数描述ToUserName 接收方帐号（收到的OpenID ）FromUserName 开发者微信号CreateTime 消息创建时间MsgType music MusicUrl 音乐链接HQMusicUrl 高质量音乐链接， WIFI 环境优先使用该链接播放音乐FuncFlag 位 0 x0001被标志时，星标刚收到的消息。回复图文消息 12345678 2 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 7 页，共 15 页 - - - - - - - - - 1 参数描述ToUserName 接收方帐号（收到的OpenID ）FromUserName 开发者微信号CreateTime 消息创建时间MsgType news ArticleCount 图文消息个数，限制为10条以内Articles 多条图文消息信息，默认第一个item 为大图Title 图文消息标题Description 图文消息描述PicUrl 图片链接，支持JPG 、PNG 格式，较好的效果为大图640*320，小图 80*80。Url 点击图文消息跳转链接注意事项1. 用户 OpenID对一个公众号是固定唯一的串2. 请使用 80 端口示例代码PHP ：下载名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 8 页，共 15 页 - - - - - - - - - 通用接口文档返回出自开放平台跳转到：导航, 搜索简介通用接口是使用 HTTP请求，让开发者直接与微信服务器交互，实现媒体文件上传、媒体文件获取等功能，达到获取图片、语音、视频等媒体文件的目的。调用接口所需要的access_token 必须通过获取凭证接口获取。获取凭证接口说明在使用通用接口前，你需要做以下两步工作：1. 拥有一个微信公众账号，并获取到appid 和 appsecret （在公众平台申请内测资格，审核通过后可获得）2. 通过获取凭证接口获取到access_token 注意：access_token 是第三方访问 api 资源的票据；access_token 对应于公众号是全局唯一的票据，重复获取将导致上次获取的access_token 失效。请求说明http 请求方式 : GET https:/ 是获取 access_token 填写 client_credential 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 9 页，共 15 页 - - - - - - - - - appid 是第三方用户唯一凭证secret 是第三方用户唯一凭证密钥，既appsecret 返回说明正确的 Json 返回结果 : access_token:ACCESS_TOKEN,expires_in:7200 参数说明access_token 获取到的凭证expires_in 凭证有效时间，单位：秒错误的 Json 返回示例 : errcode:40013,errmsg:invalid appid 统一返回码说明自定义菜单接口返回出自开放平台跳转到：导航, 搜索目录 隐藏 1 简介2 菜单创建3 菜单查询4 菜单删除简介开发者获取使用凭证 （如何获取凭证 ）后，可以使用该凭证对公众账号的自定义菜单进行创建、查询和删除等操作。自定义菜单接口可实现以下类型按钮：名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 10 页，共 15 页 - - - - - - - - - click （点击事件）：用户点击 click类型按钮后， 微信服务器会通过 消息接口 (event 类型)推送点击事件给开发者， 并且带上按钮中开发者填写的key 值，开发者可以通过自定义的key 值进行 消息回复 。创建自定义菜单后，由于微信客户端缓存，需要24 小时微信客户端才会展现出来。建议测试时可以尝试取消关注公众账号后，再次关注， 则可以看到创建后的效果。菜单创建接口说明通过 POST 一个特定结构体，实现在微信客户端创建自定义菜单。请求说明http 请求方式： POST https:/ button: type:click, name:今日歌曲 , key:V1001_TODAY_MUSIC , type:click, name:歌手简介 , key:V1001_TODAY_SINGER , name:菜单, sub_button: type:click, name:hello word, key:V1001_HELLO_WORLD 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 11 页，共 15 页 - - - - - - - - - , type:click, name:赞一下我们 , key:V1001_GOOD 创建后效果 : 参数说明参数是否必须说明button 是按钮数组，按钮个数应为23个sub_button 否子按钮数组，按钮个数应为25个type 是按钮类型，目前有click类型名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 12 页，共 15 页 - - - - - - - - - name 是按钮描述，既按钮名字，不超过16 个字节，子菜单不超过 40 个字节key 类型为 click必须按钮 KEY值，用于消息接口 (event 类型)推送，不超过128 字节返回说明正确的 Json 返回结果 : errcode:0,errmsg:ok 错误的 Json 返回结果errcode:40018,errmsg:invalid button name size 统一返回码说明菜单查询接口说明查询当前使用的自定义菜单结构。请求说明http 请求方式： GET https:/ 返回结果 : menu:button:type:click,name:今日歌曲,key:V1001_TODAY_MUSIC,sub_button:,type:click,name:歌手简介 ,key:V1001_TODAY_SINGER,sub_button:,name:菜单,sub_button:type:click,name:hello word,key:V1001_HELLO_WORLD,sub_button:,type:click,name: 赞一下我们 ,key:V1001_GOOD,sub_button: 统一返回码说明菜单删除名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 13 页，共 15 页 - - - - - - - - - 接口说明取消当前使用的自定义菜单。请求说明http 请求方式： GET https:/ 返回结果 : errcode:0,errmsg:ok 统一返回码说明接口权限返回出自开放平台跳转到：导航, 搜索简介请先确保公众账号已经拥有接口调用权限。默认每个公众帐号都不能超过下面的频率限制。当超出调用接口频率限制， 调用对应接口将会收到如下错误信息：errcode:45009,errmsg:api freq out of limit 接口调用频率限制接口名称频率限制获取凭证接口200（次/ 天）自定义菜单创建接口100（次/ 天）自定义菜单查询接口1000（次/ 天）名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 14 页，共 15 页 - - - - - - - - - 自定义菜单删除接口100（次/ 天）接口权限返回出自开放平台跳转到：导航, 搜索简介请先确保公众账号已经拥有接口调用权限。默认每个公众帐号都不能超过下面的频率限制。当超出调用接口频率限制， 调用对应接口将会收到如下错误信息：errcode:45009,errmsg:api freq out of limit 接口调用频率限制接口名称频率限制获取凭证接口200（次/ 天）自定义菜单创建接口100（次/ 天）自定义菜单查询接口1000（次/ 天）自定义菜单删除接口100（次/ 天）名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 15 页，共 15 页 - - - - - - - - -