程序包 org.dromara.sms4j.jg.util

类 JgUtils

java.lang.Object

org.dromara.sms4j.jg.util.JgUtils

public class JgUtils
extends Object

类名: JgHelper

说明：极光 sms

作者:

:SmartFire 2024/3/15

构造器概要

构造器

构造器	说明
JgUtils()

方法概要

修饰符和类型	方法	说明
private static Set<String>	build(String phone)
private static Map<String,Object>	buildBody(String code)	构造请求body 验证验证码是否有效
private static Map<String,Object>	buildBody(String phone, String signId, String templateId)	构造请求body 发送文本验证码短信
private static Map<String,Object>	buildBody(String phone, String code, String voice, Integer ttl)	构造请求body 发送语音验证码短信
private static Map<String,Object>	buildBody(String phone, String signId, String templateId, String tag, LinkedHashMap<String,String> messages)	构造请求body 发送批量模板短信
private static Map<String,Object>	buildBody(String phone, String signId, String templateId, LinkedHashMap<String,String> messages)	构造请求body 发送单条模板短信
static Map<String,Object>	buildBody(String phone, LinkedHashMap<String,String> messages, String templateId, JgConfig config, String code)	构造请求body
static Map<String,String>	buildHeaders(String accessKeyId, String accessKeySecret)	构造请求头
static String	buildJsonKey(String action)	构造返回json验证Key值
static String	buildUrl(String baseUrl, String action, String msgId)	构造请求地址
private static void	check(String str)
private static void	checkAction(String action)
private static void	checkMessages(LinkedHashMap<String,String> messages)
private static void	checkSingle(String phone)
private static void	checkVoice(String voice)

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

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

构造器详细资料

JgUtils

public JgUtils()

方法详细资料

buildUrl

public static String buildUrl(String baseUrl,
 String action,
 String msgId)

构造请求地址

参数:

baseUrl - 配置的baseUrl

action - 请求方法

msgId - 验证验证码是否有效时使用 msgId 为调用发送验证码 API 的返回值

返回:

url

buildHeaders

public static Map<String,String> buildHeaders(String accessKeyId,
 String accessKeySecret)

构造请求头

参数:

accessKeyId - appKey

accessKeySecret - appKey

返回:

请求头

buildBody

public static Map<String,Object> buildBody(String phone,
 LinkedHashMap<String,String> messages,
 String templateId,
 JgConfig config,
 String code)

构造请求body

参数:

phone - 手机号

messages - 消息体

templateId - 模板 ID

config - 配置

code - 验证码

返回:

请求body

buildJsonKey

public static String buildJsonKey(String action)

构造返回json验证Key值

参数:

action - 请求方法

返回:

返回json验证Key值

buildBody

private static Map<String,Object> buildBody(String phone,
 String signId,
 String templateId)

构造请求body 发送文本验证码短信

参数:

phone - 手机号

signId - 签名 ID，该字段为空则使用应用默认签名

templateId - 模板 ID

返回:

请求body

buildBody

private static Map<String,Object> buildBody(String phone,
 String code,
 String voice,
 Integer ttl)

构造请求body 发送语音验证码短信

参数:

phone - 手机号

code - 语音验证码的值，验证码仅支持 4-8 个数字 可为空

voice - 语音验证码播报语言选择，0：中文播报，1：英文播报，2：中英混合播报

ttl - 验证码有效期，默认为 60 秒

返回:

请求body

buildBody

private static Map<String,Object> buildBody(String code)

构造请求body 验证验证码是否有效

参数:

code - 验证码

返回:

请求body

buildBody

private static Map<String,Object> buildBody(String phone,
 String signId,
 String templateId,
 LinkedHashMap<String,String> messages)

构造请求body 发送单条模板短信

参数:

phone - 手机号码

signId - 签名 ID，该字段为空则使用应用默认签名

templateId - 模板 ID

messages - 模板参数,需要替换的参数名和 value 的键值对 可为空

返回:

请求body

buildBody

private static Map<String,Object> buildBody(String phone,
 String signId,
 String templateId,
 String tag,
 LinkedHashMap<String,String> messages)

构造请求body 发送批量模板短信

参数:

phone - 手机号码列表

signId - 签名 ID，该字段为空则使用应用默认签名

templateId - 模板 ID

tag - 标签 可为空

messages - 模板参数,需要替换的参数名和 value 的键值对

返回:

请求body

build

private static Set<String> build(String phone)

checkSingle

private static void checkSingle(String phone)

checkMessages

private static void checkMessages(LinkedHashMap<String,String> messages)

checkVoice

private static void checkVoice(String voice)

checkAction

private static void checkAction(String action)

check

private static void check(String str)