短信使用手册
更新时间: 2022/08/02 10:53:58
1 介绍
1.1 云信短信介绍
网易短信功能具体有全网覆盖、3-5 秒可达、超高到达率、7*24 小时服务监控等优势。
1.2 云信短信组成
云信目前可提供的短信类型如下:验证码短信、通知类短信、运营类短信、语音验证码短信和国际短信,其中短信验证码短信可提供验证码生成服务。每条云信短信由短信签名+短信模版内容组成,短信长度限制为 500字。
1.2.1 云信短信模版
1、 模版分为三种,验证码模版(含语音验证码类和国际类)、通知类模版、运营类模版,其中验证码模版中的验证码可以由云信生成;
2、 网易云信提供的模板短信由固定内容与多个变量构成,其中 " %s " 为需要接口替换的变量,变量内容可以是汉字、字母、数字组合,但单个变量内容长度不得超过30个字,一条模板短信中变量数量不限制,总字数限制 500 字内;
3、 审核通过的短信模版,重新修改模版内容后,在审核期间可以发送老的模版内容;
4、 每个应用中每种类型的短信模版分别可以创建 400 条模版;
5、 验证码模版由固定内容和一个验证码变量"%s"构成,验证码由网易云信生成或由开发者自行定义;
6、 验证码短信模版必须包含“验证码”关键字,运营类短信模版必 须包含“退订”关键字;
7、 验证码模版中的验证码默认有效时间为 10 分钟,单个手机号码短信接收次数为 10 次,如需修改可在验证码模版类别中修改;
8、 "【云短信】"为云信系统默认提供的短信签名,在设置短信模板内容中不需要再填写短信签名。如需修改短信签名,可以通过短信签名功能修改;
9、 短信模板必须配置短信签名,否则无法发送;
1.2.2 短信签名
1、短信签名建议为用户真实应用名/网站名/公司名,提交后需审核;
2、每种类型的短信模版创建一个短信签名,一个应用最多有三个短信签名;
3、云信的默认短信签名为:【云短信】,单个签名长度介于 3 到 8 个字符之间;
4、不能含违禁关键词,不能有其他特殊符号(如-.+#);
5、无须添加【】、()、[]符号,短信发送会自带【】、()、[]符号,避免重复;
6、模板内容如侵犯到第三方权益须获得第三方的授权,并将授权委托凭证上传管理中心; 凭证上传路径:登陆-管理中心-选择相对应的应用-短信-添加签名-签名用途选择:企业使用, 签名用于非自有产品-下载授权书模板-填写对应信息提交凭证扫描件审核。
1.2.3 计费规则
云信短信计费包括短信签名,70 字以内按1条短信计费,超过 70 字则以 67 字每条计费,当短信中出现中文字符,则单个汉字、英文、标点和空格等都算一个字。
2 短信接入
2.1 接入说明
1、短信服务属于收费功能,用户可按照自己的使用量自助购买短信条数;
2、对接收方手机号码限制 1 天最多 10 条短信验证码;
3、提供验证码发送方 deviceId 参数,调用方选填。填写效果如下:一个 deviceId 默认一天发送 10 条验证码,如需修改可在短信配置中修改,最多不超过 25 条;
4、对同一个接收方手机号码,一分钟最多接受 3 条相同的短信, 超过后可能被运营商拦截;
5、对同一个接收方手机号码,一天最多接受 5 条相同的短信,超过后可能被运营商拦截;
6、验证码有效时间默认为 10 分钟,如需修改可在短信配置中修改,单位秒,最长不超过120 分钟;
7、对一个手机号码的验证调用,连续校验错误 10 次以后,该验证码立即失效,校验错误接口返回中需告知开发者当前错误次数;
8、对未发送短信验证码的手机号码验证调用,一天累计超过 1 万次会视为恶意攻击,将暂停该 appkey 的短信验证码服务,一旦发生此情况请联系客户顾问;
9、云信短信通道分为通道验证码短信、通知类短信通道和运营类短信通道,在调用短信验证码接口时可以同时调用校验验证码接口进行验证码校验。用户使用短信模版来发送短信则只需调用发送模版短信接口即可。
2.2 接入步骤
开发者接入云信短信一共需要 6 个步骤,其中验证码短信、通知类短信、运营类短信的签名必须配置。
- Step1 注册认证
- Step2 创建应用
- Step3 开通短信功能
- Step4 申请短信签名
- Step5 创建短信模版
- Step6 调用接口正式使用
发送短信验证码接口
、校验验证码接口
、查询模板短信发送状态接口
,这三个接口是按用户 自身需求调用,云信短信提供的验证码模版接口只需要用户定义一个参数,云信将帮您生成验证码,无需用户开发验证码生成功能,大大降低了开发成本。
2.2.1 Step1 注册云信账号
用 户 接 入 云 信 短 信 功 能 , 首 先 需 要 用 户 在 官 网 注 册 云 信 账 号 ,官网地址
2.2.2 Step2 创建应用
由于网易短信功能是和用户创建的应用挂钩的,故首先需要创建应用,然后在应用中开通短信功能。
注:开通短信功能必须保证账户短信条数大于 0 条。
2.2.3 Step3 开通短信功能
用户在功能管理-未开通功能中选择短信功能来开通短信功能。
2.2.4 Step4 申请短信签名
验证码模板、运营类模板、通知类模板必须配置短信签名,否则无法发送,用户可以在短信模版功能中选择对应的短信类型创建相应的短信签名。
2.2.5 Step5 创建短信模版
开通短信功能后,用户需要创建短信模版,目前云信提供验证码短信模版(含语音验证类和国际类)、通知类短信模版和运营类模版供用户选择。
用户创建好短信模版,管理员审核通过后,用户可以调用发送模版短信接口,调试成功后就可以使用短信功能了。
校验验证码、查询模板短信发送状态,这两个接口是有需求的话按用户自身需求调用。用户开通短信功能后,在短信栏目中创建短信模版,操作如下
2.3 云信短信模版
2.3.1 验证码短信模版
云信验证码模版是云信提供的特色功能,目前市面上提供的模版验证码都需要用户方去生成,这样需要用户制定验证码生成规则,而使用云信验证码模版,用户只要传一个参数”%s”用来代替验证码,而这个验证码由云信帮用户生成,大大降低了用户接入成本和开发成本,强烈推荐用户使用。
校验短信验证码模版调用接口为“校验验证码” ,文档地址
使用场景:
云信验证码模版可用到的场景很多,例如注册时发送验证码短信、登录时发送验证码短信、找回/修改密码时发送验证码短信、绑定银行/实名认证时发送验证码短信等。验证码模版接入步骤:
接口调用请参考云信短信服务开发者文档,文档地址
2.3.2 通知类短信模版
云信短信服务是云信提供的专业短信通知到达服务,用户可以使用多个参数“%s”来替换内 容,云信通知类模版每个应用最多可以创建 400 条。
使用场景:
云信通知类模版可用到的场景很多,例如:
- 服务通知: 用户触发事件动作后,商家或者平台后台系统自动触发服务通知,比如服务开通、审核结果通知、报告结果反馈、刷卡消费通知等;
- 物流通知:网购发货或者用户寄件以后,有商家或者物流公司发送发货通知、收货提醒等短信;
- 出票通知:O2O 配送、优惠券下发、航班信息、景区出票通知等等;
- 付款回执:用户进行充值、付款、转账、缴费、退款等行为后,系统实时发送短信提醒给用户;
- 活动确认:在线发起活动、活动报名、作品提交等环节,系统通过短信实时反馈给用户结果;
- 系统通知:系统运行状态通知、任务执行结果、优惠信息、维护公告、节假日问候等消息通过系统发送给用户。
通知类模版接入步骤:
接口调用请参考云信短信服务开发者文档,文档地址
2.3.3 运营类短信模版
云信可提供运营类文字短信服务,三网合一的高质量专用通道,金融级安全保护;适用于会员服务、客户关怀、新品上线等使用场景。
使用场景:
云信运营类模版可用到的场景很多,例如:
- 会员服务:定期给会员用户发送活动信息;
- 客户关怀:节假日给客户发送关怀短信;
- 新品上线:在有最新优惠信息、新功能上线时,实时通知用户。
通知类模版接入步骤:
接口调用请参考云信短信服务开发者文档,文档地址 。
2.4 短信签名
1、“短信签名”可以是您的公司简称、品牌名或网站名,提交后需审核;
2、短信签名建议为应用名。若签名/模板内容侵犯到第三方权益须获得第三方的真实授权;
3、单个签名长度介于 2 到 30 个字符之间;
4、无须添加【】、()、[]符号,短信发送会自带【】、()、[]符号,避免重复;
5、各类短信签名一般在三个工作日内审核完成;
2.5 错误代码表
用户在调试云信短信接口时,如报错会给出不同的状态码提示,用户可根据给出的状态码做
相应的修改
服务器端状态码:
code | 详细描述 |
---|---|
200 | 操作成功 |
201 | 客户端版本不对,需升级SDK |
302 | 用户名或密码错误 |
403 | 非法操作或没有权限 |
404 | 对象不存在 |
405 | 参数长度过长 |
406 | 对象只读 |
408 | 客户端请求超时 |
414 | 参数错误 |
415 | 客户端网络问题 |
416 | 频率控制 |
422 | 账号被禁用 |
500 | 服务器内部错误 |
503 | 服务器繁忙 |
509 | 无效协议 |
998 | 解包错误 |
999 | 打包错误 |
3 月账单
云信短信计费依托于运行商的计费方式,故云信在统计用户短信条数时会先扣除用户的发送 短信条数,在账单日统计出用户发送失败的条数,把发送失败条数补还给用户。云信短信的账单日是每月 5 号,统计上个月用户实际发送的短信条数。
例如:用户在 2016 年 1 月 1 日-2016 年 1 月 31 日一共发送了 50000 条短信,其中发送成功 49900 条,发送失败 100 条。这时云信会先扣除用户总共的发送条数 50000 条。在 2月 5 日出账单时把发送失败的 100 条短信补还到用户账户中。
3.1 账单查询
用户可以在云信管理后台点击【月账单】-->【查询月份】查询需要查看的月账单。
4 数据查询
云信提供了完善的数据查询系统,用户可以在云信管理后台查询统计短信的发送量、发送时间、回执状态等信息。
用户点击云信管理后台的【数据统计】-->【短信】-->【选择查询时间】/【接受手机号码】-->【查询】即可查询所需要的信息。
5 常见问题
1、云信短信模版最多支持创建几条?
答:单个应用每种类型的短信最多支持创建 400 条短信模版,单应用最多可创建 1200 条短信模版。
**2、短信签名【】放的位置? **
答:云信短信签名放置位置是根据运营商方面来决定的,各市的标准不一样。
**3、模版短信是否支持换行? **
答:目前云信模版短信不支持换行
**4:云信短信如何收费? **
答:云信短信计费包括短信签名,70 字计 1 条短信费,超过 70 字则以 67 字每条计费,当短信中出现中文字符,则单个汉字、英文、标点和空格等都算一个字,费用为:0. 036 元/条起。
**5:短信模板最多支持多少字,短信签名最多支持多少字? **
答:云信签名的字数签字最多为 30 字符,超出则返回错误,短信长度超过 300 字符,返回414 错误。
6:为什么传进来的验证码首位不支持 0?
答:云信模版短信参数仅支持 string 类型,如果使用 int 类型则首位的 0 会被省去。
**7:云信短信签名怎么创建? **
答:云信短信签名在短信签名中创建,每种类型的短信模板可创建一个短信签名。
**8:短信资源包可退款吗? **
答:网易云信云信短信资源包购买成功后不支持退款,建议您按需购买。
9:短信发送成功,但实际未能收到短信是什么原因
答:可能有如下原因:
1)手机是不是长时间不关机,可以关机重启下;
2)手机收件箱是不是已满,删除一些看是否可以正常接收;
3)手机是不是双卡双待手机,如果是把卡拿出来换一下卡槽;
4)手机是不是安装了安全软件,安全软件有可能会进行拦截到垃圾信箱里;
5)如若不行,请您将SIM卡换到其他手机上进行测试;
6)是否处于停机状态;
7)处于黑名单状态,投诉过运营商,或者退订过业务。
**10:其他短信问题 **
更多问题可在官网—>开发手册—>Server—>常见问题中常看