README

🇬🇧

PHP 库，实现 SMS Bulk API v2.2，由 SmsOnline 公司提供

优点

1. 简单。发送短信只需 3 个类：API 客户端、消息 和 响应
2. 完全功能。您可以创建一个消息实例并发送给多个收件人
3. 以 composer 包的形式实现，只需一行代码即可添加库
4. 可以使用 命令行工具 快速发送短信

安装

通过 composer 获取包以简单使用

    $ composer require topface/smsonline

在第三方项目中使用时，修改 composer.json 如下

    "topface/smsonline": "*"

然后执行命令 composer update

使用

首先需要创建一个客户端实体，指定其登录名、密钥和发送者名称

    use TopfaceLibrary\SmsOnline\Bulk\Client;
    
    $Client = new Client(<from>, <user>, <secret>);

然后创建一个消息实例并直接发送它

    use TopfaceLibrary\SmsOnline\Bulk\Message;

    $Message = new Message('hello');
    $Message->addPhone(79031234567);
    $Message->addPhone(79165557755);
    $Result = $Client->send($Message);

命令行使用

可以使用 send.php 脚本直接调用 Sms Bulk API

    $ php bin/send.php -h
    Using: /usr/local/bin/php bin/send.php [-h|--help] -f|--from -p|--phone -s|--secret -t|--text -u|--user
    -h, --help  - show help
    -f, --from  - sender alpha-name
    -p, --phone  - receiver phone or phones (comma-separated)
    -s, --secret  - secret key
    -t, --text  - message text
    -u, --user  - sender login

只需调用脚本并指定所需参数：发送者名称、密钥、登录名、收件人电话和消息文本

    $ php bin/send.php -f='Company' -p='79031234567,79165557755' -s='secRet' -t='hello' -u='userlogin'
        code:    0
        message: OK
        ids:
            79031234567: 45678901-2222-1111-4466-aabbcc556677
            79165557755: 56789012-2222-1111-4466-aabbcc556677

如果发生任何问题，脚本将返回错误代码及其描述

    $ php bin/send.php -f='Company' -p='79031234567,79165557755' -s='wr0NGsecRet' -t='hello' -u='userlogin'
        code:    -2
        message: AUTH ERROR (sign)
        ids:

测试

使用 phpunit 命令运行测试

    $ phpunit
    PHPUnit 4.7.5 by Sebastian Bergmann and contributors.
    
    Runtime:	PHP 5.5.23
    
    ......
    
    Time: 111 ms, Memory: 6.00Mb
    
    OK (6 tests, 47 assertions)

支持

我们欢迎任何有助于项目发展的帮助。接受修复作为拉取请求。我们真诚地请求您为发送的更改添加测试并记录所有更改

许可证

版权所有 © 2015 有限公司 "Topface" alexey.y.maslov@topface.com 许可证 Apache License, Version 2.0。有关许可证的完整内容，请参阅链接

https://apache.ac.cn/licenses/LICENSE-2.0