cn.allbs.sms.client

类 HuaWeiYunClient

java.lang.Object

cn.allbs.sms.client.AbstractClient

cn.allbs.sms.client.HuaWeiYunClient

所有已实现的接口:

IClient

public class HuaWeiYunClient
extends AbstractClient

类 HuaWeiYunClient

华为云短信发送端

从以下版本开始:

2022/11/8 17:44

作者:

ChenQi

字段概要

字段

限定符和类型	字段和说明
private static java.lang.String	AUTH_HEADER_VALUE 无需修改,用于格式化鉴权头域,给"Authorization"参数赋值
private static java.lang.String	WSSE_HEADER_FORMAT 无需修改,用于格式化鉴权头域,给"X-WSSE"参数赋值

从类继承的字段 cn.allbs.sms.client.AbstractClient

appKey, appSecret, endPoint, region, smsTemplateMap, timeOut

构造器概要

构造器

构造器和说明
HuaWeiYunClient(SmsClientProperties smsClientProperties)

方法概要

限定符和类型	方法和说明
private java.lang.String	buildRequestBody(java.lang.String sender, java.lang.String receiver, java.lang.String templateId, java.lang.String templateParas, java.lang.String statusCallbackUrl, java.lang.String signature) 构造请求Body体
private java.lang.String	buildWsseHeader(java.lang.String appKey, java.lang.String appSecret) 构造X-WSSE参数值
java.lang.String	send() 发送短信，使用配置好的默认短信模版和默认的手机号
java.lang.String	send(java.lang.String templateId, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String... phoneNumbers) 发送短信 指定模版id、参数、手机号
java.lang.String	sendCode(java.lang.String code, java.lang.String... phoneNumbers) 发送短信验证码。
java.lang.String	sendCode(java.lang.String templateId, java.lang.String code, java.lang.String... phoneNumbers) 发送短信验证码。

从类继承的方法 cn.allbs.sms.client.AbstractClient

propertiesChange

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

WSSE_HEADER_FORMAT

private static final java.lang.String WSSE_HEADER_FORMAT

无需修改,用于格式化鉴权头域,给"X-WSSE"参数赋值

另请参阅:

常量字段值

AUTH_HEADER_VALUE

private static final java.lang.String AUTH_HEADER_VALUE

无需修改,用于格式化鉴权头域,给"Authorization"参数赋值

另请参阅:

常量字段值

构造器详细资料

HuaWeiYunClient

public HuaWeiYunClient(SmsClientProperties smsClientProperties)

方法详细资料

sendCode

public java.lang.String sendCode(java.lang.String code,
                                 java.lang.String... phoneNumbers)
                          throws java.lang.Exception

从接口复制的说明: IClient

发送短信验证码。默认使用第一个模版

指定者:

sendCode 在接口中 IClient

覆盖:

sendCode 在类中 AbstractClient

参数:

code - 验证码

phoneNumbers - 手机号

返回:

发送状态

抛出:

java.lang.Exception

sendCode

public java.lang.String sendCode(java.lang.String templateId,
                                 java.lang.String code,
                                 java.lang.String... phoneNumbers)
                          throws java.lang.Exception

从接口复制的说明: IClient

发送短信验证码。默认使用第一个模版

指定者:

sendCode 在接口中 IClient

覆盖:

sendCode 在类中 AbstractClient

参数:

templateId - 模版key

code - 验证码

phoneNumbers - 手机号

返回:

发送状态

抛出:

java.lang.Exception

send

public java.lang.String send()
                      throws java.lang.Exception

从接口复制的说明: IClient

发送短信，使用配置好的默认短信模版和默认的手机号

指定者:

send 在接口中 IClient

覆盖:

send 在类中 AbstractClient

返回:

发送状态

抛出:

java.lang.Exception

send

public java.lang.String send(java.lang.String templateId,
                             java.util.Map<java.lang.String,java.lang.String> params,
                             java.lang.String... phoneNumbers)
                      throws java.lang.Exception

从接口复制的说明: IClient

发送短信 指定模版id、参数、手机号

指定者:

send 在接口中 IClient

覆盖:

send 在类中 AbstractClient

参数:

templateId - 模版id

params - 参数

phoneNumbers - 手机号

返回:

发送状态

抛出:

java.lang.Exception

buildRequestBody

private java.lang.String buildRequestBody(java.lang.String sender,
                                          java.lang.String receiver,
                                          java.lang.String templateId,
                                          java.lang.String templateParas,
                                          java.lang.String statusCallbackUrl,
                                          java.lang.String signature)

构造请求Body体

参数:

sender - 发送方

receiver - 接收方

templateId - 模板id

templateParas - 模板参数

statusCallbackUrl - 回调url

signature - | 签名名称,使用国内短信通用模板时填写

返回:

请求连接

buildWsseHeader

private java.lang.String buildWsseHeader(java.lang.String appKey,
                                         java.lang.String appSecret)

构造X-WSSE参数值

参数:

appKey - appKey

appSecret - appSecret

返回:

请求连接