PHP组件源码-短信发送
#源码介绍
此源码是PHP短信发送组件源码,几乎涵盖了小伙伴们的所有需求,下面详细介绍,内容有点多,小伙伴们可拿着源码边看边研究,适合自己二开,源码已上传阿里云OSS,需要的小伙伴自行下载哦。
环境需求:
PHP>=5.6
特点:
- 支持目前市面多家服务商
- 一套写法兼容所有平台
- 简单配置即可灵活增减服务商
- 内置多种服务商轮询策略、支持自定义轮询策略
- 统一的返回值格式,便于日志与监控
- 自动轮询选择可用的服务商
- 更多等你去发现与改进…
支持的平台:
- 阿里云
- 云片
- Submail
- 螺丝帽
- 容联云通讯
- 互亿无线
- 聚合数据
- SendCloud
- 百度云
- 华信短信平台
- 253云通讯(创蓝)
- 融云
- 天毅无线
- 腾讯云 SMS
- 阿凡达数据
- 华为云
- 网易云信
- 云之讯
- 凯信通
- 七牛云
- UE35.net
- Ucloud
- 短信宝
- Tiniyo
- 摩杜云
使用
use Overtrue\EasySms\EasySms; $config = [ // HTTP 请求的超时时间(秒) 'timeout' => 5.0, // 默认发送配置 'default' => [ // 网关调用策略,默认:顺序调用 'strategy' => \Overtrue\EasySms\Strategies\OrderStrategy::class, // 默认可用的发送网关 'gateways' => [ 'yunpian', 'aliyun', ], ], // 可用的网关配置 'gateways' => [ 'errorlog' => [ 'file' => '/tmp/easy-sms.log', ], 'yunpian' => [ 'api_key' => '824f0ff2f71cab52936axxxxxxxxxx', ], '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来发送短信的平台所以,在使用过程中你可以根据所要使用的平台定义发送的内容。
$easySms->send(13188888888, [ 'content' => '您的验证码为: 6379', 'template' => 'SMS_001', 'data' => [ 'code' => 6379 ], ]);你也可以使用闭包来返回对应的值:
$easySms->send(13188888888, [ 'content' => function($gateway){ return '您的验证码为: 6379'; }, 'template' => function($gateway){ return 'SMS_001'; }, 'data' => function($gateway){ return [ 'code' => 6379 ]; }, ]);你可以根据
$gateway
参数类型来判断返回值,例如:$easySms->send(13188888888, [ 'content' => function($gateway){ if ($gateway->getName() == 'yunpian') { return '云片专用验证码:1235'; } return '您的验证码为: 6379'; }, 'template' => function($gateway){ if ($gateway->getName() == 'aliyun') { return 'TP2818'; } return 'SMS_001'; }, 'data' => function($gateway){ return [ 'code' => 6379 ]; }, ]);发送网关
默认使用
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' => \Overtrue\EasySms\Exceptions\GatewayErrorException 对象 ], //... ]如果所选网关列表均发送失败时,将会抛出
Overtrue\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 Overtrue\EasySms\PhoneNumber; // 发送到国际码为 31 的国际号码 $number = new PhoneNumber(13188888888, 31); $easySms->send($number, [ 'content' => '您的验证码为: 6379', 'template' => 'SMS_001', 'data' => [ 'code' => 6379 ], ]);定义短信
你可以根据发送场景的不同,定义不同的短信类,从而实现一处定义多处调用,你可以继承
Overtrue\EasySms\Message
来定义短信模型:<?php use Overtrue\EasySms\Message; use Overtrue\EasySms\Contracts\GatewayInterface; use Overtrue\EasySms\Strategies\OrderStrategy; class OrderPaidMessage extends Message { protected $order; protected $strategy = OrderStrategy::class; // 定义本短信的网关使用策略,覆盖全局配置中的 `default.strategy` protected $gateways = ['alidayu', 'yunpian', 'juhe']; // 定义本短信的适用平台,覆盖全局配置中的 `default.gateways` public function __construct($order) { $this->order = $order; } // 定义直接使用内容发送平台的内容 public function getContent(GatewayInterface $gateway = null) { return sprintf('您的订单:%s, 已经完成付款', $this->order->no); } // 定义使用模板发送方式平台所需要的模板 ID public function getTemplate(GatewayInterface $gateway = null) { return 'SMS_003'; } // 模板参数 public function getData(GatewayInterface $gateway = null) { return [ 'order_no' => $this->order->no ]; } }
发送自定义短信:
$order = ...; $message = new OrderPaidMessage($order); $easySms->send(13188888888, $message);各平台配置说明
阿里云
短信内容使用
template
+data
'aliyun' => [ 'access_key_id' => '', 'access_key_secret' => '', 'sign_name' => '', ],阿里云Rest
短信内容使用
template
+data
'aliyunrest' => [ 'app_key' => '', 'app_secret_key' => '', 'sign_name' => '', ],云片
短信内容使用
content
'yunpian' => [ 'api_key' => '', 'signature' => '【默认签名】', // 内容中无签名时使用 ],Submail
短信内容使用
data
'submail' => [ 'app_id' => '', 'app_key' => '', 'project' => '', // 默认 project,可在发送时 data 中指定 ],螺丝帽
短信内容使用
content
'luosimao' => [ 'api_key' => '', ],容联云通讯
短信内容使用
template
+data
'yuntongxun' => [ 'app_id' => '', 'account_sid' => '', 'account_token' => '', 'is_sub_account' => false, ],互亿无线
短信内容使用
content
'huyi' => [ 'api_id' => '', 'api_key' => '', 'signature' => '', ],聚合数据
短信内容使用
template
+data
'juhe' => [ 'app_key' => '', ],SendCloud
短信内容使用
template
+data
'sendcloud' => [ 'sms_user' => '', 'sms_key' => '', 'timestamp' => false, // 是否启用时间戳 ],百度云
短信内容使用
template
+data
'baidu' => [ 'ak' => '', 'sk' => '', 'invoke_id' => '', 'domain' => '', ],华信短信平台
短信内容使用
content
'huaxin' => [ 'user_id' => '', 'password' => '', 'account' => '', 'ip' => '', 'ext_no' => '', ],253云通讯(创蓝)
短信内容使用
content
'chuanglan' => [ 'account' => '', 'password' => '', // 国际短信时必填 'intel_account' => '', 'intel_password' => '', // \Overtrue\EasySms\Gateways\ChuanglanGateway::CHANNEL_VALIDATE_CODE => 验证码通道(默认) // \Overtrue\EasySms\Gateways\ChuanglanGateway::CHANNEL_PROMOTION_CODE => 会员营销通道 'channel' => \Overtrue\EasySms\Gateways\ChuanglanGateway::CHANNEL_VALIDATE_CODE, // 会员营销通道 特定参数。创蓝规定:api提交营销短信的时候,需要自己加短信的签名及退订信息 'sign' => '【通讯云】', 'unsubscribe' => '回TD退订', ],融云
短信分为两大类,验证类和通知类短信。 发送验证类短信使用
template
+data
'rongcloud' => [ 'app_key' => '', 'app_secret' => '', ]天毅无线
短信内容使用
content
'tianyiwuxian' => [ 'username' => '', //用户名 'password' => '', //密码 'gwid' => '', //网关ID ]twilio
短信使用
content
发送对象需要 使用+
添加区号'twilio' => [ 'account_sid' => '', // sid 'from' => '', // 发送的号码 可以在控制台购买 'token' => '', // apitoken ],tiniyo
短信使用
content
发送对象需要 使用+
添加区号'tiniyo' => [ 'account_sid' => '', // auth_id from https://tiniyo.com 'from' => '', // 发送的号码 可以在控制台购买 'token' => '', // auth_secret from https://tiniyo.com ],腾讯云 SMS
短信内容使用
content
'qcloud' => [ 'sdk_app_id' => '', // SDK APP ID 'app_key' => '', // APP KEY 'sign_name' => '', // 短信签名,如果使用默认签名,该字段可缺省(对应官方文档中的sign) ],发送示例:
$easySms->send(18888888888, [ 'template' => 101234, // 模板ID 'content' => "您的动态验证码为:{1},请于5分钟内完成验证,如非本人操作,请忽略本短信!", // 模板内容 'data' => [ $code, // 模板变量 ], ]);阿凡达数据
短信内容使用
template
+data
'avatardata' => [ 'app_key' => '', // APP KEY ],华为云 SMS
短信内容使用
template
+data
'huawei' => [ 'endpoint' => '', // APP接入地址 'app_key' => '', // APP KEY 'app_secret' => '', // APP SECRET 'from' => [ 'default' => '1069012345', // 默认使用签名通道号 'custom' => 'csms12345', // 其他签名通道号 可以在 data 中定义 from 来指定 'abc' => 'csms67890', // 其他签名通道号 ... ], 'callback' => '' // 短信状态回调地址 ],使用默认签名通道
default
$easySms->send(13188888888, [ 'template' => 'SMS_001', 'data' => [ 6379 ], ]);使用指定签名通道
$easySms->send(13188888888, [ 'template' => 'SMS_001', 'data' => [ 6379, 'from' => 'custom' // 对应 config 中的 from 数组中 custom ], ]);网易云信
短信内容使用
template
+data
'yunxin' => [ 'app_key' => '', 'app_secret' => '', 'code_length' => 4, // 随机验证码长度,范围 4~10,默认为 4 'need_up' => false, // 是否需要支持短信上行 ],$easySms->send(18888888888, [ 'template' => 'SMS_001', // 不填则使用默认模板 'data' => [ 'code' => 8946, // 如果设置了该参数,则 code_length 参数无效 'action' => 'sendCode', // 默认为 `sendCode`,校验短信验证码使用 `verifyCode` ], ]);云之讯
短信内容使用
template
+data
'yunzhixun' => [ 'sid' => '', 'token' => '', 'app_id' => '', ],$easySms->send(18888888888, [ 'template' => 'SMS_001', 'data' => [ 'params' => '8946,3', // 模板参数,多个参数使用 `,` 分割,模板无参数时可为空 'uid' => 'hexianghui', // 用户 ID,随状态报告返回,可为空 'mobiles' => '18888888888,188888888889', // 批量发送短信,手机号使用 `,` 分割,不使用批量发送请不要设置该参数 ], ]);凯信通
短信内容使用
content
'kingtto' => [ 'userid' => '', 'account' => '', 'password' => '', ],$easySms->send(18888888888, [ 'content' => '您的验证码为: 6379', ]);七牛云
短信内容使用
template
+data
'qiniu' => [ 'secret_key' => '', 'access_key' => '', ],$easySms->send(18888888888, [ 'template' => '1231234123412341234', 'data' => [ 'code' => 1234, ], ]);Ucloud
短信使用
template
+data
'ucloud' => [ 'private_key' => '', //私钥 'public_key' => '', //公钥 ’sig_content‘ => '', // 短信签名, 'project_id' => '', //项目ID,子账号才需要该参数 ],$easySms->send(18888888888, [ 'template' => 'UTAXXXXX', //短信模板 'data' => [ 'code' => 1234, //模板参数,模板没有参数不用则填写,有多个参数请用数组,[1111,1111] 'mobiles' =>'', //同时发送多个手机短信,请用数组[xxx,xxx] ], ]);短信宝
短信使用
template
'smsbao' => [ 'user' => '', //账号 'password' => '' //密码 ],$easySms->send(18888888888, [ 'template' => '您的验证码为: 6379', //短信模板 ]);摩杜云
短信使用
template
+data
'moduyun' => [ 'accesskey' => '', //必填 ACCESS KEY 'secretkey' => '', //必填 SECRET KEY 'signId' => '', //选填 短信签名,如果使用默认签名,该字段可缺省 'type' => 0, //选填 0:普通短信;1:营销短信 ],
$easySms->send(18888888888, [
'template' => '5a95****b953', //短信模板
'data' => [
1234, //模板参数,对应模板的{1}
30 //模板参数,对应模板的{2}
//...
],
]);
#源码已上传oss,请看右侧下载
源码已上传阿里云OSS不限速下载
会员用户请登录后使用右侧高速下载通道
普通用户请支付两元使用高速下载通道
提示:未登录用户为游客购买,购买记录缓存在浏览器内七天,建议注册后再操作可享受永久下载权限
#小二有话说
为了提升小伙伴们的体验感,小二开通了阿里云oss下载,超过100mb的文件小二会放到阿里云oss里,小于100mb的小二会放到高速网盘下,小伙伴们可以开通会员后免费不限速下载哦,或者花两元购买资源[会员专享资源5元],网站的盈利都会用来给大家提升体验感,5元/10元就可开通一月/永久超级会员了,望大家理解小二。