README

PHP SDK，用于与Voodoo SMS API通信。

入门指南

以下说明将帮助您在本地机器和开发环境中启动。

先决条件

PHP: >=7.2

安装

只需使用composer拉取包

$ composer require goldspecdigital/voodoo-sms-sdk

示例

发送短信

<?php

use GoldSpecDigital\VoodooSmsSdk\Client;

$client = new Client('username', 'password', 'CompanyName');

$response = $client->send('This is a test message', '07712345678');

var_dump($response);

/*
{
    "result": 200,
    "resultText": "200 OK",
    "reference_id": ["A3dads..."]
}
*/

获取短信的投递状态

<?php

use GoldSpecDigital\VoodooSmsSdk\Client;

$client = new Client('username', 'password', 'CompanyName');

$response = $client->getDeliveryStatus('A3dads...');

var_dump($response);

/*
{
    "result": "200 OK",
    "reference_id": "A3dads...",
    "message": "This is a test message",
    "delivery_status": "Delivered",
    "delivery_datetime": "2017-12-28 00:06:09"
}
*/

运行测试

要运行测试，您需要在项目根目录中的.env文件中存储Voodoo SMS凭证。提供了一个示例文件，其中包含所需的密钥：.env.example。

您可以在运行PHP >=7.2的环境中运行测试，使用PHP Unit

$ vendor/bin/phpunit

和编码风格测试

该项目遵循PSR1和PSR2编码标准，并在所有PHP文件中启用严格类型。

在提交任何代码之前，请确保您的代码通过运行

$ vendor/bin/phpcs

构建工具

Composer - 依赖管理
Guzzle - 与Voodoo SMS API通信的HTTP客户端

贡献

您可以自由地提交拉取请求，但任何失败的PHPUnit或linter请求将被自动拒绝。

版本控制

我们使用SemVer进行版本控制。有关可用版本，请参阅此存储库的标签。

许可

该项目受MIT许可证的许可 - 有关详细信息，请参阅LICENSE.md文件

goldspecdigital / voodoo-sms-sdk

维护者

详情