Redirected from /overtrue/wechat
EasyWeChat

https://github.com/w7corp/easywechat
Admin
EasyWeChat is a PHP SDK for WeChat development, an open-source product from W7, an open-source SaaS...
Tokens:98,574
Snippets:627
Trust Score:6.5
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install dependencies and run dev server with pnpm

Source: https://github.com/w7corp/easywechat/blob/6.x/docs/README.md

Use pnpm to install dependencies and start the local development server. Run these commands in the project root.

```bash
pnpm i
pnpm run dev
```

--------------------------------

### Manual Installation Autoload

Source: https://github.com/w7corp/easywechat/wiki/installation

After downloading the package, include the autoload.php file to load the SDK. This example shows the required PHP code.

```php
<?php

require __DIR__ . "/wechat/autoload.php";
...
```

--------------------------------

### Install via Composer

Source: https://github.com/w7corp/easywechat/wiki/installation

Use Composer to install the EasyWeChat package. Requires PHP >= 5.3.0 and the cURL extension.

```shell
composer require overtrue/wechat
```

--------------------------------

### Template message example

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Complete example of sending a template message with chained methods, including data array and receiver.

```php
$userId     = 'OPENID';
$templateId = 'ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY';
$url        = 'http://overtrue.me';
$color      = '#FF0000';
$data = array(
        "first"    => "CHECKOUTED",
        "keynote1" => "Chocolates",
        "keynote2" => "39.8 RMB",
        "keynote3" => "2014/9/16",
        "remark"   => "Have a nice day!",
        );

$messageId = $notice->uses($templateId)->withUrl($url)->andData($data)->andReceiver($userId)->send();
```

--------------------------------

### Store

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Store class for store management.

```APIDOC
## Store

### Description
Initializes the Store class for store management.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$store = new Overtrue\Wechat\Store($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Server

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Server class for handling WeChat server requests.

```APIDOC
## Server

### Description
Initializes the Server class for handling WeChat server requests.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$token** (string) - Required - The WeChat token.
- **$encodingAESKey** (string|null) - Optional - The encoding AES key for message encryption.

### Request Example
```php
$server = new Overtrue\Wechat\Server($appId, $token, $encodingAESKey);
```

### Response
No response.
```

--------------------------------

### Instantiate Notice class

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Creates a new Notice instance with the app ID and secret. Required before sending template messages.

```php
<?php

use Overtrue\Wechat\Notice;

$appId  = 'wx3cf0f39249eb0e60';
$secret = 'f1c242f4f28f735d4687abb469072a29';

$notice = new Notice($appId, $secret);
```

--------------------------------

### Menu

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Menu class for managing custom menus.

```APIDOC
## Menu

