业务系统开发文档>短信接口开发文档

fig.php (配置项客户配置项，在插件设置中显示) 三、开发流程以智简魔方官方短信平台接口为例:1、创建实名认证目录\public\plugins\sms\idcsmart\；①目录名以小写字母+下划线形式，必须以字母开头，如idcsmart； 2、创建入口文件:Idcsmart.php：①命名空间namespace sms\idcsmart(控制器下命名空间对应相应目录即可,其它同理);②以目录名大驼峰+.php，创建在短信接口根目录下，如idcsmart\Idcsmart.php；③文件中需要定义info属性，示例：# 基础信息public $info = array( 'name' => 'Idcsmart',//Demo插件英文名，改成你的插件英文就行了 'title' => '智简魔方', 'description' => '智简魔方官方短信平台接口', 'status' => 1, 'author' => '智简魔方', 'version' => '1.0.1', 'help_url' => 'https://my.idcsmart.com/goods.htm?id=922',//申请接口地址);④必须实现install()安装以及uninstall()卸载方法，没有额外操作，返回true即可；⑤需要实现以下方法方法名称描述参数返回getCnTemplate获取国内模板template_id：模板ID；config：自定义配置；示例：['template_id'=>1,'config'=>{}]；status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"]createCnTemplate创建国内模板title：模板标题；content：模板内容；config：自定义配置；示例：["title"=>"test","content"=>"测试内容","config"=>{"key"=>"value"}]status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"] putCnTemplate修改国内模板title：模板标题；content：模板内容；config：自定义配置；示例：["title"=>"test","content"=>"测试内容","config"=>{"key"=>"value"}]status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"] deleteCnTemplate删除国内模板template_id：模板ID；config：自定义配置；示例：['template_id'=>1,'config'=>{}]；status：状态，success成功，error失败；成功示例：["status"=>"success"]；失败示例：["status"=>"error","msg"=>"模板ID错误"] sendCnSms发送国内短信mobile：手机号；content：模板内容；config：自定义配置；template_id：模板ID；templateParam：模板参数，参考附表1示例：["mobile"=>"129483782423","content"=>"测试内容","config"=>{"key"=>"value"},'template_id'=>1,'templateParam'=>1]status：状态，success成功，error失败；content：已替换参数的模板内容；msg：错误信息成功示例：["status"=>"success","content"=>"测试内容"]；失败示例：["status"=>"error","msg"=>"模板ID错误","content"=>"测试内容"] getGlobalTemplate获取国际模板template_id：模板ID；config：自定义配置；示例：['template_id'=>1,'config'=>{}]；status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"]createGlobalTemplate创建国际模板title：模板标题；content：模板内容；config：自定义配置；示例：["title"=>"test","content"=>"测试内容","config"=>{"key"=>"value"}]status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"] putGlobalTemplate修改国际模板title：模板标题；content：模板内容；config：自定义配置；示例：["title"=>"test","content"=>"测试内容","config"=>{"key"=>"value"}]status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"] deleteGlobalTemplate删除国际模板template_id：模板ID；config：自定义配置；示例：['template_id'=>1,'config'=>{}]；status：状态，success成功，error失败；成功示例：["status"=>"success"]；失败示例：["status"=>"error","msg"=>"模板ID错误"] sendGlobalSms发送国际短信mobile：手机号；content：模板内容；config：自定义配置；template_id：模板ID；templateParam：模板参数，参考附表1示例：["mobile"=>"129483782423","content"=>"测试内容","config"=>{"key"=>"value"},'template_id'=>1,'templateParam'=>1]status：状态，success成功，error失败；content：已替换参数的模板内容；msg：错误信息成功示例：["status"=>"success","content"=>"测试内容"]；失败示例：["status"=>"error","msg"=>"模板ID错误","content"=>"测试内容"] 3、创建默认短信模板①在插件根目录下创建config/smsTemplate.php文件；②文件内容返回一个数组即可，如下：return [ [ 'title' => '验证码', 'content' => '验证码@var(code),5分钟内有效！请勿泄漏于他人', 'name'=>'code' ],]title标题；content内容，带参数；name为系统模板标识，唯一；③系统默认模板参考附表2；④在install安装中返回模板数组，系统会自动创建模板； 4、到后台短信通知管理，可以查看接口列表，安装、配置即可使用。四、示例参考智简魔方官方短信平台接口idcsmart 五、附附表1、templateParam参数列表（国际国内参数一样）参数名描述类型示例system_website_name系统网站名系统智简魔方system_website_url系统网站地址系统www.idcsmart.comorder_id订单ID订单125order_create_time订单创建时间订单1707094285order_amount订单金额订单1.00product_name产品名称（包括商品名和主机名）产品测试-ser23142123product_marker_name商品名称产品测试product_first_payment_amount产品首付金额产品100.00product_renew_amount产品续费金额产品100.00product_binlly_cycle产品周期产品计费周期免费free，一次onetime，周期先付recurring_prepayment,周期后付recurring_postpaidproduct_active_time产品激活时间产品1707094285product_due_time产品到期时间产品1707094285product_suspend_reason产品暂停原因产品到期暂停renewal_first续费X天后到期第一次提醒产品1renewal_second续费X天后到期第二次提醒产品2client_register_time客户注册时间客户1707094285client_username用户名客户testclient_email邮件客户135460@qq.comclient_phone手机号客户16548765643client_company公司客户智简魔方client_last_login_time最后登录时间客户1707094285client_last_login_ip最后登录ip客户122.32.13.3account账户名客户test 附表2、系统默认短信模板（以下模板内容为官方短信平台模板内容，使用需修改）系统模板标识（name）模板标题（title）模板类型模板内容（content）示例code验证码系统验证码@var(code),5分钟内有效！请勿泄漏于他人client_login_success用户登录客户您的账号@var(account)成功登录系统，如不是本人操作请及时修改密码client_register_success用户注册客户@var(account)，感谢您支持@var(system_website_name)client_change_phone客户更改手机客户您的手机号被改为：@var(client_phone)，请注意账户安全client_change_password客户更改密码客户您的密码被改为：@var(client_password)，请注意账户安全order_create订单创建订单您已下单，订单：@var(order_id)（订单号），请及时支付host_pending产品开通中产品您的产品：@var(product_name)（产品名称）正在开通，请耐心等待host_active开通成功产品您的产品：@var(product_name)（产品名称），已开通可使用host_suspend产品暂停通知产品您的产品：@var(product_name)（产品名称），由于@var(product_suspend_reason)，已停用host_unsuspend产品解除暂停通知产品您的产品：@var(product_name)（产品名称），已解除暂停host_terminate产品删除通知产品您的产品：@var(product_name)（产品名称），由于到期未续费，已删除host_upgrad产品升降级产品您已成功升级产品@var(product_name)，感谢您的支持host_renewal_first第一次续费提醒产品您的产品：@var(product_name)（产品名称），还有@var(renewal_first)天到期，请及时续费host_renewal_second第二次续费提醒产品您的产品：@var(product_name)（产品名称），还有@var(renewal_second)天到期，请及时续费host_overdue_first逾期付款第一次提醒产品您的产品：@var(product_name)（产品名称）已到期，将会删除，请及时续费host_overdue_second逾期付款第二次提醒产品您的产品：@var(product_name)（产品名称）已到期，将会删除，请及时续费host_overdue_third逾期付款第三次提醒产品您的产品：@var(product_name)（产品名称）已到期，将会删除，请及时续费order_overdue订单未付款通知订单您的订单：@var(order_id)（订单号）尚未支付，金额@var(order_amount)，请及时支付admin_order_amount订单金额修改订单您的订单：@var(order_id)（订单号）金额修改为@var(order_amount)，请及时支付order_pay订单支付通知订单您的订单：@var(order_id)（订单号）支付成功，支付金额为：@var(order_amount)元order_recharge充值成功通知订单充值成功，本次充值金额为：@var(order_amount)元

