README.md

Easy SMS

📲 一款满足你的多种发送需求的短信发送组件

环境需求

• PHP >= 5.6

安装

$ composer require "overtrue/easy-sms"

使用

use Overtrue\EasySms\EasySms;

$config = [
    // HTTP 请求的超时时间（秒）
    'timeout' => 5.0,
    
    // 默认发送配置
    'default' => [
        // 网关调用策略，默认顺序调用
        'strategy' => \Overtrue\EasySms\Strategies\OrderStrategy::class
        
        // 默认可用的发送网关
        'gateways' => [
            'yunpian', 'alidayu',
        ],
    ],
    // 可用的网关配置
    'gateways' => [
        'errorlog' => [
            'file' => '/tmp/easy-sms.log',
        ],
        'yunpian' => [
            'api_key' => '824f0ff2f71cab52936axxxxxxxxxx',
        ],
        'alidayu' => [
            //...
        ],
    ],
];

$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' => [
        'status' => 'success',
        'result' => [...] // 平台返回值
    ],
    'juhe' => [
        'status' => 'erred',
        'exception' => \Overtrue\EasySms\Exceptions\GatewayErrorException 对象
    ],
    //...
]

定义短信

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

<?php

use Overtrue\EasySms\Message;

class OrderPaidMessage extends Messeage
{
    protected $order;
    protected $gateways = ['alidayu', 'yunpian']; // 定义本短信的适用平台，覆盖全局配置中的 `enabled_gateways`

    public function __construct($order)
    {
        $this->order = $order;
    }
        
    // 定义直接使用内容发送平台的内容
    public function getContent()
    {
        return sprintf('您的订单:%s, 已经完成付款', $this->order->no);    
    }
    
    // 定义使用模板发送方式平台所需要的模板 ID
    public function getTemplate()
    {
        return 'SMS_003'; 
    }
        
    // 模板参数
    public function getData()
    {
        return [
            'order_no' => $this->order->no    
        ];    
    }
}

更多自定义方式请参考：Overtrue\EasySms\Message

发送自定义短信：

$order = ...;
$message = new OrderPaidMessage($order);

$easySms->send(13188888888, $message);

平台支持

• 云片
• Submail
• 螺丝帽
• 阿里大鱼
• 容联云通讯
• 互亿无线
• 聚合数据
• SendCloud

License

MIT