README

始终送达

简介

此库处理所有的 SMSALES API。

安装

推荐通过 Composer 安装 smsales-php-sdk。

# Install package via composer
composer require shiftechafrica/smsales-php-sdk

接下来，运行 Composer 命令以安装最新稳定版本的 shiftechafrica/smsales-php-sdk

# Update package via composer
 composer update shiftechafrica/smsales-php-sdk --lock

安装后，包将被自动发现。但如果需要，您可以运行

# run for auto discovery <-- If the package is not detected automatically -->
composer dump-autoload

然后运行此命令，以获取您自己的配置 config/smsales.php

# run this to get the configuration file at config/smsales.php <-- read through it -->
php artisan vendor:publish --provider="SMSALES\SMSALEServiceProvider"

将创建一个 config/.php 文件，按照以下示例定义您自己的配置。

# set your account secret key api token
SMSALES_API_TOKEN=check_on_api_profile

使用方法

按照以下步骤了解如何使用 smsales-php-sdk

如何使用库

如何使用 smsales-php-sdk 初始化不同级别的 api

        use SMSALES\API\Trigger;
        
        /**
         * Fetch latest sent sms
         */
        (new Trigger())->index();
        
        /**
         * get sms account balance
         * @return mixed
         */
        (new Trigger())->accountSmsBalance());
        
        /**
         * get sms sender ids balance
         * @return mixed
         */
        (new Trigger())->senderIDSmsBalance());
  
        /**
         * initiate bulk sms
         * @return mixed
         */
        (new Trigger())->send([
            "api_sender" => "shiftech",// required check on your senderID's list for the API Sender
            "message" => "Hello Smsales.",// required
            "phone_numbers" => ["2547XXXXXXXX","2540XXXXXXXX","2547XXXXXXXX"],// required
            "scheduled_at" => "Y-m-d H:i:s", // optional
            "callback_url"=> "https://yourdomain/report"// optional this should be a POST request
        ]);

API 响应

以下是响应。

批量短信成功

{
    "data": {
        "message": "Accepted for dispatch..."
    }
}

批量短信的回调报告

{
  "sent":true,
  "sender":"SHIFTECH",
  "apiSender":"shiftech",
  "phoneNumbers":[
    "254XXXXXXXXX",
    "254XXXXXXXXX",
    "254XXXXXXXXX"
  ],
  "batch":"1CRVD1GEXE",
  "account":{
    "smsBalance":"663",
    "smsUsage":"24"
  }
}

shiftechafrica / smsales-php-sdk

维护者

详细信息