README

短信引擎是一个PHP库，它封装了短信网关（如Semaphore、MyBusyBee）的实现，这样您可以使用两行简单的代码发送短信

$engine = SmsEngine::init('semaphore', 'xxxxxxx');

$engine->send("09xxxxxxxxx", "Your message", "Sender Name");
// Your `Sender Name` must be purchased & approved, or it'll throw InvalidSenderNameException

<?php
require_once('vendor/autoload.php');

use Vluebridge\SmsEngine;

$engine = SmsEngine::init('semaphore', '{API KEY}');
$engine->send("09xxxxxxxxx", "Hello po :)", "{SENDER NAME}");
// You can send the same message in multiple numbers by adding a comma in mobile number string.
// For example:
// $engine->send("09xxxxxxxxx,09xxxxxxxxx,09xxxxxxxxx", "You all the best", "{SENDER NAME}");

适用于Laravel

在 config/sms-engine.php 中创建一个配置文件，并包含以下内容

<?php
return [
    'suppliers' => [
        'semaphore' => [
            'api_key' => env('SEMAPHORE_API_KEY')
        ],

        'mybusybee' => [
            'api_key' => env('MYBUSYBEE_API_KEY')
        ],
    ]
];

在您的 .env 文件中添加以下变量

MYBUSYBEE_API_KEY={YOUR API KEY}
SEMAPHORE_API_KEY={YOUR API KEY}

在您的Laravel应用程序中某个位置写入以下代码

$supplier = 'semaphore';
$engine = SmsEngine::init($supplier, config("sms-engine.suppliers.{$supplier}"));
$engine->send("09xxxxxxxxx", "Hello po :)", "{SENDER NAME}");

我创建了一个小的Laravel命令来使这个过程更加简单。只需下载这个 SendSmsCommand类并将其放入您的 app/Console/Commands 目录。

安装完成后，您可以通过此命令发送短信

php artisan sms:send semaphore 09xxxxxxxxx "Hello darkness my old friend" --sender="Sender Name"

异常处理

发送短信时可能会有很多潜在的问题。如果您不希望应用程序在遇到错误时崩溃，将代码包装在 try-catch 中并捕获以下异常是一个好主意

InsufficientCreditsException
InvalidApiKeyException
InvalidMessageException
InvalidMobileNumberException

如果使用批量手机号码，当任何手机号码无效时，将抛出此异常。
InvalidSenderNameException

当您使用一个不适合您账户的发送者名称时，将抛出此异常。通常，您需要从您的短信供应商那里购买它并等待其批准。
MaxSmsRecipientReachedException

每个API调用仅限1,000个收件人。出于性能考虑。
SmsSendingException

在发送短信时发生未知错误时发生。

所有这些异常在运行 $exception->getMessage() 时都返回短信供应商的API响应体。使用它来找出问题所在，特别是对于 SmsSendingException。

注册自己的短信网关

您可能希望在您的项目中支持自己的短信供应商（如Nexmo、Twilio等）。这是在不修改此包的代码库的情况下完成此操作的方法

创建一个适配器类并实现 SmsSupplierInterface 接口。示例

<?php

use Vluebridge\Contracts\SmsSupplierInterface;

class TwilioAdapter implements SmsSupplierInterface {
    protected $client;
    
    public function __construct($api_key) {
        // Support argument of single string of API Key
        // and an array of configuration in case you need more info like `api_secret`
        if(is_array($api_key)) {
            if(! isset($api_key['api_key'])) {
                throw new \InvalidArgumentException("Missing `api_key` value in array");
            }

            $api_key = $api_key['api_key'];
        }
        
        // Your SMS Supplier usually provides their own PHP package so you don't have to
        // make one from scratch. You can use that here and create the $client field
        // and get the API key from this $conf variable.
        $this->client = new WhateverApiPackage($api_key);
    }

    public function send($recipients, $message, $sender_name = null) {
        // Insert code here how they implement their own SMS sending feature.
        // Usually, it's something like this:
        $this->client->send($recipients, $message, $sender_name);
    }
 }

确保根据API服务器的响应实现异常处理。
通过执行SmsEngine::registerSupplier('twilio', TwilioAdapter::class)注册您的适配器类。
现在应该支持您的短信网关。
（可选）提交一个拉取请求并与我们分享您的实现！分享就是关爱 😊

vluebridge / sms-engine

维护者

详细信息

README

目录

支持的短信供应商

安装

如何使用

适用于任何PHP项目

适用于Laravel

异常处理

注册自己的短信网关