<?php
//  ---------------------------------------------------------------------------------
//    _____   _             _                   _   _____
//   |  __ \ | |           | |    /\           (_) |  __ \
//   | |__) || |__    __ _ | |   /  \    _ __   _  | |__) |_ __  ___
//   |  ___/ | '_ \  / _` || |  / /\ \  | '_ \ | | |  ___/| '__|/ _ \
//   | |     | | | || (_| || | / ____ \ | |_) || | | |    | |  | (_) |
//   |_|     |_| |_| \__,_||_|/_/    \_\| .__/ |_| |_|    |_|   \___/
//                                      | |
//                                      |_|
//   PhalApi Pro 专业版
//   广州果创网络科技有限公司
//
//  ---------------------------------------------------------------------------------
//
//   一、协议的许可和权利
//    1. 您可以在完全遵守本协议的基础上，将本软件应用于商业用途；
//    2. 您可以在协议规定的约束和限制范围内修改本产品源代码或界面风格以适应您的要求；
//    3. 您拥有使用本产品中的全部内容资料、商品信息及其他信息的所有权，并独立承担与其内容相关的
//       法律义务；
//    4. 获得商业授权之后，您可以将本软件应用于商业用途，自授权时刻起，在技术支持期限内拥有通过
//       指定的方式获得指定范围内的技术支持服务；
//
//   二、协议的约束和限制
//    1. 未获商业授权之前，禁止将本软件用于商业用途（包括但不限于企业法人经营的产品、经营性产品
//       以及以盈利为目的或实现盈利产品）；
//    2. 未获商业授权之前，禁止在本产品的整体或在任何部分基础上发展任何派生版本、修改版本或第三
//       方版本用于重新开发；
//    3. 如果您未能遵守本协议的条款，您的授权将被终止，所被许可的权利将被收回并承担相应法律责任；
//
//   三、有限担保和免责声明
//    1. 本软件及所附带的文件是作为不提供任何明确的或隐含的赔偿或担保的形式提供的；
//    2. 用户出于自愿而使用本软件，您必须了解使用本软件的风险，在尚未获得商业授权之前，我们不承
//       诺提供任何形式的技术支持、使用担保，也不承担任何因使用本软件而产生问题的相关责任；
//    3. 广州果创网络科技有限公司不对使用本产品构建的商城中的内容信息承担责任，但在不侵犯用户隐
//       私信息的前提下，保留以任何方式获取用户信息及商品信息的权利；
//
//   有关本产品最终用户授权协议、商业授权与技术服务的详细内容，均由广州果创网络科技有限公司独家
//   提供。广州果创网络科技有限公司拥有在不事先通知的情况下，修改授权协议的权力，修改后的协议对
//   改变之日起的新授权用户生效。电子文本形式的授权协议如同双方书面签署的协议一样，具有完全的和
//   等同的法律效力。您一旦开始修改、安装或使用本产品，即被视为完全理解并接受本协议的各项条款，
//   在享有上述条款授予的权力的同时，受到相关的约束和限制。协议许可范围以外的行为，将直接违反本
//   授权协议并构成侵权，我们有权随时终止授权，责令停止损害，并保留追究相关责任的权力。
//
//  ---------------------------------------------------------------------------------

namespace Admin\Api;

use Base\Domain\Sms as SmsDomain;
use PhalApi\Api;

/**
 * 短信接口
 */
class Sms extends Api
{

