org.glamey.scaffold.component.sms.yuntongxun

类 YunTongXunRestAPI

java.lang.Object

org.glamey.scaffold.component.sms.yuntongxun.YunTongXunRestAPI

public final class YunTongXunRestAPI
extends Object

云通信restAPI

作者:

by zhouyang.zhou

嵌套类概要

嵌套类

限定符和类型	类和说明
(专用程序包) static class	YunTongXunRestAPI.AccountType
static class	YunTongXunRestAPI.Builder 参数设置,初始化配置

字段概要

字段

限定符和类型	字段和说明
private String	accountSid
private String	accountToken
private String	appId
private String	baseUrl
private static okhttp3.OkHttpClient	HTTP_CLIENT
private static org.glamey.scaffold.json.JsonMapper	JSON_MAPPER
private static org.slf4j.Logger	LOGGER
private static okhttp3.MediaType	MEDIA_TYPE_JSON
private String	subAccountSid
private String	subAccountToken
private String	timeStamp
private String	voipAccount
private String	voipToken

构造器概要

构造器

限定符	构造器和说明
private	YunTongXunRestAPI(YunTongXunRestAPI.Builder builder)

方法概要

限定符和类型	方法和说明
Map<String,Object>	accountInfo() 主账户信息
private String	buildBaseUrl(String function, YunTongXunRestAPI.AccountType accountType) 构建请求URL
private okhttp3.Headers	buildHeader(long bodySize, YunTongXunRestAPI.AccountType accountType) 构建包含授权的请求头内容
Map<String,Object>	callsCallback(String from, String to, String customerSerNum, String fromSerNum, String promptTone, String alwaysPlay, String terminalDtmf, String userData, String maxCallTime, String hangupCdrUrl, String needBothCdr, String needRecord, String countDownTime, String countDownPrompt) 发送双向回拨请求
Map<String,Object>	callsVoiceVerify(String mobile, String verifyCode, String displayNum, String playTimes) 下发语音验证码
Map<String,Object>	closeSubAccount(String subAccountSid) 关闭子账户
private Map<String,Object>	doRequest(okhttp3.Request request, String message) 数据请求及其处理
private okhttp3.Response	httpExecute(okhttp3.Request request)
Map<String,Object>	querySubAccountByName(String friendlyName) 子账户信息查询
Map<String,Object>	smsTemplateSMS(String[] mobiles, String templateId, String[] data) 下发模板短信
Map<String,Object>	subAccounts(String friendlyName) 创建子账户

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

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

字段详细资料

LOGGER

private static final org.slf4j.Logger LOGGER

baseUrl

private String baseUrl

accountSid

private String accountSid

accountToken

private String accountToken

subAccountSid

private String subAccountSid

subAccountToken

private String subAccountToken

voipAccount

private String voipAccount

voipToken

private String voipToken

appId

private String appId

timeStamp

private String timeStamp

HTTP_CLIENT

private static final okhttp3.OkHttpClient HTTP_CLIENT

JSON_MAPPER

private static final org.glamey.scaffold.json.JsonMapper JSON_MAPPER

MEDIA_TYPE_JSON

private static final okhttp3.MediaType MEDIA_TYPE_JSON

构造器详细资料

YunTongXunRestAPI

private YunTongXunRestAPI(YunTongXunRestAPI.Builder builder)

方法详细资料

accountInfo

public final Map<String,Object> accountInfo()
                                     throws IOException

主账户信息

返回:

response

抛出:

IOException - exception

subAccounts

public final Map<String,Object> subAccounts(String friendlyName)
                                     throws IOException

创建子账户

参数:

friendlyName - friendlyName

返回:

response

抛出:

IOException - IOException

closeSubAccount

public final Map<String,Object> closeSubAccount(String subAccountSid)
                                         throws IOException

关闭子账户

参数:

subAccountSid - subAccountSid

返回:

response

抛出:

IOException - IOException

querySubAccountByName

public final Map<String,Object> querySubAccountByName(String friendlyName)
                                               throws IOException

子账户信息查询

参数:

friendlyName - friendlyName

返回:

response

抛出:

IOException - exception

smsTemplateSMS

public final Map<String,Object> smsTemplateSMS(String[] mobiles,
                                               String templateId,
                                               String[] data)
                                        throws IOException

下发模板短信

参数:

mobiles - the mobiles

templateId - templteId

data - data

返回:

response

抛出:

IOException - exception

callsVoiceVerify

public final Map<String,Object> callsVoiceVerify(String mobile,
                                                 String verifyCode,
                                                 String displayNum,
                                                 String playTimes)
                                          throws IOException

下发语音验证码

参数:

mobile - mobile

verifyCode - verify code

displayNum - display number

playTimes - play times

返回:

response

抛出:

IOException - exception

callsCallback

public final Map<String,Object> callsCallback(String from,
                                              String to,
                                              String customerSerNum,
                                              String fromSerNum,
                                              String promptTone,
                                              String alwaysPlay,
                                              String terminalDtmf,
                                              String userData,
                                              String maxCallTime,
                                              String hangupCdrUrl,
                                              String needBothCdr,
                                              String needRecord,
                                              String countDownTime,
                                              String countDownPrompt)
                                       throws IOException

发送双向回拨请求

参数:

from - 必选参数 主叫电话号码

to - 必选参数 被叫电话号码

customerSerNum - 可选参数 被叫侧显示的客服号码，根据平台侧显号规则控制

fromSerNum - 可选参数 主叫侧显示的号码，根据平台侧显号规则控制

promptTone - 可选参数 第三方自定义回拨提示音

userData - 可选参数 第三方私有数据

maxCallTime - 可选参数 最大通话时长

hangupCdrUrl - 可选参数 实时话单通知地址

alwaysPlay - 可选参数 是否一直播放提示音

terminalDtmf - 可选参数 用于终止播放提示音的按键

needBothCdr - 可选参数 是否给主被叫发送话单

needRecord - 可选参数 是否录音

countDownTime - 可选参数 设置倒计时时间

countDownPrompt - 可选参数 到达倒计时时间播放的提示音

返回:

response

抛出:

IOException - exception

doRequest

private Map<String,Object> doRequest(okhttp3.Request request,
                                     String message)
                              throws IOException

数据请求及其处理

参数:

request - request

message - message

返回:

response

抛出:

IOException - exception

httpExecute

private okhttp3.Response httpExecute(okhttp3.Request request)
                              throws IOException

抛出:

IOException

buildHeader

private okhttp3.Headers buildHeader(long bodySize,
                                    YunTongXunRestAPI.AccountType accountType)

构建包含授权的请求头内容

参数:

bodySize - the size of body

accountType - account type

返回:

http headers

buildBaseUrl

private String buildBaseUrl(String function,
                            YunTongXunRestAPI.AccountType accountType)

构建请求URL

参数:

function - function

accountType - account type

返回:

response