更新日期

1. 简介

1.1 功能概述

腾讯云短信通知插件通过对接腾讯云短信服务,满足英雄云用户关于短信通知方面业务的需求。支持向多个手机号发送通知,支持发送状态回显,发送计费等。

1.2 插件说明

2. 腾讯云信息配置

2.1 创建/登录账户

注册并登录腾讯云控制台(如无账号需要先注册),登录成功后在下图所示的实名认证“实名认证”操作。
注:仅实名认证通过的腾讯云账户,才能接入短信服务。认证主体后期可更改。
进入腾讯云控制台。

2.2 获取授权信息

获取SecretId 和 SecretKey用于3.2的插件配置。
点击右上角头像框,在弹出框中点击并进入“访问管理”。
在“访问管理>>访问密钥>>API密钥管理”中新建密钥并保存SecretId 和 SecretKey。

2.3 获取短信服务相关参数

在“搜索栏”输入“短信”,点击并进入“短信”控制台入口。
2.3.1 新增资质
进入“国内短信>>实名资质管理>>新增资质”,根据企业自身信息填写内容并完成提交。
2.3.2 创建签名
进入“国内短信>>签名管理”,点击“创建签名”。
根据企业的业务需求设置信息,这里需要录入“资质信息”、“签名用途”、“签名类型”、“签名内容”等。
2.3.3 创建正文模版
进入“国内短信>>模版管理”,点击“添加模版”。
设置模版需要的信息,如模版名称、短信类型、短信内容等,可以设置短信变量,以固定格式{数字},如{1}对变量进行命名。同一模板中,如果存在多个变量,须从1开始连续编号,如{1}、{2}等。
本文的案例是对用户成功认证结果的通知,案例的变量认证类型设置为{1},变量命名规则可参考腾讯云正文模版审核标准
2.3.4 创建应用
在“短信>>应用管理>>应用列表”,点击创建应用完成后,将获取的【SDKAppID】保存。

3. 插件安装与启用

3.1 插件安装

在工作台中的“为您推荐”组件中,选择“精选插件”,点击右下角的“进入开放平台”,即可进入英雄云插件页面。
点击“插件市场”,选择“腾讯云-短信通知”,进入插件详情页。
进入插件详情页后点击“安装”即可安装插件。在插件详情页中,用户还可以查看该插件的付费方案以及使用演示视频。

3.2 插件配置和启用

插件安装完成后,需要启用插件,才能在表单中正常使用。
点击“插件管理”,在“已安装插件”中找到刚安装的插件。点击设置按钮,将2.2中获取的SecretId 和 SecretKey录入插件配置。
调整插件配置后,在状态设置处点击启用该插件。

4. 表单搭建

4.1 搭建认证记录表单

这里使用英雄云认证结果通知进行演示,使用一个认证记录表单放置用户认证信息。表单设计如下图所示:

4.2 搭建腾讯云短信通知模板表单

新建表单【腾讯云短信通知插件示例】用于发送短信。添加子表单用于放置短信变量值,子表单命名为“模板变量参数”,在子表单中加入“变量名”和“变量值”两个字段。
设置“模板变量参数”子表单的默认值,新增变量名“认证类型”、“认证客户端”,若有更多的参数可以参考,填写表单时在变量值列中键入对应的值,即可以将模板参数变量值以数组形式上传。
针对“认证类型”和“认证客户端”分别新增单行文本字段用于对认证记录进行筛选,并使用公式拿取子表单中的对应值。筛选字段为辅助字段,可设置为不可见。
新增子表单用于选择认证记录,并加入选择数据子字段。
对选择数据设置数据过滤条件,筛选条件分别与筛选辅助字段对应上。
设置选择数据字段的数据填充规则,选择必要的显示字段,选择填充到新字段。
点击完成后,可以看到在子表单中会新增对应的填充字段。
新增子表单用于记录返回的短信发送详细记录,需要在该表单中增加“发送号码”、“发送状态码”、“描述”、“短信消耗条数”。其中“短信消耗条数”用于计算发送消耗的总短信条数,因此需要以数字输入框类型字段,并设置默认值为0。其他使用单行文本类字段即可。
新增数字输入框字段“总花费短信条数”用于计算本次群发消耗的腾讯云平台短信总条数。设置默认值为公式编辑,打开编辑公式窗口。
输入如图公式实现计算。

5. 前端事件配置

5.1 添加按钮

搭建好表单后,需要在“表单属性”中配置前端事件。
点击右上角“保存”按钮保存表单后,新增按钮字段,在字段属性栏配置好按钮标题、按钮文字,并点击“设置”,打开执行动作设置窗口。
点击右上角的“+添加执行动作”,进入前端事件设置页面。

5.2 设置前端事件

5.2.1 事件名称与说明
用户可以根据企业需求自定义事件名称与说明,便于用户在使用时区分各前端事件。
5.2.2 触发插件
触发插件就是当前前端事件需要使用的插件。此处选择“腾讯云短信通知”。
5.2.4 插件发送参数
插件发送参数就是调用插件时输入的数据。点击参数名称旁边的问号可以查看参数的帮助信息。可以通过字段值选择表单字段作为参数或者自定义输入。
  • “手机号”就是要发送的手机,可以是多个手机号码,需要使用子表单字段传入手机号数组,此处使用“认证用户信息,手机号码”表单字段值作为字段值,注意腾讯云短信发送的手机号都必须加上国际区号(国内区号+86);
  • “应用ID”指在腾讯云控制台“短信>>应用管理>>应用列表”中创建应用的【SDKAppID】,参考本文档2.3.4;
  • “短信签名”指在腾讯云控制台创建的短信签名内容,可登录腾讯云控制台在“国内短信>>签名管理”列表中查看;
  • “短信模版ID”指在腾讯云控制台创建的短信正文模板ID,可登录腾讯云控制台在“国内短信>>正文模板管理”列表中查看;
  • “模板参数”指2.3.3中创建短信正文模板时设置的短信变量,上传的参数值必须使用子表单字段以数组形式传入,传入参数值必须与短信模板中变量数量和顺序一致。
  • “国际/港澳台短信 Sender ID”——国内短信或默认使用公共 SenderId发送国际/港澳台短信的,无需填写该项,国际/港澳台短信已申请独立 SenderId 需要填写该字段。详细可查看 国际/港澳台短信 Sender ID 说明
5.2.5 数据填充
数据填充是指当插件被调用并返回查询结果后,系统自动将获取到的数据填入当前表单的对应字段中。
点击“新增”可在返回信息中选择“请求状态码”、“返回错误码”、“发送列表”、“RequestId”等,或者点击全选查看所有返回信息。“请求状态码”、“返回错误码”用于返回此次请求发送的结果,是否成功发送,发生什么错误等。“RequestID”用于标识此次请求,发生错误时,可以使用“RequestId”、“请求状态码”、“返回错误码”到腾讯云平台提工单进行咨询。“发送列表”用于返回每条短信的发送结果和消耗短信条数。
选择好所需要的返回信息之后,对“请求状态码”、“返回错误码”、“RequestId”可以使用默认的“填充到新字段”选项,保存后表单会自动新增同名字段以存储返回信息,对“发送列表”的子表字段,则需要手动设置填充到“发送记录”中的子表单字段。
5.2.6 保存或调试
设置好前端事件后,用户可以选择直接保存前端事件,或选择保存并调试前端事件。
更多前端事件操作详见:前端事件

6. 效果演示