    public function getRules()
    {
        return array(
            'aliyunSendSms' => array(
                'PhoneNumbers' => array('name' => 'PhoneNumbers', 'require' => true, 'desc' => '接收短信的手机号码。国内短信：11位手机号码，例如15951955195。国际/港澳台消息：国际区号+号码，例如85200000000。'),
                'SignName' => array('name' => 'SignName', 'require' => true, 'desc' => '短信签名名称。可在阿里云控制台签名管理页面签名名称一列查看。例如：阿里云'),
                'TemplateCode' => array('name' => 'TemplateCode', 'require' => true, 'desc' => '短信模板ID。可在阿里云控制台模板管理页面模板CODE一列查看。例如：SMS_153055065'),
                'TemplateParam' => array('name' => 'TemplateParam', 'type' => 'array', 'format' => 'json', 'desc' => '短信模板变量对应的实际值，JSON格式。例如：{"code":"1111"}'),
            ),
            'aliyunQuerySendDetails' => array(
                'CurrentPage' => array('name' => 'CurrentPage', 'type' => 'int', 'min' => 1, 'default' => 1, 'desc' => '分页查看发送记录，指定发送记录的的当前页码。'),
                'PageSize' => array('name' => 'PageSize', 'type' => 'int', 'min' => 1, 'max' => 50, 'default' => 10, 'desc' => '分页查看发送记录，指定每页显示的短信记录数量。取值范围为1~50。'),
                'PhoneNumber' => array('name' => 'PhoneNumber', 'require' => true, 'desc' => '接收短信的手机号码。格式：<ul><li>国内短信：11位手机号码，例如15900000000。</li><li>国际/港澳台消息：国际区号+号码，例如85200000000。</li></ul>'),
                'SendDate' => array('name' => 'SendDate', 'require' => true, 'desc' => '短信发送日期，支持查询最近30天的记录。格式为yyyyMMdd，例如20181225。'),
            ),
            'checkSmsCaptcha' => array(
                'mobile' => array('name' => 'mobile', 'require' => true, 'min' => 11, 'max' => 11, 'desc' => '国内手机号，11位'),
                'code' => array('name' => 'code', 'require' => true, 'min' => 4, 'max' => 6, 'desc' => '4位到6位的数字验证码'),
            ),
        );
    }

    /**
     * 阿里云发送短信接口
     * @desc 通过阿里云的<a style="color:red;display:inline;" href="https://help.aliyun.com/document_detail/101414.html?spm=a2c4g.11186623.6.616.3caf2e798CoiXF">SendSms</a>发送短信。使用前请修改./config/app.php配置文件中的aliYun配置。
     * @return string BizId 发送回执ID，可根据该ID在接口QuerySendDetails中查询具体的发送状态。
     * @return string Code 请求状态码。返回OK代表请求成功。Config Error代表缺少配置。其他错误码详见<a href="https://help.aliyun.com/document_detail/101346.html?spm=a2c4g.11186623.2.14.69ba56e0biijqs">错误码列表</a>。
     * @return string Message 状态码的描述。
     * @return string RequestId 请求ID。
     */
    public function aliyunSendSms()
    {
        $sms = new SmsDomain();
        return $sms->aliyunSendSms($this->PhoneNumbers, $this->SignName, $this->TemplateCode, $this->TemplateParam);
    }

    /**
     * 阿里云查看短信发送记录和发送状态
     * @desc 通过阿里云的<a href="https://help.aliyun.com/document_detail/102352.html?spm=a2c4g.11186623.6.618.7fc6202aeksfQD">QuerySendDetails</a>接口查看短信发送记录和发送状态。使用前请修改./config/app.php配置文件中的aliYun配置。
     * @return string Code 请求状态码。返回OK代表请求成功。Config Error代表缺少配置。其他错误码详见<a href="https://help.aliyun.com/document_detail/101346.html?spm=a2c4g.11186623.2.14.69ba56e0biijqs">错误码列表</a>。
     * @return string Message 状态码的描述。 
     * @return string RequestId 请求ID。
     * @return object SmsSendDetailDTOs 短信发送明细。
     * @return string TotalCount 短信发送总条数。
     */
    public function aliyunQuerySendDetails() {
        $sms = new SmsDomain();
        return $sms->aliyunQuerySendDetails($this->CurrentPage, $this->PageSize, $this->PhoneNumber, $this->SendDate);
    }

    /**
     * 校验短信验证码
     * @desc 接口发送短信验证码。验证码将在15分钟内有效，可尝试5次，成功校验的失败。使用前请修改./config/app.php配置文件中的aliYun配置。
     * @return code 操作码，0成功，1验证码不存在或已过期，2验证码已失效（失败次数过多），3验证码错误
     * @return string msg 检验信息
     */
    public function checkSmsCaptcha() {
        $rs = array('code' => 0, 'msg' => \PhalApi\T('succeed to verify'));

        $sms = new SmsDomain();
        $rs['code'] = $sms->suppilerCheckSmsCaptcha($this->mobile, $this->code, $rs['msg']);

        return $rs;
    }
}
