simialbi/yii2-websms-com

一个用于在yii2框架中使用websms.com短信服务的PHP客户端库。

维护者

详细信息

github.com/simialbi/yii2-websms-com

源代码

问题

安装: 33

依赖者: 1

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 2

开放问题: 0

类型:yii2-extension

1.0.1 2020-04-17 12:53 UTC

Requires

Requires (Dev)

MIT 19752f645faaa43d5e30143cba950579889eaeb3

  • simialbi <simi.albi.woop@outlook.com>

smsyii2sms apiwebsmswebsms.com

This package is auto-updated.

Last update: 2024-09-17 23:22:32 UTC

README

一个轻量级的PHP客户端库，用于使用yii2框架与websms.com短信服务。简化客户端与短信网关之间的网络通信，以帮助节省时间和金钱，专注于业务逻辑。

Latest Stable Version Total Downloads License

安装

安装此扩展的首选方式是通过composer。

运行以下命令：

$ php composer.phar require --prefer-dist simialbi/yii2-websms-com

或者将以下内容添加到你的composer.json文件的require部分：

"simialbi/yii2-websms-com": "^1.0.0"

to the require section of your composer.json.

使用方法

为了使用此组件，你需要

  1. 设置组件以使模块可用。

设置组件

return [
    // [...]
    'components' => [
        'sms' => [
            'class' => 'simialbi\yii2\websms\Connection',
            'baseUrl' => 'https://api.websms.com',
            'token' => '<your api token>',
            'sendUrl' => '/rest/smsmessaging/simple'
        ]
    ]
];

示例用法

要发送消息，请创建一个新的Message实例，并至少设置内容和接收者。

<?php
 /** @var \simialbi\yii2\websms\Connection $sms */
$sms = Yii::$app->get('sms', true);
$message = $sms->createMessage();
$message
    ->id('my-test-id-' . uniqid())
    ->category($message::CATEGORY_INFORMATIONAL)
    ->content("This is a test\nwith multpile lines")
    ->type($message::MESSAGE_TYPE_TEXT)
    ->addRecipient('4367612345678');
$response = $message->send();

if ($response->isOk) {
    echo 'success';
} else {
    echo 'failure';
}

许可协议

yii2-websms-com采用MIT许可协议发布。有关详细信息，请参阅附带的LICENSE。