### Description
Initializes the Menu class for managing custom menus.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$menu = new Overtrue\Wechat\Menu($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### QR Code

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the QRCode class for QR code generation.

```APIDOC
## QR Code

### Description
Initializes the QRCode class for QR code generation.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$qrcode = new Overtrue\Wechat\QRCode($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Message:Video

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Video message class.

```APIDOC
## Message:Video

### Description
Initializes the Video message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$videoMessage = new Overtrue\Wechat\Messages\Video();
```

### Response
No response.
```

--------------------------------

### Multimedia resources Management

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Media class for multimedia resource management.

```APIDOC
## Multimedia resources Management

### Description
Initializes the Media class for multimedia resource management.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$media = new Overtrue\Wechat\Media($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Register Class Aliases

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Enable the use of alias classes by registering them in your project's boot script.

```APIDOC
## Register Class Aliases

### Description
Registers all EasyWeChat class aliases so you can use shorter class names without importing namespaces.

### Method
N/A (PHP code snippet)

### Endpoint
N/A

### Parameters
None

### Request Example
```php
Overtrue\Wechat\Alias::register();
```

### Response
No response.
```

--------------------------------

### Image

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Image class for image handling.

```APIDOC
## Image

### Description
Initializes the Image class for image handling.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$image = new Overtrue\Wechat\Image($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Web Auth

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Auth class for web authentication.

```APIDOC
## Web Auth

### Description
Initializes the Auth class for web authentication.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$auth = new Overtrue\Wechat\Auth($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Menu Items

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the MenuItem class for creating menu items.

```APIDOC
## Menu Items

### Description
Initializes the MenuItem class for creating menu items.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$menuItem = new Overtrue\Wechat\MenuItem($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Message:Audio

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Voice message class.

```APIDOC
## Message:Audio

### Description
Initializes the Voice message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$voiceMessage = new Overtrue\Wechat\Messages\Voice();
```

### Response
No response.
```

--------------------------------

### Template data with per-column colors (fast way)

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Data array where each value is an array with the text and color. This is a fast way to set individual colors.

```php
$data = array(
    "first"    => array("CHECKOUTED", '#555555'),
    "keynote1" => array("Chocolates", "#336699"),
    "keynote2" => array("39.8 RMB", "#FF0000"),
    "keynote3" => array("2014/9/16", "#888888"),
    "remark"   => array("Have a nice day!", "#5599FF"),
);
```

--------------------------------

### Message:Music

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Music message class.

```APIDOC
## Message:Music

### Description
Initializes the Music message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$musicMessage = new Overtrue\Wechat\Messages\Music();
```

### Response
No response.
```

--------------------------------

### Message:Text

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Text message class.

```APIDOC
## Message:Text

### Description
Initializes the Text message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$textMessage = new Overtrue\Wechat\Messages\Text();
```

### Response
No response.
```

--------------------------------

### User

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the User class for managing WeChat users.

```APIDOC
## User

### Description
Initializes the User class for managing WeChat users.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$user = new Overtrue\Wechat\User($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Group

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Group class for managing user groups.

```APIDOC
## Group

### Description
Initializes the Group class for managing user groups.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$group = new Overtrue\Wechat\Group($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Message:NewsItem

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the NewsItem message class.

```APIDOC
## Message:NewsItem

### Description
Initializes the NewsItem message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$newsItemMessage = new Overtrue\Wechat\Messages\NewsItem();
```

### Response
No response.
```

--------------------------------

### Register EasyWeChat class aliases

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Call Overtrue\Wechat\Alias::register() in your project's boot script to enable the alias classes (e.g., WechatServer, WechatUser). This avoids needing to import the full namespace for each class.

```php
Overtrue\Wechat\Alias::register();
```

--------------------------------

### Exception

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Exception class for exception handling.

```APIDOC
## Exception

### Description
Initializes the Exception class for exception handling.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$exception = new Overtrue\Wechat\Exception($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Message:Image

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Image message class.

```APIDOC
## Message:Image

### Description
Initializes the Image message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$imageMessage = new Overtrue\Wechat\Messages\Image();
```

### Response
No response.
```

--------------------------------

### industries()

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Fetches the list of all supported industries.

```APIDOC
## industries()

### Description
Fetches the list of all supported industries.

### Method
industries

### Parameters
None

### Return
- **array** - List of supported industries.
```

--------------------------------

### Message

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Message class for creating messages.

```APIDOC
## Message

### Description
Initializes the Message class for creating messages.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$message = new Overtrue\Wechat\Message();
```

### Response
No response.
```

--------------------------------

### JSSDK

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Js class for JSSDK functionality.

```APIDOC
## JSSDK

### Description
Initializes the Js class for JSSDK functionality.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$js = new Overtrue\Wechat\Js($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Short URL Service

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Url class for short URL service.

```APIDOC
## Short URL Service

### Description
Initializes the Url class for short URL service.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$url = new Overtrue\Wechat\Url($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Chained Methods

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Provides a fluent interface for setting template ID, receiver, color, URL, and data before sending.

```APIDOC
## Chained Methods

### Description
Provides a fluent interface for setting template ID, receiver, color, URL, and data before sending.

### Methods
- **template / templateId / uses** - Sets the template ID.
- **to / receiver** - Sets the receiver open ID.
- **color / topColor** - Sets the template header color.
- **url / link / linkTo** - Sets the detail page URL.
- **data / with** - Sets the template data.
- **send** - Sends the message.

All methods support `withXXX` and `andXXX` variants.

### Example
```php
$messageId = $notice->uses($templateId)->andUrl($url)->withColor($color)->data($data)->send();
// or
$messageId = $notice->to($userOpenId)->url($url)->template($templateId)->andData($data)->send();
// or
$messageId = $notice->withTo($userOpenId)->withUrl($url)->withTemplate($templateId)->withData($data)->send();
// or
$messageId = $notice->to($userOpenId)->color('#ff0000')->url($url)->withTemplateId($templateId)->send();
```
```

--------------------------------

### Message:Link

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Link message class.

```APIDOC
## Message:Link

### Description
Initializes the Link message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$linkMessage = new Overtrue\Wechat\Messages\Link();
```

### Response
No response.
```

--------------------------------

### Message:Location

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Location message class.

```APIDOC
## Message:Location

### Description
Initializes the Location message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$locationMessage = new Overtrue\Wechat\Messages\Location();
```

### Response
No response.
```

--------------------------------

### Message:News

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the News message class.

```APIDOC
## Message:News

### Description
Initializes the News message class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$newsMessage = new Overtrue\Wechat\Messages\News();
```

### Response
No response.
```

--------------------------------

### Customer Service

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Staff class for customer service (hotline) functionality.

```APIDOC
## Customer Service

### Description
Initializes the Staff class for customer service (hotline) functionality.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$staff = new Overtrue\Wechat\Staff($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Template data with per-column colors (official way)

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Data array using associative arrays with 'value' and 'color' keys, matching the official WeChat format.

```php
$data = array(
    "first"    => array("value" => "CHECKOUTED", "color" => '#555555'),
    "keynote1" => array("value" => "Chocolates", "color" => "#336699"),
    "keynote2" => array("value" => "39.8 RMB","color" => "#FF0000"),
    "keynote3" => array("value" => "2014/9/16", "color" => "#888888"),
    "remark"   => array("value" => "Have a nice day!", "color" => "#5599FF"),
);
```

--------------------------------

### Send template message (chained methods)

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Shows multiple chained method styles to send a template message. All support withXXX and andXXX variants.

```php
$messageId = $notice->uses($templateId)->andUrl($url)->withColor($color)->data($data)->send();
// or
$messageId = $notice->to($userOpenId)->url($url)->template($templateId)->andData($data)->send();
// or
$messageId = $notice->withTo($userOpenId)->withUrl($url)->withTemplate($templateId)->withData($data)->send();
// or
$messageId = $notice->to($userOpenId)->color('#ff0000')->url($url)->withTemplateId($templateId)->send();
// ... ...
```

--------------------------------

### BaseMessage

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the BaseMessage class for base message handling.

```APIDOC
## BaseMessage

### Description
Initializes the BaseMessage class for base message handling.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$baseMessage = new Overtrue\Wechat\BaseMessage($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### addTemplate($shortId)

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Adds a message template and returns the template ID.

```APIDOC
## addTemplate($shortId)

### Description
Adds a message template and returns the template ID.

### Method
addTemplate

### Parameters
- **$shortId** (string) - Required - The short ID of the template.

### Return
- **string** - The template ID.
```

--------------------------------

### send($to, $templateId, $data, $url, $color)

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Sends a template message and returns the message ID. Supports both chained and non-chained usage.

```APIDOC
## send($to, $templateId, $data, $url, $color)

### Description
Sends a template message and returns the message ID. Supports both chained and non-chained usage.

### Method
send

### Parameters
- **$to** (string) - Required - The receiver's open ID.
- **$templateId** (string) - Required - The template ID.
- **$data** (array) - Required - The template data.
- **$url** (string) - Optional - The detail page URL.
- **$color** (string) - Optional - The template header color, default '#FF0000'.

### Return
- **int** - The message ID.
```

--------------------------------

### setIndustry($industryId1, $industryId2)

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Toggles the industry from the first ID to the second ID. This operation is limited to once per month.

```APIDOC
## setIndustry($industryId1, $industryId2)

### Description
Toggles the industry from `$industryId1` to `$industryId2`. This operation is limited to once per month.

### Method
setIndustry

### Parameters
- **$industryId1** (mixed) - Required - The first industry ID.
- **$industryId2** (mixed) - Required - The second industry ID.

### Return
- **boolean** - True on success, false on failure.
```

--------------------------------

### WeChat Card

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Card class for WeChat card functionality.

```APIDOC
## WeChat Card

### Description
Initializes the Card class for WeChat card functionality.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Constructor Parameters
- **$appId** (string) - Required - The WeChat application ID.
- **$appSecret** (string) - Required - The WeChat application secret.

### Request Example
```php
$card = new Overtrue\Wechat\Card($appId, $appSecret);
```

### Response
No response.
```

--------------------------------

### Message:Transfer

Source: https://github.com/w7corp/easywechat/wiki/configuration_initiation

Initializes the Transfer message class for hotline service.

```APIDOC
## Message:Transfer

### Description
Initializes the Transfer message class for hotline service.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```php
$transferMessage = new Overtrue\Wechat\Messages\Transfer();
```

### Response
No response.
```

--------------------------------

### defaultColor($color)

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Sets the default color for template data columns when using the simple data format.

```APIDOC
## defaultColor($color)

### Description
Sets the default color for template data columns when using the simple data format.

### Method
defaultColor

### Parameters
- **$color** (string) - Required - The default color, e.g., '#173177'.

### Return
- **void** - No return value.
```

--------------------------------

### Send template message (non-chained)

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Sends a template message using the send method with all parameters passed directly. Returns the message ID.

```php
$messageId = $notice->send($to, $templateId, array $data, $url, $color);
```

--------------------------------

### Template data with default color

Source: https://github.com/w7corp/easywechat/wiki/template_message_service

Data array with simple string values. The default color is '#173177' and can be changed with defaultColor().

```php
$data = array(
    "first"    => "CHECKOUTED",
    "keynote1" => "Chocolates",
    "keynote2" => "39.8 RMB",
    "keynote3" => "2014/9/16",
    "remark"   => "Have a nice day!",
);
```
Tokens:
Raw