Skip to content
On this page

服务端

我们在入门小教程一节以服务端为例讲解了一个基本的消息的处理,这里就不再讲服务器验证的流程了,请直接参考前面的入门实例即可。

服务端的作用呢,在整个微信开发中主要是负责 接收用户发送过来的消息,还有 用户触发的一系列事件

首先我们得厘清一下消息与事件的回复,当你收到用户消息后(消息由微信服务器推送到你的服务器),在你对消息进行一些处理后,不管是选择回复一个消息还是什么不都回给用户,你也应该给微信服务器一个 “答复”,如果是选择回复一条消息,就直接返回一个消息xml就好,如果选择不作任何回复,你也得回复一个空字符串或者字符串 SUCCESS(不然用户就会看到 该公众号暂时无法提供服务)。

基本使用

在 SDK 中呢,使用 setMessageHandler(callable $callback) 来设置消息处理函数:

<?php
use EasyWeChat\Foundation\Application;

// ...

$app = new Application($options);

// 从项目实例中得到服务端应用实例。
$server = $app->server;

$server->setMessageHandler(function ($message) {
    // $message->FromUserName // 用户的 openid
    // $message->MsgType // 消息类型:event, text....
    return "您好!欢迎关注我!";
});

$response = $server->serve();

$response->send(); // Laravel 里请使用:return $response;

这里我们使用 setMessageHandler 传入了一个 闭包(Closure,该闭包接收一个参数 $message 为消息对象(Collection),这里需要注意的时,与 2.0 不同,2.0 当中我们对消息与事件做了区分,还对消息进行了分类(按 MsgType)。在 3.0 后,所有的消息包括事件都会使用 setMessageHandler 来处理,也就是说你可能需要在里面进行一些判断,例如:

$server->setMessageHandler(function ($message) {
    switch ($message->MsgType) {
        case 'event':
            return '收到事件消息';
            break;
        case 'text':
            return '收到文字消息';
            break;
        case 'image':
            return '收到图片消息';
            break;
        case 'voice':
            return '收到语音消息';
            break;
        case 'video':
            return '收到视频消息';
            break;
        case 'location':
            return '收到坐标消息';
            break;
        case 'link':
            return '收到链接消息';
            break;
        // ... 其它消息
        default:
            return '收到其它消息';
            break;
    }

    // ...
});

当然,因为这里 setMessageHandler 接收一个 callable 的参数,所以你不一定要传入一个 Closure 闭包,你可以选择传入一个函数名,一个 [$class, $method] 或者 Foo::bar 这样的类型。

❤️ 注意,默认没有验证是否为微信的请求,部署上线建议关掉 debug 模式。

某些情况,我们需要直接使用 $message 参数,那么怎么在 setMessageHandler 闭包外调用呢?

    $message = $server->getMessage();

注意:$message 是一个数组类型的数据,使用的时候这样使用:$message['ToUserName']

请求消息的属性

当你接收到用户发来的消息时,可能会提取消息中的相关属性,那么请参考:

请求消息基本属性(以下所有消息都有的基本属性):

$message->ToUserName    接收方帐号(该公众号 ID)
$message->FromUserName  发送方帐号(OpenID, 代表用户的唯一标识)
$message->CreateTime    消息创建时间(时间戳)
$message->MsgId         消息 ID(64位整型)

文本:

$message->MsgType  text
$message->Content  文本消息内容

图片:

$message->MsgType  image
$message->PicUrl   图片链接

语音:

$message->MsgType        voice
$message->MediaId        语音消息媒体id,可以调用多媒体文件下载接口拉取数据。
$message->Format         语音格式,如 amr,speex 等
$message->Recognition * 开通语音识别后才有

> 请注意,开通语音识别后,用户每次发送语音给公众号时,微信会在推送的语音消息XML数据包中,增加一个 `Recongnition` 字段

视频:

$message->MsgType       video
$message->MediaId       视频消息媒体id,可以调用多媒体文件下载接口拉取数据。
$message->ThumbMediaId  视频消息缩略图的媒体id,可以调用多媒体文件下载接口拉取数据。

小视频:

$message->MsgType     shortvideo
$message->MediaId     视频消息媒体id,可以调用多媒体文件下载接口拉取数据。
$message->ThumbMediaId    视频消息缩略图的媒体id,可以调用多媒体文件下载接口拉取数据。

事件:

$message->MsgType     event
$message->Event       事件类型 (如:subscribe(订阅)、unsubscribe(取消订阅) ..., CLICK 等)

# 扫描带参数二维码事件
$message->EventKey    事件KEY值,比如:qrscene_123123,qrscene_为前缀,后面为二维码的参数值
$message->Ticket      二维码的 ticket,可用来换取二维码图片

# 上报地理位置事件
$message->Latitude    23.137466   地理位置纬度
$message->Longitude   113.352425  地理位置经度
$message->Precision   119.385040  地理位置精度

# 自定义菜单事件
$message->EventKey    事件KEY值,与自定义菜单接口中KEY值对应,如:CUSTOM_KEY_001, www.qq.com

地理位置:

$message->MsgType     location
$message->Location_X  地理位置纬度
$message->Location_Y  地理位置经度
$message->Scale       地图缩放大小
$message->Label       地理位置信息

链接:

$message->MsgType      link
$message->Title        消息标题
$message->Description  消息描述
$message->Url          消息链接

回复消息

回复的消息可以为 null,此时 SDK 会返回给微信一个 "SUCCESS",你也可以回复一个普通字符串,比如:欢迎关注 overtrue.,此时 SDK 会对它进行一个封装,产生一个 EasyWeChat\Message\Text 类型的消息并在最后的 $server->serve(); 时生成对应的消息 XML 格式。

如果你想返回一个自己手动拼的原生 XML 格式消息,请返回一个 EasyWeChat\Message\Raw 实例即可。

消息转发给客服系统

参见:多客服消息转发

关于消息的使用,请参考 消息 章节。

Released under the MIT License.