com.xsxx.sms

类 V4Client

java.lang.Object

com.xsxx.sms.V2Client

com.xsxx.sms.V4Client

所有已实现的接口:

BaseApi

public class V4Client
extends V2Client

HTTP API v4.0 提交客户端 四代接口增加： 1. 加密验证 2. 防重放 3. 推送验证 接口文档地址： https://api-wiki.wxxsxx.com

作者:

viveguan

字段概要

字段

限定符和类型	字段和说明
private int	maxSize 已过时。
private String	URI_ADD_TEMPLATE 添加模板
private String	URI_AES_SUBMIT aes128 加密发送
private String	URI_BATCH_SUBMIT_BY_TEMPLATE 批量模板短信发送
private String	URI_DEL_TEMPLATE 删除模板
private String	URI_MODIFY_TEMPLATE 修改模板
private String	URI_QUERY_TEMPLATE_STATUS 查询模板状态
private String	URI_SUBMIT_BY_TEMPLATE 模板短信发送

从类继承的字段 com.xsxx.sms.V2Client

MAX_REQUESTS_PER_HOST, okHttpClient, token, URI_BALANCE, URI_BATCHSUBMIT, URI_DAILY_STATS, URI_DELIVRD, URI_REPORT, URI_SUBMIT

从接口继承的字段 com.xsxx.sms.BaseApi

MAX_BATCH_CONTENT, MAX_BATCH_PHONE

构造器概要

构造器

构造器和说明
V4Client(String url, String spId, String spKey)
V4Client(String url, String spId, String spKey, Integer requestPerHost)
V4Client(String url, String spId, String spKey, Integer requestPerHost, String fetchURL, String templateURL) 初始化

方法概要

限定符和类型	方法和说明
boolean	addOrModifyTemplate(boolean isAdd, SmsTemplate smsTemplate, java.util.function.Consumer<SmsTemplateAddResp> consumer) 添加或修改模板
boolean	batchSubmitByTemplateCode(List<SmsSubimtByTemplateReqVo> smsSubimtByTemplateReqVoList, java.util.function.Consumer<SmsBatchSubimtByTemplateResp> consumer) 批量模板短信发送
boolean	deleteTemplate(Long templateCode, java.util.function.Consumer<Resp> consumer) 删除模板
BalanceResp	getBalance() 主动获取预付费发送账号余额 预付费账号剩余余额查询。
DailyStatsResp	getDailyStats(String date) V4接口 获取发送账号日统计
protected okhttp3.Request	makeRequest(List<Sms> smsContents) 已过时。
protected okhttp3.Request	makeRequest(Sms sms) http请求体 用于短信发送
protected okhttp3.Request	makeRequest(String url) http请求体 用于非发送接口
private okhttp3.Request	makeRequest(String url, String body) 建立请求体
boolean	queryTemplateStatus(List<Long> templateCodes, java.util.function.Consumer<SmsTemplateQueryStatusResp> consumer) 查询模板状态
void	setMaxSize(int maxSize)
boolean	submitByAes(Sms sms, java.util.function.Consumer<SubmitResp> consumer) AES加密 发送提交
boolean	submitByTemplateCode(SmsSubimtByTemplateReqVo smsSubimtByTemplateReqVo, java.util.function.Consumer<SmsSubimtByTemplateResp> consumer) 单个模板短信发送
SubmitResp	submitSync(Sms sms) 发送提交

从类继承的方法 com.xsxx.sms.V2Client

getDeliver, getReport, submit, submit

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

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

字段详细资料

URI_AES_SUBMIT

private String URI_AES_SUBMIT

aes128 加密发送

URI_ADD_TEMPLATE

private String URI_ADD_TEMPLATE

添加模板

URI_MODIFY_TEMPLATE

private String URI_MODIFY_TEMPLATE

修改模板

URI_DEL_TEMPLATE

private String URI_DEL_TEMPLATE

删除模板

URI_QUERY_TEMPLATE_STATUS

private String URI_QUERY_TEMPLATE_STATUS

查询模板状态

URI_SUBMIT_BY_TEMPLATE

private String URI_SUBMIT_BY_TEMPLATE

模板短信发送

URI_BATCH_SUBMIT_BY_TEMPLATE

private String URI_BATCH_SUBMIT_BY_TEMPLATE

批量模板短信发送

maxSize

@Deprecated
private int maxSize

已过时。

