EasyWeChat

Appearance

Return to top
On this page

消息

我把微信的 API 里的所有“消息”都按类型抽象出来了，也就是说，你不用区分它是回复消息还是主动推送消息，免去了你去手动拼装微信那帮 SB 那么恶心的 XML 以及乱七八糟命名不统一的 JSON 了，我替你承受这份苦，不要问是谁，我是雷锋他弟弟，雷管。

在阅读以下内容时请忽略是接收消息还是回复消息，后面我会给你讲它们的区别。

消息类型

消息分为以下几种：文本、图片、视频、声音、链接、坐标、图文、文章 和一种特殊的 原始消息。

另外还有一种特殊的消息类型：素材消息，用于群发或者客服时发送已有素材用。

注意：回复消息与客服消息里的图文类型为：图文，群发与素材中的图文为文章

所有的消息类都在 EasyWeChat\Message 这个命名空间下， 下面我们来分开讲解：

文本消息

属性列表：

- content 文本内容
php
<?php

use EasyWeChat\Message\Text;

$text = new Text(['content' => '您好！overtrue。']);

// or
$text = new Text();
$text->content = '您好！overtrue。';

// or
$text = new Text();
$text->setAttribute('content', '您好！overtrue。');

图片消息

属性列表：

- media_id 媒体资源 ID
php
<?php

use EasyWeChat\Message\Image;

$text = new Image(['media_id' => $mediaId]);

// or
$text = new Image();
$text->media_id = $mediaId; // or $text->mediaId = $media;

// or
$text = new Image();
$text->setAttribute('media_id', $mediaId);

视频消息

属性列表：

- title 标题
- description 描述
- media_id 媒体资源 ID
- thumb_media_id 封面资源 ID
php
<?php

use EasyWeChat\Message\Video;

$video = new Video([
        'title' => $title,
        'media_id' => $mediaId,
        'description' => '...',
        // ...
    ]);

// or
$video = new Video();
$video->media_id = $mediaId; // or $video->mediaId = $media;
$video->description = 'video description...'; // or $video->description = $description;
// ...

// or
$video = new Video();
$video->setAttribute('media_id', $mediaId);
// ...

声音消息

属性列表：

- media_id 媒体资源 ID
php
<?php

use EasyWeChat\Message\Voice;

$voice = new Voice(['media_id' => $mediaId]);

// or
$voice = new Voice();
$voice->media_id = $mediaId; // or $voice->mediaId = $media;

// or
$voice = new Voice();
$voice->setAttribute('media_id', $mediaId);

链接消息

微信目前不支持回复链接消息

坐标消息

微信目前不支持回复坐标消息

图文消息

属性列表：

- title 标题
- description 描述
- image 图片链接
- url 链接 URL
php
<?php
use EasyWeChat\Message\News;

$news = new News([
        'title'       => $title,
        'description' => '...',
        'url'         => $url,
        'image'       => $image,
        // ...
    ]);

// or
$news = new News();
$news->title = 'EasyWeChat';
$news->description = '微信 SDK ...';
// ...

文章消息

属性列表：

- title 标题
- author 作者
- content 具体内容
- thumb_media_id 图文消息的封面图片素材id（必须是永久mediaID）
- digest 图文消息的摘要，仅有单图文消息才有摘要，多图文此处为空
- source_url 来源 URL
- show_cover 是否显示封面，0 为 false，即不显示，1 为 true，即显示
php
<?php
use EasyWeChat\Message\Article;

$article = new Article([
        'title'   => 'EasyWeChat',
        'author'  => 'overtrue',
        'content' => 'EasyWeChat 是一个开源的微信 SDK，它... ...',
        // ...
    ]);

// or
$article = new Article();
$article->title   = 'EasyWeChat';
$article->author  = 'overtrue';
$article->content = '微信 SDK ...';
// ...

素材消息

素材消息用于群发与客服消息时使用。

属性就一个：media_id。

在构造时有两个参数：

  • $type 素材类型，目前只支持：mpnews、 mpvideo、voice、image 等。
  • $mediaId 素材 ID，从接口查询或者上传后得到。
php
use EasyWeChat\Message\Material;

$material = new Material('mpnews', $mediaId);

以上呢，是所有微信支持的基本消息类型。

需要注意的是，你不需要关心微信的消息字段叫啥，因为这里我们使用了更标准的命名，然后最终在中间做了转换，所以你不需要关注。

原始消息

原始消息是一种特殊的消息，它的场景是：你不想使用其它消息类型，你想自己手动拼消息。比如，回复消息时，你想自己拼 XML，那么你就直接用它就可以了：

php
use EasyWeChat\Message\Raw;

$message = new Raw('<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>12345678</CreateTime>
<MsgType><![CDATA[image]]></MsgType>
<Image>
<MediaId><![CDATA[media_id]]></MediaId>
</Image>
</xml>');

比如，你要用于客服消息(客服消息是JSON结构)：

php
use EasyWeChat\Message\Raw;

$message = new Raw('{
    "touser":"OPENID",
    "msgtype":"text",
    "text":
    {
         "content":"Hello World"
    }
}');

总之，就是直接写微信接口要求的格式内容就好，此类型消息在 SDK 中不存在转换行为，所以请注意不要写错格式。

在 SDK 中使用消息

在服务端回复消息

在 服务端 一节中，我们讲了回复消息的写法：

php
// ... 前面部分省略
$app = new Application($options);
$server = $app->server;

$server->setMessageHandler(function ($message) {
    return "您好！欢迎关注我!";
});

$server->serve()->send();

上面 return 了一句普通的文本内容，这里只是为了方便大家，实际上最后会有一个隐式转换为 Text 类型的动作。

如果你要回复其它类型的消息，就需要返回一个具体的实例了，比如回复一个图片类型的消息：

php
use EasyWeChat\Message\Image;
// ...
$server->setMessageHandler(function ($message) {
    return new Image(['media_id' => '........']);
});
// ...

回复多图文消息

多图文消息其实就是单图文消息的一个数组而已了：

php
use EasyWeChat\Message\News;

// ...
$server->setMessageHandler(function ($message) {
    $news1 = new News(...);
    $news2 = new News(...);
    $news3 = new News(...);
    $news4 = new News(...);

    return [$news1, $news2, $news3, $news4];
});
// ...

作为客服消息发送

在客服消息里的使用也一样，都是直接传入消息实例即可：

php
use EasyWeChat\Message\Text;

$message = new Text(['content' => 'Hello world!']);

$result = $app->staff->message($message)->to($openId)->send();
//...

发送多图文消息

多图文消息其实就是单图文消息的一个数组而已了：

php
$news1 = new News(...);
$news2 = new News(...);
$news3 = new News(...);
$news4 = new News(...);

$app->staff->message([$news1, $news2, $news3, $news4])->to($openId)->send();

群发消息

请参考：群发消息

消息转发给客服系统

参见：多客服消息转发

Released under the MIT License.

Copyright © 2013-2023 微擎 皖ICP备19002904号-6