ouarea/chuanglan-sms

以chuanglan为后端的短信服务实现

2.0.2 2017-03-19 05:28 UTC

This package is not auto-updated.

Last update: 2024-09-14 20:09:34 UTC


README

使用Chuanglan提供的API实现短信相关服务,包括发送短信、查询配额/余额等。

此服务仅提供最基本的功能,旨在作为其他项目的基础设施进行集成。

use Ouarea\Sms\Chuanglan\Service as ChuanglanSmsService;

$service = new ChuanglanSmsService('account', 'password');
// - or the full version
// $service = new ChuanglanSmsService('account', 'password', $optionsOfService, $instanceOfClient);

// send message
$service->send('message', $subscriber, $optionsOfMessage);
// query quota
$quota = $service->queryQuota();

API

构造

__construct($account, $password, array $options = [], $httpClient = null)

  • $account 用于发送短信的chuanglan账户
  • $password 与账户对应的密码,应为MD5加密
  • $options 创建ChuanglanSmsService的选项。包括
    • name 商户名称(例如,【XXX】),可以是消息的前缀或后缀。
    • affix 附加号码,发送者号码的一部分,将被用于
    • send_url 发送消息的URL(通常,您不会更改它,因为Chuanglan目前没有准备其他环境)
    • quota_url 查询配额的URL(通常,您不会更改它,因为Chuanglan目前没有准备其他环境)
  • $httpClient GuzzleHttp客户端实例

发送消息

send($message, $subscriber)

  • $message 要发送的消息
  • $subscriber 订阅者或订阅者列表

查询配额

queryQuota()

无参数,返回账户余额。