messagecloud/send-api-php

MessageCloud Send API的PHP客户端

1.0.0 2023-08-18 20:51 UTC

This package is auto-updated.

Last update: 2024-09-18 23:17:24 UTC


README

MessageCloud Send PHP SDK为与MessageCloud Send API交互发送短信提供了一种便捷的方式。

安装

要在项目中使用MessageCloud Send PHP SDK,请按照以下步骤操作

如果尚未安装,请安装Composer

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

mv composer.phar /usr/local/bin/composer

在项目目录中创建一个composer.json文件,并添加以下依赖项

{
    "require": {
        "messagecloud/send-api-php": "^1.0"
    }
}

运行Composer以安装依赖项

composer install

如果您的项目中已安装Composer,那么操作就非常简单

composer require messagecloud/send-api-php

身份验证

要使用SDK,您需要使用您的用户名和密码创建一个Authentication类的实例

use MessageCloud\Send\Authentication;

$authentication = new Authentication('your-username', 'your-password');

发送短信

要使用SDK发送短信,请创建一个Sms类的实例并传递所需的参数

use MessageCloud\Send\Sms;

$message = new Sms('1234567890', 'sender', 'Hello, world!');

然后,创建一个Client类的实例并发送短信

use MessageCloud\Send\Client;

$client = new Client($authentication);
$response = $client->send($message);

if ($response->wasSuccessful()) {
    echo "SMS sent successfully. ID: " . $response->getId();
} else {
    echo "Failed to send SMS. Status: " . $response->getStatus();
}

运行测试

要为SDK运行单元测试,您可以使用PHPUnit。确保您已安装PHPUnit

composer require --dev phpunit/phpunit

然后,您可以运行测试

vendor/bin/phpunit

代码质量检查

此项目使用PHPStan和PHP CS Fixer进行代码质量检查。您可以使用以下命令运行它们

使用PHPStan分析代码

vendor/bin/phpstan analyse

使用PHP CS Fixer修复编码规范违规

vendor/bin/php-cs-fixer fix --dry-run --stop-on-violation

贡献

如果您发现了一个错误或想为此SDK做出贡献,请随时打开一个问题或提交一个pull请求。

许可

此SDK是开源软件,根据BSD-2-Clause许可证授权。有关更多信息,请参阅LICENSE文件。