开发者需要按照如下步骤完成:

    • 验证服务器地址的有效性
    • 据接口文档实现业务逻辑,接收消息和事件

    第一步:填写服务器配置

    登录小程序后台后,在「开发」-「开发设置」-「消息推送」中,管理员扫码启用消息服务,填写服务器地址(URL)、令牌(Token) 和 消息加密密钥(EncodingAESKey)等信息。

    • URL: 开发者用来接收微信消息和事件的接口 URL。开发者所填写的URL 必须以 http:// 或 https:// 开头,分别支持 80 端口和 443 端口。
    • Token: 可由开发者可以任意填写,用作生成签名(该 Token 会和接口 URL 中包含的 Token 进行比对,从而验证安全性)。
    • EncodingAESKey: 由开发者手动填写或随机生成,将用作消息体加解密密钥。

    同时,开发者可选择消息加解密方式:明文模式(默认)、兼容模式和安全模式。可以选择消息数据格式:XML 格式(默认)或 JSON 格式。

    模式的选择与服务器配置在提交后都会立即生效,请开发者谨慎填写及选择。切换加密方式和数据格式需要提前配置好相关代码,详情请参考 。

    第二步:验证消息的确来自微信服务器

    开发者提交信息后,微信服务器将发送GET请求到填写的服务器地址URL上,GET请求携带参数如下表所示:

    开发者通过检验 signature 对请求进行校验(下面有校验方式)。若确认此次 GET 请求来自微信服务器,请原样返回 echostr 参数内容,则接入生效,成为开发者成功,否则接入失败。加密/校验流程如下:

    • 将token、timestamp、nonce三个参数进行字典序排序
    • 将三个参数字符串拼接成一个字符串进行sha1加密
    • 开发者获得加密后的字符串可与signature对比,标识该请求来源于微信验证URL有效性成功后即接入生效,成为开发者。

    PHP示例代码下载:下载

    第三步:接收消息和事件

    当某些特定的用户操作引发事件推送时(如用户向小程序客服发送消息、或者进入会话等情况),微信服务器会将消息(或事件)的数据包以 POST 请求发送到开发者配置的 URL,开发者可以依据自身业务逻辑进行响应。

    微信服务器在将用户的消息发给开发者服务器地址后,微信服务器在五秒内收不到响应会断掉连接,并且重新发起请求,总共重试三次。如果在调试中,发现用户无法收到响应的消息,可以检查是否消息处理超时。关于重试的消息排重,有 msgid 的消息推荐使用 msgid 排重。事件类型消息推荐使用 FromUserName + CreateTime 排重。

    服务器收到请求必须做出下述回复,这样微信服务器才不会对此作任何处理,并且不会发起重试,否则,将出现严重的错误提示。详见下面说明:

    • 直接回复success(推荐方式)
    • 若接口文档有指定返回内容,应按文档说明返回对于客服消息,一旦遇到以下情况,微信会在小程序会话中向用户下发系统提示“该小程序客服暂时无法提供服务,请稍后再试”:

    • 开发者在5秒内未回复任何内容

    • 开发者回复了异常数据如果开发者希望增强安全性,可以在开发者中心处开启消息加密,这样,用户发给小程序的消息以及小程序被动回复用户消息都会继续加密,详见。

    云函数接收消息推送

    开通了的小程序可以使用云函数接收消息推送,目前仅支持客服消息推送。

    接入步骤如下:

    • 开发者工具中填写配置并上传
    • 云函数中处理消息

    第一步:开发者工具中填写配置并上传

    在项目根目录下新建消息推送配置文件 temp-cloud-callback-config.json 并在填写完成后右键该文件选择上传配置

    配置文件格式如下(以客服消息推送配置为例):

    字段说明:

    • enable: 只有为 true 时云函数消息推送才会启用,否则所有云函数消息推送都不会生效
    • callbacks: 接收推送的所有云函数配置
    • : 消息的 msgType,客服消息的 msgType 为 1
    • callbacks.functionName: 接收消息推送的云函数名称

    写好后,右键该文件,选择上传配置。

    第二步:云函数中处理消息

    云函数被触发时,其 event 参数即是接口所定义的 JSON 结构的对象(统一 JSON 格式,不支持 XML 格式)。

    此时可调用客服消息发送接口回复消息,一个简单的接收到消息后统一回复 “收到” 的示例如下: