diff --git a/docs/uniCloud/send-sms.md b/docs/uniCloud/send-sms.md index e4943e0e994f70a7de81ec7f56938e0254e463ca..77494d9524db2c951ce43015a789817619b305c0 100644 --- a/docs/uniCloud/send-sms.md +++ b/docs/uniCloud/send-sms.md @@ -22,10 +22,47 @@ |smsSecret |String |是 |调用短信接口的密钥secret,从 dev.dcloud.net.cn/uniSms 后台获取 | |phone |String |是 |发送目标手机号,暂仅支持中国大陆手机号,不能填写多个手机号| |templateId |String |是 |模版Id,短信内容为固定模板,详见下方说明 | -|data |Object |是 |模版里的各个字段,json格式 | +|data |Object |是 |模版里的各个变量字段,json格式 | **参数templateId说明** +按照国家法律和运营商要求,每个要发送短信的应用,需要备案其短信模板,并且经过运营商的审核。 + +短信内容规范: +1. 不能包含涉政、黄赌毒、暴力、房产、移民、贷款、代开发票等违法内容 +2. 不能包含运营商禁止发送的内容 +3. 不能包含侵犯第三方权益的内容(如侵犯他人商标或冒名行为) +4. 营销类短信不能违法广告法 +5. 不能利用短信骚扰或诈骗用户 + +报备模板的方式:使用开发者账号邮箱发送标题为“短信服务模板报备”的邮件至 service@dcloud.io,邮件中注明应用的 appid、应用名称、短信签名、模板内容、短信类别。 + +另:近期会开通线上自助报备功能。 + +- 短信签名: +即短信内容开头的【xxx】,可选内容为App或小程序名称、网站名称、企业名称(可使用简称,但需具备辨识度)、商标名称。如`【DCloud】`,即是DCloud官方发送短信的签名。签名的作用是明确告知用户该短信由什么样的主体发送。签名内容中不能再包含括号,无论全角或半角、大中小尖、花方圆尖均不允许,如`【】、[]、{}、()、<>`。 + +- 模板内容: +短信模板必然以短信签名作为开头,其内容中允许有一定的变量,以满足灵活性需求。变量用${}包裹。 + +例如:【hello uni-app】验证码:${code},用于${action},${expMinute}分钟内有效,请勿泄露并尽快验证。 + +在实际发送短信时,在短信API中传入该模板ID,然后传入合适的变量,最终发送的短信将变为: +`【hello uni-app】验证码:123465,用于注册,15分钟内有效,请勿泄露并尽快验证。` + +- 短信类别: +分为3类,即验证码类短信、通知类短信、营销类短信。验证码类短信,其模板审核简单快速,只能单次发送。 + +**示例报备邮件** +``` +DCloud公司: +我的应用appid为xxx、应用名称为xxx。 +我已开通uniCloud短信服务,现申请为此应用报备短信模板,该模板为验证类短信模板,其内容如下: +【这里填短信签名】验证码:${code},用于${action},${expMinute}分钟内有效,请勿泄露并尽快验证。 +``` +短信模板一般在0-2个工作日内完成审核。在工作日工作时间提交模板的,审核速度会更快些。 + + + **返回值** 接口调用失败时会直接抛出错误,调用成功时才会有返回值。