JSMS API PHP CLIENT
这是短信 API 的 PHP 版本封装开发包，是由极光官方提供的，一般支持最新的 API 功能。
对应的 API 文档：https://docs.jiguang.cn/jsms/server/rest_api_summary/
支持的 PHP 版本: 5.3.3 ～ 5.6.x, 7.0.x 须启用 cURL 扩展
Installation
- 在项目中的
composer.json文件中添加 JSMS 依赖：
"require": {
"jiguang/jsms": "~1.0"
}- 执行
$ php composer.phar install或$ composer install进行安装。
Usage
初始化
use JiGuang\JSMS as JSMS;
...
...
$client = new JSMS($app_key, $master_secret);
...OR
$client = new \JiGuang\JSMS($app_key, $master_secret);证书问题
// 禁用 SSL 证书的验证，
$client = new JSMS($app_key, $master_secret, [ 'disable_ssl' => true ]);希望开发者在了解相关风险的前提下如此处理 SSL 证书问题。
发送验证码
$client->sendCode($phone, $temp_id, $sign = null);参数说明:
$phone: 接收验证码的手机号码
$temp_id: 模板ID
$sign_id: 签名ID，null 表示使用应用默认签名
发送语音短信验证码
$client->sendVoiceCode($phone, $options = []);参数说明:
$phone: 接收验证码的手机号码
$options: 可选选项数组，接受 3 个键
ttl，code，voice_lang中的一个或多个。
- ttl: 超时时间，默认为 60 秒
- code: 语音验证码的值，验证码仅支持 4-8 个数字
- voice_lang: 播报语言选择，0：中文播报，1：英文播报，2：中英混合播报
验证
$client->checkCode($msg_id, $code);参数说明:
$msg_id: 发送验证码 sendCode 函数返回的数组中的 msg_id 键对应的值
$code: 手机接收到的验证码
发送模板短信
$client->sendMessage($mobile, $temp_id, array $temp_para = [], $time = null, $sign_id = null);参数说明:
$phone: 接收验证码的手机号码
$temp_id: 模板 ID
$temp_para: 模板参数,需要替换的参数名和 value 的键值对,仅接受数组类型的值
$time: 定时短信发送时间，格式为 yyyy-MM-dd HH:mm:ss，默认为
null表示立即发送
$sign_id: 签名ID，null 表示使用应用默认签名
发送批量模板短信
$client->sendBatchMessage($temp_id, array $recipients，$time = null, sign_id = null, $tag = null);参数说明:
$temp_id: 模板 ID
$recipients: 接收者列表，接受一个以 mobile 为键，对应其 temp_para 为值的关联数组
$time: 定时短信发送时间，格式为 yyyy-MM-dd HH:mm:ss，默认为
null表示立即发送
$sign_id: 签名ID，null 表示使用应用默认签名
$tag: 标签，仅用作标示该短信的别名，不在短信中展示，最多不超过 10 个字
查询定时模板短信
$client->showSchedule($scheduleId);删除定时模板短信
$client->deleteSchedule($scheduleId);应用余量查询
$client->getAppBalance();调用返回码说明
http://docs.jiguang.cn/server/rest_api_jsms/#_12
Examples
在下载的中的 examples 文件夹有简单示例代码, 开发者可以参考其中的样例快速了解该库的使用方法。
注：所下载的样例代码不可马上使用，需要在相应文件中填入相关的必要参数，不然示例运行会失败
简单使用方法
假定当前目录为 JSMS 源码所在的根目录
- 编辑
examples/config.php文件，填写信息
$appKey = 'xxxx';
$masterSecret = 'xxxx';
$phone = 'xxxxxxxxxxx';-
运行示例
$ php examples/send_example.php -
获取
msg_id和code -
编辑
examples/check_example.php文件，填写信息
$msg_id = 'xxxx';
$code = 'xxxxxx';- 运行示例
$ php examples/check_example.php
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jpush/jsms-api-php-client.
License
The library is available as open source under the terms of the MIT License.
