✨厂商配置

wind大约 12 分钟

在3.0中，配置内容和配置方式相较之前版本有所变动，以下为配置的内容

厂商公共配置

此配置为框架为统一各个厂商差异所抽离的带有共性的配置，部分配置名称与厂商官方给定名称可能不一致，例如accessKeyId有些厂商称为accessKey有些称之为apiKey。
在无特殊需求情况下带有默认值的配置一般不需要进行更改

      #框架定义的厂商名称标识
      supplier: alibaba
      #有些称为accessKey有些称之为apiKey，也有称为sdkKey或者appId。
      access-key-id: 您的accessKey
      #称为accessSecret有些称之为apiSecret。
      access-key-secret: 您的accessSecret
      #您的短信签名
      signature: XXX测试签名
      #模板ID 如果不需要简化的sendMessage方法可以不配置
      template-id: 1603670
      # 随机权重，负载均衡的权重值依赖于此，默认为1，如不需要负载均衡可不进行配置
      weight: 1
      #配置标识名称 如果你使用的yml进行配置，则blends下层配置的就是这个，可为空，如果你使用的接口类配置，则需要设置值
      #需要注意的是，不同的配置之间config-id不能重复，否则会发生配置丢失的问题
      config-id: XXX
      #短信自动重试间隔时间  默认五秒
      retry-interval: 5
      # 短信重试次数，默认0次不重试，如果你需要短信重试则根据自己的需求修改值即可
      max-retries: 0
      # 当前厂商的发送数量上限，默认不设置上限
      maximum: 10000

提示

以上配置来自于 org.dromara.sms4j.provider.config.BaseConfig类中，如需要查看其他信息可自行阅读

厂商差异配置

提示

配置厂商时需要指定supplier,存放Supplier的类位于 org.dromara.sms4j.comm.constant.SupplierConstant

阿里云 --- alibaba

配置类：org.dromara.sms4j.aliyun.config.AlibabaConfig

字段名称	作用	默认值
templateName	模板变量名称	null
requestUrl	请求地址	dysmsapi.aliyuncs.com
action	接口名称	SendSms
version	接口版本号	2017-05-25
regionId	地域信息	cn-hangzhou

容联云 --- cloopen

配置类：org.dromara.sms4j.cloopen.config.CloopenConfig

字段名称	作用	默认值
baseUrl	REST API Base URL	https://app.cloopen.com:8883/2013-12-26
serverIp	请求域名	null
serverPort	请求端口	null

天翼云 --- ctyun

配置类：org.dromara.sms4j.ctyun.config.CtyunConfig

字段名称	作用	默认值
templateName	模板变量名称	null
requestUrl	请求地址	https://sms-global.ctapi.ctyun.cn/sms/api/v1
action	接口名称	SendSms

亿美软通 --- emay

配置类：org.dromara.sms4j.emay.config.EmayConfig

字段名称	作用	默认值
requestUrl	APP接入地址	null

华为云短信 --- huawei

配置类：org.dromara.sms4j.huawei.config.HuaweiConfig

字段名称	作用	默认值
sender	国内短信签名通道号	null
statusCallBack	短信状态报告接收地	null
url	APP接入地址	null

京东云短信 --- jdcloud

配置类：org.dromara.sms4j.jdcloud.config.JdCloudConfig

注意

京东需要引入官方sdk后才可使用！因京东官方SDK存在BUG版本的依赖，故而将SDK排除在框架之外，有需要者自行引入

字段名称	作用	默认值
region	地域信息	null

网易云信 --- netease

配置类：org.dromara.sms4j.netease.config.NeteaseConfig

字段名称	作用	默认值
templateName	模板变量名称	null
templateUrl	模板短信请求地址	https://api.netease.im/sms/sendtemplate.action
codeUrl	验证码短信请求地址	https://api.netease.im/sms/sendcode.action
verifyUrl	验证码验证请求地址	https://api.netease.im/sms/verifycode.action
needUp	是否需要支持短信上行。true:需要，false:不需要	false

腾讯云短信 --- tencent

配置类：org.dromara.sms4j.tencent.config.TencentConfig

字段名称	作用	默认值
territory	地域信息	ap-guangzhou
codeUrl	验证码短信请求地址	https://api.netease.im/sms/sendcode.action
connTimeout	请求超时时间	60
requestUrl	请求地址	sms.tencentcloudapi.com
action	接口名称	SendSms
version	接口版本	2021-01-11
service	服务名	sms

合一短信 --- unisms

配置类：org.dromara.sms4j.unisms.config.UniConfig

字段名称	作用	默认值
isSimple	是否为简易模式	true
templateName	模板变量名称	null

