codemonkey76 / laravel-clicksend
Laravel 对 ClickSend REST API 的封装
v1.0.1
2024-03-18 02:52 UTC
Requires
- php: ^8
- guzzlehttp/guzzle: ^7
- illuminate/support: ^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- orchestra/testbench: ^6.0|^7.0|^8.0|^9.0
- phpunit/phpunit: ^9.0|^10.0|^11.0
README
这是 ClickSend REST API 的 Laravel 封装,目前仅实现发送短信和获取这些消息的投递回执。
安装
您可以通过 composer 安装此包。
composer require codemonkey76/laravel-clicksend
配置
您可以发布配置文件以修改配置(如果需要)。
php artisan vendor:publish --provider="Codemonkey76\ClickSend\ClickSendServiceProvider"
环境
将以下内容添加到您的 .env 文件中,并设置从您的 ClickSend 账户获取的值。
CLICKSEND_USERNAME=<your username goes here> CLICKSEND_PASSWORD=<your api key goes here>
如果需要修改 API 端点,您也可以定义以下内容。
CLICKSEND_API_ENDPOINT=*<api endpoint goes here>*
用法
示例 1. 发送单个消息并检索投递回执。
use Codemonkey76\ClickSend\SmsMessage; $recipient = '1234567890'; $senderId = '1234567890'; $body = 'Test Message'; $message = new SmsMessage($recipient, $senderId, $body); $response = ClickSend::SendMessage($message); // Some time later, get the receipt. sleep(5); ClickSend::GetMessageReceipt($response->data->messages[0]->message_id);
示例 2. 发送多条消息并检索它们的投递回执。
use Codemonkey76\ClickSend\SmsMessage; $message1 = new SmsMessage('1234567890', '1234567890', 'Test Message #1'); $message2 = new SmsMessage('1234567890', '1234567890', 'Test Message #2'); $message3 = new SmsMessage('1234567890', '1234567890', 'Test Message #3'); $message4 = new SmsMessage('1234567890', '1234567890', 'Test Message #4'); $response = ClickSend::SendMessage([$message1, $message2, $message3, $message4]); // Some time later, get the receipts. sleep(5); $receipt1 = ClickSend::GetMessageReceipt($response->data->message[0]->message_id); $receipt2 = ClickSend::GetMessageReceipt($response->data->message[1]->message_id); $receipt3 = ClickSend::GetMessageReceipt($response->data->message[2]->message_id); $receipt4 = ClickSend::GetMessageReceipt($response->data->message[3]->message_id);
变更日志
请参阅变更日志获取有关最近更改的更多信息。
贡献
请参阅贡献指南以获取详细信息。
安全性
如果您发现任何与安全相关的问题,请通过shane@alphasg.com.au发送电子邮件,而不是使用问题跟踪器。
鸣谢
许可证
MIT 许可证 (MIT)。请参阅许可证文件获取更多信息。
Laravel 包模板
此包是用Laravel 包模板生成的。