一次获取状态报告的数量，用于主动获取接口

构造器详细资料

V4Client

public V4Client(String url,
                String spId,
                String spKey,
                Integer requestPerHost,
                String fetchURL,
                String templateURL)
         throws IllegalArgumentException

初始化

参数:

url - 短信接口提交地址

spId - 我方提供的发送账号的唯一标识

spKey - 我方提供的发送账号的预共享密钥的

requestPerHost - http窗口数量

fetchURL - 获取状态/上行报告地址

templateURL - 模板报备发送提交url

抛出:

IllegalArgumentException

V4Client

public V4Client(String url,
                String spId,
                String spKey,
                Integer requestPerHost)
         throws IllegalArgumentException

抛出:

IllegalArgumentException

V4Client

public V4Client(String url,
                String spId,
                String spKey)
         throws IllegalArgumentException

抛出:

IllegalArgumentException

方法详细资料

getBalance

public BalanceResp getBalance()

主动获取预付费发送账号余额 预付费账号剩余余额查询。

返回:

getDailyStats

public DailyStatsResp getDailyStats(String date)

从接口复制的说明: BaseApi

V4接口 获取发送账号日统计

参数:

date - 查询的日期 日期格式化：yyyyMMdd

返回:

makeRequest

private okhttp3.Request makeRequest(String url,
                                    String body)

建立请求体

参数:

url -

body -

返回:

makeRequest

protected okhttp3.Request makeRequest(Sms sms)

http请求体 用于短信发送

覆盖:

makeRequest 在类中 V2Client

参数:

sms -

返回:

makeRequest

@Deprecated
protected okhttp3.Request makeRequest(List<Sms> smsContents)

已过时。

http请求体 用于多内容打包短信发送

覆盖:

makeRequest 在类中 V2Client

参数:

smsContents -

返回:

setMaxSize

public void setMaxSize(int maxSize)

makeRequest

protected okhttp3.Request makeRequest(String url)

http请求体 用于非发送接口

覆盖:

makeRequest 在类中 V2Client

参数:

url -

返回:

submitByAes

public boolean submitByAes(Sms sms,
                           java.util.function.Consumer<SubmitResp> consumer)
                    throws Exception

AES加密 发送提交

参数:

sms -

consumer -

返回:

true:同步 false 异步

抛出:

Exception

addOrModifyTemplate

public boolean addOrModifyTemplate(boolean isAdd,
                                   SmsTemplate smsTemplate,
                                   java.util.function.Consumer<SmsTemplateAddResp> consumer)
                            throws Exception

添加或修改模板

参数:

isAdd - true 添加模板 false 修改模板

smsTemplate -

consumer -

返回:

true:同步 false 异步

抛出:

Exception

deleteTemplate

public boolean deleteTemplate(Long templateCode,
                              java.util.function.Consumer<Resp> consumer)
                       throws Exception

删除模板

参数:

templateCode - 模板编号

consumer -

返回:

true:同步 false 异步

抛出:

Exception

queryTemplateStatus

public boolean queryTemplateStatus(List<Long> templateCodes,
                                   java.util.function.Consumer<SmsTemplateQueryStatusResp> consumer)
                            throws Exception

查询模板状态

参数:

templateCodes - 短信模板唯一编号列表 一批次最多100

consumer -

返回:

true:同步 false 异步

抛出:

Exception

submitByTemplateCode

public boolean submitByTemplateCode(SmsSubimtByTemplateReqVo smsSubimtByTemplateReqVo,
                                    java.util.function.Consumer<SmsSubimtByTemplateResp> consumer)
                             throws Exception

单个模板短信发送

参数:

smsSubimtByTemplateReqVo - 模板短信发送 请求参数

consumer -

返回:

true:同步 false 异步

抛出:

Exception

batchSubmitByTemplateCode

public boolean batchSubmitByTemplateCode(List<SmsSubimtByTemplateReqVo> smsSubimtByTemplateReqVoList,
                                         java.util.function.Consumer<SmsBatchSubimtByTemplateResp> consumer)
                                  throws Exception

批量模板短信发送

参数:

smsSubimtByTemplateReqVoList - 模板短信发送 请求参数

consumer -

返回:

true:同步 false 异步

抛出:

Exception

submitSync

public SubmitResp submitSync(Sms sms)

发送提交

参数:

sms - 待发短信

返回:

SubmitResp