云片短信 --- yunpian

配置类：org.dromara.sms4j.yunpian.config.YunpianConfig

字段名称	作用	默认值
callbackUrl	短信发送后将向这个地址推送(运营商返回的)发送报告	true
templateName	模板变量名称	null

助通短信 --- zhutong

配置类：org.dromara.sms4j.zhutong.config.ZhutongConfig

提示

说明1：accessKeyId ====> username 助通终端用户管理的用户名，非登录账号密码，请登录后台管理地址进行查看：http://mix2.zthysms.com/loginopen in new window
说明2：accessKeySecret ====> password 终端用户管理的密码
说明3：signature ====> 短信签名可以为空，为空发送【自定义短信】无需要提前创建短信模板; 不为空发送:【模板短信】
说明4：templateId ====> 模板id可以为空，为空发送【自定义短信】无需要提前创建短信模板; 不为空发送:【模板短信】
说明4：templateName ====> 模板变量名称可以为空，为空发送【自定义短信】无需要提前创建短信模板; 不为空发送:【模板短信】

字段名称	作用	默认值
不同区域，可切换请求地址，也可以不修改，请参考官方文档：https://doc.zthysms.com/web/#/1/236	短信发送后将向这个地址推送(运营商返回的)发送报告	https://api.mix2.zthysms.com/
templateName	模板变量名称	null

鼎众短信 --- dingzhong

配置类：org.dromara.sms4j.dingzhong.config.DingZhongConfig

提示

说明1：厂商公共配置 accessKeyId ====> cdkey 鼎众短信接口登录名
说明2：厂商公共配置 accessKeySecret ====> password 鼎众短信接口登录密码

字段名称	作用	默认值
requestUrl	接口发送地址：（演示及测试域名：http://demoapi.321sms.com:8201；正式域名：http://api.321sms.com）	http://demoapi.321sms.com:8201
templateName	模板变量名称	null

联麓短信 --- yunpian

配置类：org.dromara.sms4j.lianlu.config.LianLuConfig

字段名称	作用	默认值
mchId	企业ID	null
appKey	appKey	null
appId	appId	null
version	版本号	1.1.0
requestUrl	请求地址	https://apis.shlianlu.com/sms/trade

七牛云短信 --- qiniu

配置类：org.dromara.sms4j.qiniu.config.QiNiuConfig

字段名称	作用	默认值
baseUrl	请求地址	https://sms.qiniuapi.com
templateName	模板变量名称	null
singleMsgUrl	单发链接	/v1/message/single
massMsgUrl	群发链接	/v1/message
signatureId	签名ID	null

创蓝短信 --- chuanglan

配置类：org.dromara.sms4j.chuanglan.config.ChuangLanConfig

提示

说明1：accessKeyId ====> 用户平台API账号(非登录账号,示例:N1234567)
说明2：accessKeySecret ====> 用户平台API密码(非登录密码)
说明3：msgUrl ====> 短信发送路径普通短信发送 /v1/send/json 此接口支持单发、群发短信变量短信发送 /variable/json 单号码对应单内容批量下发

字段名称	作用	默认值
baseUrl	请求地址	https://smssh1.253.com/msg
msgUrl	短信发送路径	/variable/json

极光短信 --- jiguang

配置类：org.dromara.sms4j.jg.config.JgConfig

提示

说明1：accessKeyId ====> appKey、masterSecret 可以在【极光工作台】-【应用管理】-【设置&密钥】中查看。
说明2：accessKeySecret ====> appKey、masterSecret 可以在【极光工作台】-【应用管理】-【设置&密钥】中查看。
说明3：signId ====> 签名 ID，该字段为空则使用应用默认签名
说明4：messages ====> 发送文本验证码短信 codes, 发送语音验证码短信 voice_codes, 验证验证码是否有效 valid,注意：此处直接写valid即为验证码验证请求系统会自动补充完整请求地址为codes/{msg_id}/valid (注:msg_id 为调用发送验证码 API 的返回值), 发送单条模板短信 messages, 发送批量模板短信 messages/batch
说明5：voice ====> action设置为voice_codes有效,语音验证码播报语言选择，0：中文播报，1：英文播报，2：中英混合播报
说明6：ttl ====> action设置为voice_codes有效,验证码有效期，默认为 60 秒
说明7：tag ====> 标签, action设置为messages/batch有效

字段名称	作用	默认值
baseUrl	请求地址	https://api.sms.jpush.cn/v1/
action	请求方法	messages
templateName	模板变量名称	null
voice	语音验证码播报语言	0
signId	签名ID	null

布丁云V2 --- buding_v2

配置类：org.dromara.sms4j.budingyun.config.BudingV2Config

