logo
0
0
WeChat Login

助通短信插件使用说明

插件信息

  • 名称:助通短信插件
  • 版本:v1.0.0
  • 类型:短信发送插件(使用自定义发送接口)
  • 开发商:智简魔方

功能特点

使用自定义发送接口

  • 无需预先报备模板
  • 内容灵活自定义
  • 即时发送

支持变量替换

  • 模板使用 {变量名} 格式
  • 自动替换为实际值

安全可靠

  • 密码MD5双重加密
  • 数据库加密存储

文件结构

ztsms/ ├── Ztsms.php # 插件主文件 ├── config.php # 配置文件 └── config/ └── smsTemplate.php # 默认短信模板

安装步骤

1. 上传插件

ztsms 文件夹上传到:

\public\plugins\sms\ztsms\

2. 后台安装

  1. 登录魔方后台
  2. 进入:系统设置短信通知管理
  3. 找到"助通短信"插件
  4. 点击"安装"

3. 配置插件

点击"配置",填写以下信息:

配置项说明示例
助通账号助通平台注册的账号your_username
账号密码助通平台的密码your_password
短信签名短信签名(含中文括号)【智简魔方】

4. 保存配置

点击"保存",配置完成!


使用方法

在系统中使用

  1. 进入:短信模板管理
  2. 选择要使用的模板
  3. 编辑模板内容(使用 {变量名} 格式)
  4. 保存

系统会自动使用助通短信发送!


模板变量

变量格式

使用 {变量名} 格式,例如:

您的验证码是{code},5分钟内有效

系统支持的变量

变量名说明示例
{code}验证码123456
{account}账户名zhangsan
{system_website_name}网站名智简魔方
{order_id}订单ID20240101001
{order_amount}订单金额100.00
{product_name}产品名称云服务器
{client_phone}客户手机13800138000

默认模板

插件自带以下默认模板:

  1. 验证码验证码{code},5分钟内有效!请勿泄漏于他人
  2. 用户登录您的账号{account}成功登录系统,如不是本人操作请及时修改密码
  3. 用户注册{account},感谢您支持{system_website_name}
  4. 订单创建您已下单,订单号:{order_id},请及时支付
  5. 产品开通您的产品:{product_name}已开通可使用
  6. 订单支付您的订单:{order_id}支付成功,支付金额为:{order_amount}元

...等共21个默认模板


注意事项

⚠️ 重要提醒

  1. 短信签名必填

    • 格式:【签名名称】
    • 必须使用中文括号
    • 签名会自动添加到短信内容前面
  2. 自定义发送说明

    • 使用自定义发送接口
    • 可能触发人工审核
    • 首次发送可能略有延迟
  3. 账号安全

    • 密码将加密存储
    • 建议在助通平台设置IP白名单
    • 定期更换密码
  4. 费用说明

    • 需要在助通平台充值
    • 按发送条数计费
    • 请确保余额充足

API接口说明

使用的助通API

  • 接口地址https://api-shss.zthysms.com/v2/sendSms
  • 请求方式:POST
  • 认证方式:用户名 + MD5双重加密密码

密码加密规则

tKey = 当前时间戳(秒) password = md5(md5(原始密码) + tKey)

常见问题

Q1: 发送失败,提示"用户名或密码未配置"

A: 请检查配置中是否正确填写了助通账号和密码

Q2: 发送失败,提示"签名错误"

A: 请确保签名格式为 【签名名称】,使用中文括号

Q3: 短信发送成功但未收到

A:

  • 自定义发送需要人工审核,首次可能延迟
  • 检查助通平台余额是否充足
  • 检查手机号是否正确

Q4: 如何查看发送记录

A: 登录助通平台后台查看发送明细和状态

Q5: 变量没有被替换

A: 请确保模板使用 {变量名} 格式,不是 @var(变量名)


技术支持

助通平台

智简魔方


更新日志

v1.0.0 (2024-11-05)

  • ✅ 初始版本发布
  • ✅ 支持自定义短信发送
  • ✅ 支持变量替换
  • ✅ 内置21个默认模板
  • ✅ 密码MD5双重加密

开发说明

变量格式说明

本插件使用 {变量名} 格式,而不是idcsmart的 @var(变量名) 格式。

原因:

  1. 助通API原生支持 {变量名} 格式
  2. 无需格式转换,代码更简洁
  3. 用户配置更直观

代码规范

严格遵循智简魔方开发规范:

  • 命名空间:sms\ztsms
  • 类名:大驼峰
  • 方法名:小驼峰
  • 变量名:小驼峰
  • 注释:完整的@title@desc@param@return

核心方法

方法名说明
install()插件安装,导入默认模板
uninstall()插件卸载
sendCnSms()发送国内短信(核心方法)
sendCustomSms()调用助通API
replaceTemplateParams()替换模板变量
formatSign()格式化签名

许可证

本插件遵循智简魔方插件开发协议


感谢使用助通短信插件!

About

魔方业务系统V10对接插件

Language
PHP100%