业务系统开发文档>插件开发

fo属性，示例：# 插件基本信息public $info = array( 'name' => 'IdcsmartTicket', //插件英文名,作为插件唯一标识,改成你的插件英文就行了 'title' => '智简魔方工单插件', //插件名称 'description' => '智简魔方工单插件', //插件描述 'author' => 'idcsmart', //开发者 'version' => '1.0', // 版本号);④必须实现install()安装以及uninstall()卸载方法⑤可实现钩子方法，如要实现订单创建后钩子after_order_create，则可在此文件中创建public function afterOrderCreate($param)公共方法；⑥系统会在订单创建后的位置放置⑤中的钩子，放置方式：hook(‘after_order_create’,[‘id’=>$orderId]) ；⑦如果定义变量noNav，表示不需要默认导航(具体参考7,插件后台导航)public $noNav; 3、创建插件后台控制器 idcsmart_ticket\controller\TicketController.php①命名空间addon\idcsmart_ticket\controller；②继承后台基类控制器PluginAdminBaseController，增加了权限控制，允许使用一些通用方法；③get_admin_id()可获取后台管理员登录ID；④实现接口，如public function ticketList()，系统默认访问此接口的url为：网站地址/admin/addon?_plugin=idcsmart_ticket&_controller=ticket&_action=ticket_list，说明：系统默认地址默认登录，若需要免登录访问，需要自定义路由(见后面自定义路由)；⑤系统提供了生成④中默认访问地址的方法：idcsmart_addon_url($url,$vars=[],$is_admin=false)参数说明：url: 格式：插件名://控制器名/方法，如 IdcsmartTicket://Ticket/ticketListvars: 参数，默认为空数组Is_admin: 是否后台，默认为false 4、创建插件前台控制器idcsmart_ticket\controller\clientarea\TicketController.php①命名空间addon\idcsmart_ticket\controller\clientarea；②继承前台基类控制器PluginBaseController，允许使用一些通用方法；③get_client_id()可获取前台客户登录ID；④实现接口，如public function ticketList()，系统默认访问此接口的url为：网站地址/console/addon?_plugin=idcsmart_ticket&_controller=ticket&_action=ticket_list或者：网站地址/console/addon?_plugin=1&_controller=ticket&_action=ticket_list，1表示插件ID；说明：系统默认地址默认登录，若需要免登录访问，需要自定义路由(见后面自定义路由)；⑤系统提供了生成④中默认访问地址的方法：idcsmart_addon_url($url,$vars=[],$is_admin=false)参数说明：url: 格式：插件名://控制器名/方法，如 IdcsmartTicket://Ticket/ticketListvars: 参数，默认为空数组Is_admin: 是否后台，默认为false 5、插件提供两种路由：①、系统默认url带参数，参考4②、自定义路由，插件根目录下定义route.php，示例：前台路由：Route::group('console/v1',function (){Route::get('ticket',"\\addon\\idcsmart_ticket\\controller\\clientarea\\TicketController@ticketList")->append(['_plugin'=>'idcsmart_ticket','_controller'=>'ticket','_action'=>'ticket_list']);# 带上默认参数,可以使用继承控制器app\admin\controller\PluginBaseController的一些通用方法,也可以不追加这些参数(_plugin插件名称C风格,_controller控制器名称C风格,_action方法名称C风格)})->middleware(\app\http\middleware\ParamFilter::class)->middleware(\app\http\middleware\CheckHome::class);#前台需要登录就使用此中间件后台路由：Route::group(DIR_ADMIN . '/v1',function (){ Route::get('ticket',"\\addon\idcsmart_ticket\controller\TicketController@ticketList")->append(['_plugin'=>'idcsmart_ticket','_controller'=>'ticket','_action'=>'ticket_list']);})->middleware(\app\http\middleware\ParamFilter::class)->middleware(\app\http\middleware\CheckAdmin::class);#后台需要登录就使用此中间件 6、插件多语言①创建语言文件lang/zh-cn.php，返回如下格式的数组:return [ 'success_message' => '请求成功', 'ticket_title_require' => '请输入工单标题','ticket_log_client_create_ticket' => '{client}新建工单:{ticket_id}',] ②使用lang_plugins('语言标识',$param=[])实现多语言，$param为语言文件中参数，格式['{client}'=>'wyh'],如：lang_plugins('ticket_log_client_create_ticket',['{client}'=>'wyh','{ticket_id}'=>1]);③前端多语言文件前台语言文件：在template/clientarea/lang/目录下index.js文件；后台语言文件：在template/admin/lang目录下(function () { const module_lang = { "zh-cn": { add: "添加", }, "zh-hk": { add: "添加", }, "en-us": { add: "Add", }, }; const DEFAULT_LANG = localStorage.getItem("backLang") || "zh-cn"; window.module_lang = module_lang[DEFAULT_LANG];})(); 具体参考idcsmart_ticket工单插件 7、插件后台导航①导航默认会创建在插件导航之下,默认链接：plugin/插件名/index.html，对应template/admin/index.php文件,同时需要在lang/下的语言文件创建如下格式的语言,nav_plugin_addon_插件名:'nav_plugin_addon_idcsmart_ticket' => '工单', ②自定义导航，若是一级导航，会增加在插件导航之上，管理导航之下，在插件根目录下创建sidebar.php，示例：/* * 自定义后台导航菜单(仅支持一二级),注意系统会在插件导航下默认创建url为"plugin/插件名称/index.html"的导航,因此需要在template/admin/目录下创建index.php文件作为插件入口 */return [ [ # 一级导航 'name' => 'nav_plugin_addon_ticket', # 导航名称,不要与系统冲突(参考idcsmart_nav表中name字段),同时需要在lang/目录下定义语言 'url' => '', # 为空表示一级导航,不需要链接 'icon' => 'tools', # 图标,获取图标:https://tdesign.tencent.com/vue/components/icon 'in' => '', # 一级导航,此值为空 'child' => [ # 二级导航 [ 'name' => 'nav_plugin_addon_ticket_list', # 导航名称 'url' => 'ticket', # 链接格式,会自动加上.html 'in' => 'nav_user_management', # 可定义导航在某个一级导航之下,默认会放置在此一级导航最后的位置(获取方式:idcsmart_nav表中的parent_id==0的name字段) 'icon' => '', # 图标,获取图标:https://tdesign.tencent.com/vue/components/icon ], [ 'name' => 'nav_plugin_addon_ticket_internal_list', # 导航名称 'url' => 'ticket_internal', # 链接格式,会自动加上.html 'in' => '', # 可定义导航在某个一级导航之下,默认会放置在此一级导航最后的位置 'icon' => '', # 图标,获取图标:https://tdesign.tencent.com/vue/components/icon ], ] ],]; 8、插件前台导航①导航默认会创建在插件导航之下,默认链接：plugin/插件名/index.html；②自定义导航，会增加在插件导航之上，管理导航之下，在插件根目录下创建sidebar_clientarea.php，示例：/* * 自定义前台导航菜单(仅支持一二级) */return [ [ 'name' => 'nav_plugin_addon_ticket', # 链接名称,同时需要在lang/目录下定义语言 'url' => '', # 链接格式,会自动加上.html 'icon' => '', # 图标 'child' => [ # 二级菜单 [ 'name' => 'nav_plugin_addon_ticket_list', 'url' => 'ticket', 'icon' => '', # 图标 ], ] ],]; 9、插件后台权限管理在插件根目录下创建auth.php，示例如下（注意定义语言）：<?php/* * 定义权限,系统会默认插入名称为插件名的一级权限,以下仅需定义二级/三级权限;(首先，要使用二级权限，插件后台控制器需要继承app\event\controller\PluginAdminBaseController基类控制器) */return [ [ 'title' => 'auth_plugin_addon_ticket_list', # y用户工单 'url' => 'ticket', 'child' => [ # 操作权限 [ 'title' => 'auth_plugin_addon_ticket_view', # 工单查看 'url' => '', 'auth_rule' => 'TicketController::ticketList', # 工单列表具体控制器方法 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_list' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_receive', 'url' => '', 'auth_rule' => 'TicketController::receive', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_receive' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_resolved', 'url' => '', 'auth_rule' => 'TicketController::resolved', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_resolved' # 具体权限名称 ], ] ], [ 'title' => 'auth_plugin_addon_ticket_detail', # 工单详情 'url' => 'ticket_detail', 'child' => [ [ 'title' => 'auth_plugin_addon_ticket_view', 'url' => '', 'auth_rule' => 'TicketController::index', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_index' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_reply', 'url' => '', 'auth_rule' => 'TicketController::reply', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_reply' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_download', 'url' => '', 'auth_rule' => 'TicketController::download', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_download' # 具体权限名称 ], ] ], [ 'title' => 'auth_plugin_addon_ticket_internal_list', # 内部工单 'url' => 'ticket_internal', 'child' => [ [ 'title' => 'auth_plugin_addon_ticket_view', 'url' => '', 'auth_rule' => 'TicketInternalController::ticketInternalList', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_internal_list' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_view', 'url' => '', 'auth_rule' => 'TicketInternalController::index', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_internal_index' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_add', 'url' => '', 'auth_rule' => 'TicketInternalController::create', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_internal_create' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_receive', 'url' => '', 'auth_rule' => 'TicketInternalController::receive', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_internal_receive' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_resolved', 'url' => '', 'auth_rule' => 'TicketInternalController::resolved', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_internal_resolved' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_reply', 'url' => '', 'auth_rule' => 'TicketInternalController::reply', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_internal_reply' # 具体权限名称 ], [ 'title' => 'auth_plugin_addon_ticket_forward', 'url' => '', 'auth_rule' => 'TicketInternalController::forward', 'auth_rule_title' => 'auth_rule_plugin_addon_ticket_internal_forward' # 具体权限名称 ], ] ],]; 10、插件接口内部调用使用plugin_api($addon,$controller,$action,$param=[])函数可内部调用插件API,需要开发者提供插件API开发文档，具体格式参考系统API文档 * @param string addon - 插件 require * @param string controller - 控制器前缀 require * @param string action - 方法 require * @param array param - 传入的参数四、示例具体可参考智简魔方工单插件public\plugins\addon\idcsmart_ticket\