onesend-gmbh/onesend-php-sdk

OneSend 消息服务的 PHP SDK

1.0.2 2024-04-18 14:16 UTC

This package is auto-updated.

Last update: 2024-09-18 15:10:18 UTC


README

需求

要使用 OneSend PHP SDK,需要以下条件

安装

使用 Composer

安装 OneSend PHP SDK 的最佳方式是使用 Composer。您可以使用以下命令要求它

composer require onesend-gmbh/onesend-php-sdk

用法

通过传递您的 项目仪表板 中的 Api Key 来初始化 SDK。

$oneSend = new \OnesendGmbh\OnesendPhpSdk\OneSendApi('YOUR KEY HERE');

可选地,您还可以传递一个 PSR-18 合规的客户端作为第二个参数,如果您想修改超时/重试行为或进行测试。

使用 SDK,您现在可以访问以下端点

您可以在 这里 找到我们的完整文档。

短消息

发送短消息(SMS)

创建短消息引用

$shortMessage = $oneSend->shortMessages->send([
    'to' => '+4915730955123',
    'from' => 'TEST',
    'message' => 'THIS IS A TEST',
]);

这将创建一个 ShortMessage 资源,具有消息 ID $shortMessage->getId() 您可以和一些关于已发送的短消息的其他信息。

测试

默认情况下,SDK 将在初始化时将 Symfony Http Client 设置为 HTTP 客户端,这意味着如果您不模拟 SDK 的调用,它将向我们的服务发送请求,并且您的测试很可能会失败。
如果您不想(或不能)模拟 SDK 的调用,您还可以通过将 Mock 客户端(例如 PHP HTTP Mock Client)作为第二个构造函数参数传递来替换默认的 HTTP 客户端

$mockClient = new Http\Mock\Client();
$oneSend = new \OnesendGmbh\OnesendPhpSdk\OneSendApi('I am a Test', $mockClient);

这将替换默认的 Http 客户端,并允许您拦截并验证 SDK 发出的请求,以及模拟具有期望结果的响应。
要查看预期的响应,请参阅我们的 API 文档