README

SuperText Nigeria SMS 网关 PHP 封装

简介

这是一个用于 SuperText Nigeria 的 SMS API 网关的简单 PHP 封装。

安装

使用 Composer

composer require kheme/php-supertext-nigeria

用法

在调用之前导入类。

require_once 'vendor/autoload.php';
use Kheme\SuperTextNg\SMS;

向单个收件人发送

$sms = new SMS('SUPERTEXTNG_USERNAME', 'SUPERTEXTNG_PASSWORD');
$sms->from('Kheme');
$sms->to('2348153332428')
$sms->message('Using the facade to send a message.')
$sms->send();   // returns true

如果发送失败，将会抛出异常。

向多个收件人发送

您可以通过在调用中包含多个 to() 来向多个收件人发送短信

$sms = new SMS('SUPERTEXTNG_USERNAME', 'SUPERTEXTNG_PASSWORD');
$sms->from('Kheme');
$sms->to('2348153332428');
$sms->to('2348056511193');
$sms->message('Using the facade to send a message.');
$sms->send();   // returns true

或者，通过向单个 to() 提供电话号码数组

$sms = new SMS('SUPERTEXTNG_USERNAME', 'SUPERTEXTNG_PASSWORD');
$sms->from('Kheme');
$sms->to([
    '2348153332428',
    '2348056512393',
]);
$sms->message('Using the facade to send a message.');
$sms->send();   // returns true

向 DND 启用的号码发送

要向已启用 Do Not Disturb (DND) 的号码发送短信，请在调用中包含 ignoreDND()

$sms = new SMS('SUPERTEXTNG_USERNAME', 'SUPERTEXTNG_PASSWORD');
$sms->from('Kheme');
$sms->to('2348153332428');
$sms->message('Using the facade to send a message.');
$sms->ignoreDND();
$sms->send();   // returns true

发送后返回余额

如果您希望在发送后返回账户余额，请在调用中包含 returnBalance()

$sms = new SMS('SUPERTEXTNG_USERNAME', 'SUPERTEXTNG_PASSWORD');
$sms->from('Kheme');
$sms->to('2348153332428');
$sms->message('Using the facade to send a message.');
$sms->returnBalance();
$sms->send();   // returns true

返回发送使用的单位数量

如果您希望在发送后返回使用的总单位数量，请在调用中包含 returnUnitsUsed()

$sms = new SMS('SUPERTEXTNG_USERNAME', 'SUPERTEXTNG_PASSWORD');
$sms->from('Kheme');
$sms->to('2348153332428');
$sms->message('Using the facade to send a message.');
$sms->returnUnitsUsed();
$sms->send();   // returns true

组合选项

上述方法选项（不包括下面的 balance()），可以像以下示例那样组合

$sms = new SMS('SUPERTEXTNG_USERNAME', 'SUPERTEXTNG_PASSWORD');
$sms->from('Kheme');;
$sms->to('2348153332428');
$sms->message('Using the facade to send a message.');
$sms->returnBalance();
$sms->returnUnitsUsed();
$sms->ignoreDND();
$sms->send();   // returns true

检查账户余额

要检查您的 SuperText Nigeria 信用余额，只需调用 balance()

$sms = new SMS('SUPERTEXTNG_USERNAME', 'SUPERTEXTNG_PASSWORD');
return $sms->balance();

错误

在发生错误的情况下，调用将返回以下错误

左侧的数字是来自 SuperText Nigeria 的对应错误代码，但不会包含在错误响应中

• 100: 缺少一个或多个必需的 URL 参数，或者拼写错误
• 101: 用户名空白
• 102: 密码空白
• 103: 目的地空白
• 104: 消息空白
• 105: 发送者空白
• 200: 用户名或密码错误
• 201: 账户尚未激活
• 202: 账户不活跃
• 300: 信用不足
• 400: 发送失败（未扣除信用）