README

BBN SMS API客户端是一个简单的库，可以为您的应用程序在交易时间发送短信通知。设置非常简单，通常不需要超过2分钟即可启动运行。

先决条件

在 https://bbnsms.com（注意：这将重定向到 https://sms.bbnplace.com）创建一个BBN SMS账户
登录bbnsms.com并注册您的发送者姓名以供批准。（这是一个监管步骤。发送者姓名批准可能需要24-48小时。）在您等待批准的同时，让我们继续设置。

设置

在开始之前，请确保您已经为您的项目下载并安装了composer。查看安装composer的指南。

1. 安装包

您可以通过将以下内容添加到您的composer.json文件中的依赖项（require属性）来将bbnsms api客户端添加到您的项目中，然后在您的终端上运行以下命令：或者您可以直接在终端上运行以下命令。这将安装bbnsms-api-client及其所有依赖项到您的vendor目录中。

"bbnsms/sms-api-client": "dev-master"

到您的依赖项（require属性）中，然后在您的终端上运行以下命令：

composer install

在您的终端上。这将安装bbnsms-api-client及其所有依赖项到您的vendor目录中。

composer require bbnsms/sms-api-client

在您的终端上。这将安装bbnsms-api-client及其所有依赖项到您的vendor目录中。

2. 设置包

在您的应用程序根目录中创建一个 .bbnsms.json 文件。将您的BBN SMS登录凭据（在先决条件步骤一中生成）添加到文件中，如下所示

{
    "access": {
        "credentials": {
            "username": "me@company.com",
            "password": "aWe$0mePas5word"
        }
    }
}

这就是所有设置！惊讶吗？让我们测试这个包。

测试库

由于我们正在使用composer，我假设在您的项目中您已经在某处自动加载了类。如果您的入口脚本中至少有像这样的操作，BBN SMS API客户端将自动加载。

require_once __DIR__."/vendor/autoload.php";

**如果您使用的是框架，这已经为您做好了。**

在您的脚本或类文件顶部导入 Bbnsms\SMSClient 并创建一个SMSClient实例，如适当

use Bbnsms\SMSClient;

$smsclient = new SMSClient();

测试您的登录凭据

printf("Valid Credentials: %s", $smsclient->testCredentials());

检查您的余额

printf("Balance: %.2f", $smsclient->getBalance());

向单个联系人发送短信

要发送消息，调用sms客户端的 send 方法，如下所示

SMSClient->send(string message, string senderName, array recipients, bool flash=false): string

示例

发送收件箱短信

printf("Send Response: %s", $smsclient->send("Sample Message", "APPROVED_SENDER_NAME", ["234818xxxxxxx"]));

发送闪存短信

printf("Send Response: %s", $smsclient->send("Sample Message", "APPROVED_SENDER_NAME", ["234818xxxxxxx"], true));

向多个联系人发送短信

printf("Send Response: %s", $smsclient->send("Hello", "APPROVED_SENDER_NAME", ["234818xxxxxxx","234909xxxxxxx"]));

安排消息

安排的消息将需要两个附加参数：broadcastTime和scheduleName

SMSClient->schedule(int broadcastTime, string scheduleName, string message, string senderName, array recipients, bool flash=false): string

broadcastTime将是一个UNIX_TIMESTAMP值。这是一种通过简单地调用php time()生成的类型的时间戳。

示例

安排收件箱短信

// printf("Scheduler Response: %s", $smsclient->schedule(time() + 60, "SchedTstr", "Hello", "APPROVED_SENDER_NAME", ["234818xxxxxxx"]));

安排闪存短信

// printf("Scheduler Response: %s", $smsclient->schedule(time() + 60, "SchedTstr", "Hello", "APPROVED_SENDER_NAME", ["234818xxxxxxx"], true));

成功发送的消息将返回1801作为响应。请参阅以下API响应部分的完整列表及其含义。

API响应

重要说明

发送者姓名

APPROVED_SENDER_NAME是您在bbnsms.com上注册并已确认批准的发送者姓名
发送者姓名必须是11个（11）个字母数字字符的字符串。
发送者姓名必须是您企业的名称、简称或缩写。

消息

消息不能超过765个字符（5页）
页数是根据短信消息标准计算的，如下所示
1. 单页短信将接受160个字符
2. 短信的第二页只能容纳146个字符
3. 其他每个短信页可以容纳153个字符
闪存消息是弹出在接收设备上以供即时阅读的消息，可能不会保存到接收手机的收件箱中。

如果您想自定义集成，请参阅我们的集成指南。

bbnsms / sms-api-client

维护者

详细信息