README

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

基于GoldSpecDigitals的工作，已更新以支持更新的Voodoo REST API。

入门指南

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

先决条件

PHP: >=8.2

安装

只需使用composer拉取此包

$ composer require rustythedalek/voodoo-sms-sdk

示例

发送短信

<?php

use GoldSpecDigital\VoodooSmsSdk\Client;

$client = new Client('api_key');

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

var_dump($response);

/*
{
    "statusCode": 200,
    "originator": "VoodooSMS",
    ...
}
*/

获取短信的投递状态

<?php

use GoldSpecDigital\VoodooSmsSdk\Client;

$client = new Client('api_key');

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

var_dump($response);

/*
{
    "limit": 25,
    "report" [
        {
        "message_id": "97709216074987x3NFD16GgkChK2E67441209181vapi",
        "sender_id": "Chris",
        "to": 447000000000,
        "sent_at": 1542120829,
        "delivered_at": 1542120852,
        "price": 2.9,
        "status": "DELIVERED"
        }
    ]
}
*/

运行测试

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

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

$ vendor/bin/phpunit

以及编码风格测试

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

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

$ vendor/bin/phpcs

构建于

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

贡献

欢迎提交拉取请求，尽管任何失败PHPUnit或lint的请求将被自动拒绝。

许可

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

rustythedalek / voodoo-sms-sdk

维护者

详细信息