README

此库需要PHP版本至少为5.6

这是用于使用VumaSMS API的PHP客户端库。要使用此库，您需要一个vumasms账户。在vumasms.com免费注册（免费注册）。这是一个测试版本，有关更多信息，请参阅贡献。

安装
获取API密钥
用法
示例
VumaSMS Laravel
贡献

安装

要使用客户端库，您需要先创建VUMASMS账户。

使用Composer安装PHP客户端库

composer require kreateyou/vumasms

获取API密钥

登录您的VumaSMS账户。
点击左侧菜单中的设置
点击生成API凭据按钮
将密钥和秘密保存在您的应用中注意：vumaSMS不会存储生成的API密钥或凭据，每次都会生成新的密钥，请保存密钥以供以后使用

用法

如果您使用Composer，请确保将自动加载器包含在项目的引导文件中

require_once "vendor/autoload.php";

使用API密钥和秘密创建客户端

$client = new  \Vumasms\VumaSMS(API_KEY, API_SECRET);

示例

发送短信

要使用VumaSMS的短信API发送短信，请调用$client->send()方法。

API可以直接调用，使用简单的参数数组，键如下。

    to                // array of receipients
    sender            // registered sender ID, default VUMA
    message           // message
    scheduled_date    // date to be sent can be Datetime or Cron Expression
    scheduled_type    // date or cron

$messageBag = [
    'to' => [2547XXXXXX],
    'sender' => VUMA,
    'message' => 'Test message from the vumaSMS PHP Client'
];
$message = $client->send($messageBag);

API响应的JSON数据如下。

{"success":true,"details":{"type":"outbox","status":"queued","payload":{"to":["2547XXXXXX"],"message":"Your verification code for PROJECT is 3434  \n","sender":"VUMA","scheduled_date":null,"scheduled_type":null},"created_by":"17","scheduled_at":null,"updated_at":"2018-04-18 10:14:22","created_at":"2018-04-18 10:14:22","sid":"36"}};

Laravel

要在laravel 5.x中使用组件，请在Provider中添加VumaSMS提供者

    Vumasms\Laravel\Providers\ServiceProvider::class,

按照以下方式发布服务提供者

  php artisan vendor:publish --provider "Vumasms\Laravel\Providers\ServiceProvider"

在您的配置文件夹中找到vumasms.php配置，更改密钥和秘密配置。如果您使用.env配置文件，请按照以下方式在.env文件中添加您的密钥和秘密

       # VUMA SETTINGS
        VUMA_API_KEY=<KEY>
        VUMA_API_SECRET=<SECRET>

在laravel中发送短信如下

    app("vumasms")->send($messageBag),

贡献

要为此库、文档或示例做出贡献，请[创建问题][issues]或发起拉取请求。请只提出关于已标记为在API覆盖率中正在工作功能的问题，因为其余代码正在更新。

许可证

此库根据MIT许可证发布

kreateyou / vumasms

维护者

详细信息

README

安装

获取API密钥

用法

示例

发送短信

Laravel

贡献

许可证