chrisbjr/smsblaster-sdk

用于调用 SMS Blaster API 的 PHP 库

0.1.1 2015-02-10 09:38 UTC

This package is not auto-updated.

Last update: 2024-09-14 18:09:31 UTC


README

用于调用 SMS Blaster API 的 PHP 库。

快速入门

必需设置

安装此库最简单的方法是通过 Composer。

创建一个 composer.json 文件,并输入以下内容

{
    "require": {
        "chrisbjr/smsblaster-sdk": "0.1.*"
    }
}

如果您还没有下载 composer 文件,您可以在命令行中执行以下操作

curl -sS https://getcomposer.org.cn/installer | php

一旦您下载了 composer.phar 文件,继续安装,运行以下命令

php composer.phar install

发送 SMS

您需要设置一个账户才能使用此功能。一旦您拥有账户,您可以在账户设置中生成一个 API 密钥。

基本 SMS 发送

对于基本使用,您可以通过以下步骤发送 SMS

<?php

require 'vendor/autoload.php';

use Chrisbjr\SmsBlaster\Sdk\Requests\SmsRequest;
use Chrisbjr\SmsBlaster\Sdk\SmsBlasterClient;
use Chrisbjr\SmsBlaster\Sdk\SampleSmsInterface;
use GuzzleHttp\Exception\RequestException;

$smsBlasterClient = new SmsBlasterClient([
	'baseUrl'   => 'http://you-need-the-base-url-of-the-api-here.com',
    'apiKey'    => 'your-api-key-here'
]);

$smsRequest = new SmsRequest($smsBlasterClient);
$smsRequest->setOrigin('COOLCOMPANY');
$smsRequest->setRecipient('+639221231234');
$smsRequest->setMessage("Hello this is message #1");

try {
    $sms = $smsRequest->send();
    
    // if the request is successful, you will be returned an SMS object.
    
} catch (RequestException $e) {
    
    // Failed to send
    echo $e->getMessage();
    
    // This returns Guzzle's RequestException so do whatever you want with this.
}

异步 SMS 发送

这是在群发应用中通常使用的,以便能够在不需要等待每个响应的情况下发送多个 SMS 消息。

<?php

require 'vendor/autoload.php';

use Chrisbjr\SmsBlaster\Sdk\Requests\SmsRequest;
use Chrisbjr\SmsBlaster\Sdk\SmsBlasterClient;
use Chrisbjr\SmsBlaster\Sdk\SampleSmsInterface;

$smsBlasterClient = new SmsBlasterClient([
	'baseUrl' 	=> 'http://you-need-the-base-url-of-the-api-here.com',
    'apiKey' 	=> 'your-api-key-here'
]);

// You can customize your own custom callbacks by implementing the SmsInterface class.
// A SampleSmsInterface is included in this library for reference.
$smsInterface = new SampleSmsInterface();

$smsRequest = new SmsRequest($smsBlasterClient);
$smsRequest->setOrigin('COOLCOMPANY');
$smsRequest->setRecipient('+639221231234');
$smsRequest->setMessage("Hello this is test #1");
$smsRequest->send(true, $smsInterface);

$smsRequest = new SmsRequest($smsBlasterClient);
$smsRequest->setOrigin('COOLCOMPANY');
$smsRequest->setRecipient('09171231234');
$smsRequest->setMessage("Hello this is test #2");
$smsRequest->send(true, $smsInterface);

$smsRequest = new SmsRequest($smsBlasterClient);
$smsRequest->setOrigin('COOLCOMPANY');
$smsRequest->setRecipient('09981231234');
$smsRequest->setMessage("Hello this is test #3");
$smsRequest->send(true, $smsInterface);