Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lancewan/laravel5-cloud
荣联云通讯扩展包，双向回拨电话，发送短信验证码，语音验证码功能
https://github.com/lancewan/laravel5-cloud
Last synced: 3 months ago
JSON representation
荣联云通讯扩展包，双向回拨电话，发送短信验证码，语音验证码功能
- Host: GitHub
- URL: https://github.com/lancewan/laravel5-cloud
- Owner: lanceWan
- Created: 2016-04-07T05:52:17.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-13T04:03:22.000Z (over 8 years ago)
- Last Synced: 2024-09-14T16:56:04.520Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 33.2 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# laravel5-cloud
[云通讯官方API文档](http://docs.yuntongxun.com/index.php/%E9%A6%96%E9%A1%B5)
Packagist:[https://packagist.org/packages/lancewan/laravel5-cloud](https://packagist.org/packages/lancewan/laravel5-cloud)
## 快速安装
通过`composer`来安装
```php
composer require lancewan/laravel5-cloud
```
或者加入下面代码到 `composer.json` 文件,并执行`composer install` **Or** `composer update`:
```php
"lancewan/laravel5-cloud": "^1.0"
```
扩展包加载完成后,在 `config/app.php` 的文件中加入以下代码:
### Service Provider
```php
Lance\Cloud\CloudServiceProvider::class,
```
### Facade
```php
'Cloud' => Lance\Cloud\Facades\Cloud::class,
```
最后执行 `php artisan vendor:publish` ,在`config`文件夹下将会生成一个`cloud.php`的配置文件.
And that's it!
## cloud.php 配置文件
`cloud.php`是云通讯的配置文件,主要配置信息如下:
```php
'',
// 主帐号Token
'accountToken' => '',
// AppId 应用ID
'appId' => '',
// SubAccountSid 子帐号
'subAccountSid' => '',
// SubAccountToken 子帐号Token(密码)
'subAccountToken' => '',
// VoIPAccount VoIP帐号
'voIPAccount' => '',
// VoIPPassword VoIP密码
'voIPPassword' => '',
//请求地址，格式如下，不需要写https://
'serverIP' => '',
//请求端口
'serverPort' => '',
//REST版本号 云通讯固定版本号，除非官方接口升级外,不要修改版本号
'softVersion' => '2013-12-26',
//包体格式，可填值：json 、xml
'bodyType' => 'json',
//日志开关。可填值：true、false
'enabeLog' => true,
......
];
```
## 主要功能
方法名和云通讯的[测试demo](http://docs.yuntongxun.com/index.php/Demo%E4%B8%8B%E8%BD%BD)中的方法名一致,所以大家要调用什么功能,直接看官方api的方法名来使用本扩展. enjoy it!
**双向回拨**
```php
$result = Cloud::callBack("呼叫号码","被叫号码");
```
> 双向回拨是先拨打呼叫号码，等呼叫号码接通后再拨打被叫号码
**发送短信**
```php
/**
* 发送模板短信
* @author 晚黎
* @date 2016-04-08T15:11:13
* @param [string] $to [接收号码]
* @param [array] $datas [发送的验证码和时间['验证码','时间']]
* @param [int] $tempId [短信模板ID]
*/
$result = Cloud::sendTemplateSMS('187********',['5564','20'],1);
```
**语音验证码**
```php
/**
* 语音验证码
* @author 晚黎
* @date 2016-04-08T15:25:04
* @param [String] $verifyCode [验证码内容，为数字和英文字母，不区分大小写，长度4-8位。当playVerifyCode为空时有效，该参数和playVerifyCode二者不能同时为空，当二者都不为空时优先使用playVerifyCode。]
* @param [String] $to [接收号码，被叫为座机时需要添加区号，如：01052823298；被叫为分机时分机号由‘-’隔开，如：01052823298-3627]
* @param [int] $playTimes [循环播放次数，1－3次，默认播放1次。]
* @param [String] $displayNum [来电显示的号码，根据平台侧显号规则控制(有显号需求请联系云通讯商务，并且说明显号的方式)，不在平台规则内或空则显示云通讯平台默认号码。默认值空。注：来电显示的号码不能和接收验证码的号码相同，否则显示云通讯平台默认号码。]
* @param [String] $respUrl [语音验证码状态通知回调地址（必须符合URL规范），云通讯平台将向该Url地址发送呼叫结果通知。]
* @param [String] $lang [语言类型。取值en（英文）、zh（中文），默认值zh。]
* @param [String] $userData [第三方私有数据，可在语音验证码状态通知中获取此参数。]
*/
$result = Cloud::voiceVerify($verifyCode,$to,$playTimes = '',$displayNum = 1,$respUrl = '',$lang = 'zh',$userData = '');
```
...
除了上面主要方法,还有其他的一些方法就不描述了，下面是荣联云的接口所有方法：
```php
通知中返回，只允许填写数字字符，为Dial节点的属性]
* @param [type] $record [是否录音，可填项为true和false，默认值为false不录音，为Dial节点的属性]
* @return [type] [description]
*/
public function ivrDial($number,$userdata,$record);
/**
* 话单下载
* @author 晚黎
* @date 2016-04-06T15:57:34+0800
* @param [type] $date [day 代表前一天的数据（从00:00 – 23:59）]
* @param [type] $keywords [客户的查询条件，由客户自行定义并提供给云通讯平台。默认不填忽略此参数]
* @return [type] [description]
*/
public function billRecords($date,$keywords);
/**
* 主帐号信息查询
* @author 晚黎
* @date 2016-04-06T15:58:14+0800
* @return [type] [description]
*/
public function queryAccountInfo();
/**
* 短信模板查询
* @author 晚黎
* @date 2016-04-06T15:58:45+0800
* @param [type] $templateId [模板ID]
*/
public function querySMSTemplate($templateId);
/**
* 取消回拨
* @author 晚黎
* @date 2016-04-06T15:59:15+0800
* @param [type] $callSid [一个由32个字符组成的电话唯一标识符]
* @param [type] $type [0： 任意时间都可以挂断电话；1 ：被叫应答前可以挂断电话，其他时段返回错误代码；2： 主叫应答前可以挂断电话，其他时段返回错误代码；默认值为0。]
*/
public function callCancel($callSid,$type);
/**
* 呼叫状态查询
* @author 晚黎
* @date 2016-04-06T16:00:13+0800
* @param [type] $callid [呼叫Id ]
* @param [type] $action [查询结果通知的回调url地址]
*/
public function queryCallState($callid,$action);
/**
* 呼叫结果查询
* @author 晚黎
* @date 2016-04-06T16:00:55+0800
* @param [type] $callSid [呼叫SId]
*/
public function callResult($callSid);
/**
* 语音文件上传
* @author 晚黎
* @date 2016-04-06T16:01:32+0800
* @param [type] $filename [文件名]
* @param [type] $body [二进制串]
*/
public function mediaFileUpload($filename,$body);
/**
* 子帐号鉴权
* @author 晚黎
* @date 2016-04-06T16:02:07+0800
*/
public function subAuth();
/**
* 主帐号鉴权
* @author 晚黎
* @date 2016-04-06T16:03:45+0800
*/
public function accAuth();
}
```
## 返回值
调用任何方法后都会返回一个数组,数组中结构如下：
**请求失败**
```php
[
"resultStatus" => "0"
"errorMsg" => "result error!"
]
```
**验证错误**
```php
[
'resultStatus' => '0' ,
'errorCode' => '错误码' ,
'errorMsg' => '错误信息'
]
```
**成功**
```php
[
'resultStatus' => '1' ,
....
]
```
>成功后的返回值都不同,返回的字段参考官方API文档
## 问题反馈
如果有什么Bug，反应反馈：`[email protected]`