PHPackages                             homelam/easy-sms - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. homelam/easy-sms

ActiveLibrary[Mail & Notifications](/categories/mail)

homelam/easy-sms
================

The easiest way to send short message.

v1.0.1(7y ago)115MITPHPPHP >=5.6

Since Aug 22Pushed 7y agoCompare

[ Source](https://github.com/homelam/easy-sms)[ Packagist](https://packagist.org/packages/homelam/easy-sms)[ RSS](/packages/homelam-easy-sms/feed)WikiDiscussions develop Synced yesterday

READMEChangelog (2)Dependencies (3)Versions (4)Used By (0)

Easy SMS
========

[](#easy-sms)

特点
--

[](#特点)

1. 一套写法兼容所有平台
2. 简单配置即可灵活增减服务商
3. 内置多种服务商轮询策略、支持自定义轮询策略
4. 统一的返回值格式，便于日志与监控
5. 自动轮询选择可用的服务商
6. 可以扩展自定义的短信服务

平台支持
----

[](#平台支持)

- [阿里云](https://www.aliyun.com/)
- [阿里大于](https://www.alidayu.com/)(不推荐使用，请使用阿里云)

环境需求
----

[](#环境需求)

- PHP >= 7.0

安装
--

[](#安装)

```
$ composer require "homelam/easy-sms"
```

使用
--

[](#使用)

```
use Wincy\EasySms\EasySms;

$config = [
    // HTTP 请求的超时时间（秒）
    'timeout' => 5.0,

    // 默认发送配置
    'default' => [
        // 网关调用策略，默认：顺序调用
        'strategy' => \Wincy\EasySms\Strategies\OrderStrategy::class,

        // 默认可用的发送网关
        'gateways' => [
            'aliyun'
        ],
    ],
    // 可用的网关配置
    'gateways' => [
        'errorlog' => [
            'file' => '/tmp/easy-sms.log',
        ],
        'aliyun' => [
            'access_key_id' => '',
            'access_key_secret' => '',
            'sign_name' => '',
        ]
    ],
];

$easySms = new EasySms($config);

$easySms->send(13188888888, [
    'content'  => '您的验证码为: 6379',
    'template' => 'SMS_001',
    'data' => [
        'code' => 6379
    ],
]);
```

短信内容
----

[](#短信内容)

由于使用多网关发送，所以一条短信要支持多平台发送，每家的发送方式不一样，但是我们抽象定义了以下公用属性：

- `content` 文字内容，使用在像云片类似的以文字内容发送的平台
- `template` 模板 ID，使用在以模板ID来发送短信的平台
- `data` 模板变量，使用在以模板ID来发送短信的平台

所以，在使用过程中你可以根据所要使用的平台定义发送的内容。

发送网关
----

[](#发送网关)

默认使用 `default` 中的设置来发送，如果某一条短信你想要覆盖默认的设置。在 `send` 方法中使用第三个参数即可：

```
$easySms->send(13188888888, [
    'content'  => '您的验证码为: 6379',
    'template' => 'SMS_001',
    'data' => [
        'code' => 6379
    ],
 ], ['yunpian', 'juhe']); // 这里的网关配置将会覆盖全局默认值
```

返回值
---

[](#返回值)

由于使用多网关发送，所以返回值为一个数组，结构如下：

```
[
    'yunpian' => [
        'gateway' => 'yunpian',
        'status' => 'success',
        'result' => [...] // 平台返回值
    ],
    'juhe' => [
        'gateway' => 'juhe',
        'status' => 'failure',
        'exception' => \Wincy\EasySms\Exceptions\GatewayErrorException 对象
    ],
    //...
]
```

如果所选网关列表均发送失败时，将会抛出 `Wincy\EasySms\Exceptions\NoGatewayAvailableException` 异常，你可以使用 `$e->results` 获取发送结果。

你也可以使用 `$e` 提供的更多便捷方法：

```
$e->getResults();               // 返回所有 API 的结果，结构同上
$e->getExceptions();            // 返回所有调用异常列表
$e->getException($gateway);     // 返回指定网关名称的异常对象
$e->getLastException();         // 获取最后一个失败的异常对象
```

自定义网关
-----

[](#自定义网关)

本拓展已经支持用户自定义网关，你可以很方便的配置即可当成与其它拓展一样的使用：

```
$config = [
    ...
    'default' => [
        'gateways' => [
            'mygateway', // 配置你的网站到可用的网关列表
        ],
    ],
    'gateways' => [
        'mygateway' => [...], // 你网关所需要的参数，如果没有可以不配置
    ],
];

$easySms = new EasySms($config);

// 注册
$easySms->extend('mygateway', function($gatewayConfig){
    // $gatewayConfig 来自配置文件里的 `gateways.mygateway`
    return new MyGateway($gatewayConfig);
});

$easySms->send(13188888888, [
    'content'  => '您的验证码为: 6379',
    'template' => 'SMS_001',
    'data' => [
        'code' => 6379
    ],
]);
```

国际短信
----

[](#国际短信)

国际短信与国内短信的区别是号码前面需要加国际码，但是由于各平台对国际号码的写法不一致，所以在发送国际短信的时候有一点区别：

```
use Wincy\EasySms\PhoneNumber;

// 发送到国际码为 31 的国际号码
$number = new PhoneNumber(13188888888, 31);

$easySms->send($number, [
    'content'  => '您的验证码为: 6379',
    'template' => 'SMS_001',
    'data' => [
        'code' => 6379
    ],
]);
```

定义短信
----

[](#定义短信)

你可以根据发送场景的不同，定义不同的短信类，从而实现一处定义多处调用，你可以继承 `Wincy\EasySms\Message` 来定义短信模型：

```