README

使用我们的网络服务在世界任何地方发送和接收短信

创建账户

访问http://tooma.co.ke/user/auth/signup创建您的账户

一旦您拥有账户

安装

运行composer require tooma/sms-api

使用方法

获取ApiKey

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

$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']);

实例化

$tooma = new Tooma("API_KEY");

发送短信

发送短信就像这样简单

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

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

检索所有短信

要获取所有短信记录

 $tooma->onSuccess(function($response,$pagination){
         $rows = $response->data;
         // save to db
         $pagination->getNext(); // call this to fetch the next page

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

检索短信状态

要获取短信状态

 $tooma->onSuccess(function($response,$pagination){
         

      })->onError(function($response)
      {
          // Logic on Error 
      })->messageStatus(['message_id(s)']);

获取账户余额

获取余额，只需按如下方式调用balance

$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";

 $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'];

];
$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'],
     ......
  ];
$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 / sms-api

维护者

详细信息