提示

说明1：accessKeyId ====> 访问密钥ID

字段名称	作用	默认值
accessKeyId	Access Key	null
signKey	签名密钥	null
args	变量列表	/v1/message/single

中国移动云MAS --- mas

配置类：org.dromara.sms4j.mas.config.MasConfig

提示

说明1：sdkAppId ====> 接口账号用户名
说明2：accessKeySecret ====> 用户密码
说明3：ecName ====> 企业名称
说明4：signature ====> 签名编码
说明5：templateId ====> 当请求方法为 tmpsubmit 时需要配置templateId
说明6：addSerial ====> 扩展码：可为空,不为空时请遵守中国移动云MAS开发文档中的描述[服务代码加扩展码总长度不能超过20位。]
说明7：action ====> 请求方式默认为 HTTP, 请求方法默认为 HTTP模式下的 tmpsubmit,norsubmit 无模板接口不需要配置templateId, tmpsubmit 有模板接口需要配置templateId, HTTPS 模式下请求方法有 submit tmpsubmit
说明8：requestUrl ====> 请求地址 HTTP模式下可不配置默认为 http://112.35.1.155:1992/sms/open in new window, HTTPS模式下请设置 https://:/sms/

字段名称	作用	默认值
requestUrl	请求地址	http://112.35.1.155:1992/sms/
ecName	企业名称	null
action	接口名称	tmpsubmit
addSerial	扩展码	null

百度云短信 --- baidu

配置类：org.dromara.sms4j.baidu.config.BaiduConfig

提示

说明1：accessKeyId ====> 访问密钥ID
说明2：accessKeySecret ====> 用户密钥
说明3：signature ====> 签名编码
说明4：custom ====> 用户自定义参数，格式为字符串，状态回调时会回传该值可不传
说明5：userExtId ====> 通道自定义扩展码可不传

字段名称	作用	默认值
host	请求地址	https://smsv3.bj.baidubce.com
templateName	模板变量名称	null
custom	用户自定义参数	null
userExtId	通道自定义扩展码	null

螺丝帽短信 --- luosimao

配置类：org.dromara.sms4j.luosimao.config.LuoSiMaoConfig

提示

说明1：accessKeyId ====> 后台提取的API key
说明2：action ====> 接口名称：发送短信接口详细 send.json, 批量发送接口详细 send_batch.json, 查询账户余额 status.json

字段名称	作用	默认值
host	请求地址	https://sms-api.luosimao.com/v1/
action	接口名称	send.json

SUBMAIL短信 --- mysubmail

配置类：org.dromara.sms4j.submail.config.SubMailConfig

提示

说明1：accessKeyId ====> APPID
说明2：accessKeySecret ====> APPKEY
说明3：action ====> 接口名称：短信发送 send.json, 短信模板发送 xsend.json, 短信一对多发送 multisend.json, 短信模板一对多发送 multixsend.json, 短信批量群发 batchsend.json, 短信批量模板群发 batchxsend.json
说明4：signType ====> MD5 或 SHA-1 默认MD5 填写任意值，不填即为密匙明文验证模式
说明5：signVersion ====> signature加密计算方式(当sign_version传2时，会忽略某些字段)

字段名称	作用	默认值
baseUrl	请求地址	https://api-v4.mysubmail.com/sms/
action	接口名称	send.json
signType	验证模式	MD5
signVersion	signature加密计算方式	2

单米短信 --- danmi

配置类：org.dromara.sms4j.danmi.config.DanMiConfig

提示

说明1：accessKeyId ====> ACCOUNT SID
说明2：accessKeySecret ====> AUTH TOKEN

字段名称	作用	默认值
baseUrl	请求地址	https://openapi.danmi.com/
action	请求方法	distributor/sendSMS

✨厂商配置

# 厂商公共配置

# 厂商差异配置

# 阿里云 --- alibaba

# 容联云 --- cloopen

# 天翼云 --- ctyun

# 亿美软通 --- emay

# 华为云短信 --- huawei

# 京东云短信 --- jdcloud

# 网易云信 --- netease

# 腾讯云短信 --- tencent

# 合一短信 --- unisms

# 云片短信 --- yunpian

# 助通短信 --- zhutong

# 鼎众短信 --- dingzhong

# 联麓短信 --- yunpian

# 七牛云短信 --- qiniu

# 创蓝短信 --- chuanglan

# 极光短信 --- jiguang

# 布丁云V2 --- buding_v2

# 中国移动 云MAS --- mas

# 百度云短信 --- baidu

# 螺丝帽短信 --- luosimao

# SUBMAIL短信 --- mysubmail

# 单米短信 --- danmi