README

使用Tooma网络服务在全球任何地方发送和接收短信

将TOOMA SMS API集成到Laravel中

Laravel包，用于提供TOOMA SMS服务的集成

安装

使用Composer安装此包

composer require tooma/laravel-sms-api

将包添加后，将ServiceProvider添加到config/app.php配置文件中的providers数组中

Tooma\Laravel\Api\Providers\ToomaServiceProvider::class

完成后，使用以下命令将配置发布到您的配置文件夹

php artisan vendor:publish --provider="Tooma\Laravel\Api\Providers\ToomaServiceProvider"

配置

配置文件发布后，打开config/tooma-api.php

编辑配置

编辑默认配置，例如

apiKey：Tooma提供的API密钥

defaultSSLPath：如果使用默认证书之外的证书，则默认SSL证书路径

defaultSenderName：默认发送者名称默认为TOOMA_SMS（在肯尼亚）

使用方法

检索ApiKey

获取API密钥后，将其添加到config/tooma-api.php配置文件中，请注意您只需运行此函数一次，您也可以通过访问tooma.co.ke > 设置 > API获取您的API密钥

app()->tooma->onSuccess(function($response,$pagination){
         // Logic when Login is successfull
         $apiKey = $response->data->token;

      })->onError(function($response)
      {
          // Logic on Error 
      })->login(['username'=>'YOUR_USERNAME_OR_EMAIL','password'=>'YOUR_PASSWORD']);

发送短信

发送短信就像这样做一样简单

$parcel=[
      ['to'=>'+254XXXXXXXXX','message'=>'Greetings from Tooma'],
      ......
   ];
app()->tooma->onSuccess(function($response,$pagination){
         // Logic sending is successfull

      })->onError(function($response)
      {
          // Logic on Error 
      })->sendSms($parcel);

发送批量短信

发送多条消息

$parcel=[
     ['to'=>'+254XXXXXXXXX','message'=>'Dear XXX Greetings from Tooma'],
     ['to'=>'+254YYYYYYYYY','message'=>'Dear YYY Greetings from Tooma'],
     ......
  ];
app()->tooma->onSuccess(function($response,$pagination){
        // Logic sending is successfull
      

     })->onError(function($response)
     {
         // Logic on Error 
     })->sendSms($parcel);

检索所有消息

检索消息状态

获取账户余额

获取余额，只需调用balance，如下所示

app()->tooma->onSuccess(function($response,$pagination){
         // Logic sending is successfull
          echo "Your balance is $response->data->balance";

      })->onError(function($response)
      {
          // Logic on Error 
      })->balance();

从CSV文件发送消息

您还可以如下从CSV文件发送消息

 $csvPath = "path/to/your/csv.csv";

 app()->tooma->onSuccess(function($response,$pagination){
         // Logic sending is successfull
          echo "Your balance is $response->data->balance";

      })->onError(function($response)
      {
          // Logic on Error 
      })->withCsv($csvPath)
        ->withPhoneColumn('phone') //name of column with phone
        ->withTemplate('Dear :username_column_name your account balance is :balance_column_name')
        ->sendCsv();

与消息模板一起工作

您还可以如下从保存的或新的模板发送消息

$data = [
  ['phone'=>'+254WWWWW','name'=>'','other_args'=>'args_val'];

];
app()->tooma->onSuccess(function($response,$pagination){
         // Logic sending is successfull
          echo "Your balance is $response->data->balance";

      })->onError(function($response)
      {
          // Logic on Error 
      })->withParams(['args1'=>'val']) //extra parametaer
        ->withTemplate('Dear :name your account balance is :balance_column_name') //or you can pass a template id
        ->sendFromTemplate($data);

计划消息

您可以通过启用计划来在稍后发送短信，计划格式遵循cron格式

$parcel=[
     ['to'=>'+254XXXXXXXXX','message'=>'Greetings from Tooma'],
     ......
  ];
app()->tooma->onSuccess(function($response,$pagination){
        // Logic sending is successfull
         echo "Your balance is $response->data->balance";

     })->onError(function($response)
     {
         // Logic on Error 
     })->schedule("FORMART")
       ->sendSms($parcel);

支持

请随意在问题部分发布您的问题。

tooma / laravel-sms-api

维护者

详细信息