CCPRestSDK (jeeweb-common-sms 1.0.3.RELEASE API)

java.lang.Object
- cn.jeeweb.common.sms.utils.cloopen.CCPRestSDK

```
public class CCPRestSDK
extends Object
```

嵌套类概要

嵌套类
限定符和类型类和说明

static class CCPRestSDK.AccountType

static class CCPRestSDK.BodyType

嵌套类
限定符和类型	类和说明
`static class`	`CCPRestSDK.AccountType`
`static class`	`CCPRestSDK.BodyType`

字段概要

字段
限定符和类型字段和说明

String App_ID

String Callsid

String Filename
语音文件上传

protected org.slf4j.Logger logger
日志对象

字段
限定符和类型	字段和说明
`String`	`App_ID`
`String`	`Callsid`
`String`	`Filename` 语音文件上传
`protected org.slf4j.Logger`	`logger` 日志对象

构造器概要

构造器
构造器和说明

CCPRestSDK()

构造器
构造器和说明
`CCPRestSDK()`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`HashMap<String,Object>`	`billRecords(String date, String keywords)` 话单下载
`HashMap<String,Object>`	`CallResult(String callSid)` 呼叫结果查询
`HashMap<String,Object>`	`createSubAccount(String friendlyName)` 创建子帐号
`HashMap<String,Object>`	`getSubAccounts(String startNo, String offset)` 获取子帐号
`void`	`init(String serverIP, String serverPort)` 初始化服务地址和端口
`HashMap<String,Object>`	`ivrDial(String number, String userdata, boolean record, String disnumber)` 发起IVR外呼请求
`HashMap<String,Object>`	`landingCall(String to, String mediaName, String mediaTxt, String displayNum, String playTimes, String respUrl, String userData, String txtSpeed, String txtVolume, String txtPitch, String txtBgsound, String playMode)` 发送外呼通知请求
`HashMap<String,Object>`	`MediaFileUpload(String filename, FileInputStream fis)`
`HashMap<String,Object>`	`queryAccountInfo()` 获取主帐号信息查询
`HashMap<String,Object>`	`QueryCallState(String callid, String action)` 呼叫状态查询
`HashMap<String,Object>`	`QuerySMSTemplate(String templateId)` 短信模板查询
`HashMap<String,Object>`	`querySubAccount(String friendlyName)` 获取子帐号信息
`HashMap<String,Object>`	`sendTemplateSMS(String to, String templateId, String[] datas)` 发送短信模板请求
`void`	`setAccount(String accountSid, String accountToken)` 初始化主帐号信息
`void`	`setAppId(String appId)` 初始化应用Id
`void`	`setSubAccount(String subAccountSid, String subAccountToken)` 初始化子帐号信息
`HashMap<String,Object>`	`voiceVerify(String verifyCode, String to, String displayNum, String playTimes, String respUrl, String lang, String userData, String welcomePrompt, String playVerifyCode, String maxCallTime)` 发起语音验证码请求

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - logger
```
protected org.slf4j.Logger logger
```
    日志对象
  - App_ID
```
public String App_ID
```
  - Callsid
```
public String Callsid
```
  - Filename
```
public String Filename
```
    语音文件上传
- 构造器详细资料
  - CCPRestSDK
```
public CCPRestSDK()
```
- 方法详细资料
  - init
```
public void init(String serverIP,
                 String serverPort)
```
    初始化服务地址和端口
    
    参数:
    
    serverIP - 必选参数服务器地址
    
    serverPort - 必选参数服务器端口
  - setAccount
```
public void setAccount(String accountSid,
                       String accountToken)
```
    初始化主帐号信息
    
    参数:
    
    accountSid - 必选参数主帐号
    
    accountToken - 必选参数主帐号TOKEN
  - setSubAccount
```
public void setSubAccount(String subAccountSid,
                          String subAccountToken)
```
    初始化子帐号信息
    
    参数:
    
    subAccountSid - 必选参数子帐号
    
    subAccountToken - 必选参数子帐号TOKEN
  - setAppId
```
public void setAppId(String appId)
```
    初始化应用Id
    
    参数:
    
    appId - 必选参数应用Id
  - billRecords
```
public HashMap<String,Object> billRecords(String date,
                                          String keywords)
```
    话单下载
    
    参数:
    
    date - 必选参数 day 代表前一天的数据（从00:00 – 23:59）
    
    keywords - 可选参数客户的查询条件，由客户自行定义并提供给云通讯平台。默认不填忽略此参数
    
    返回:
  - ivrDial
```
public HashMap<String,Object> ivrDial(String number,
                                      String userdata,
                                      boolean record,
                                      String disnumber)
```
    发起IVR外呼请求
    
    参数:
    
    number - 必选参数待呼叫号码，为Dial节点的属性
    
    userdata - 可选参数用户数据，在通知中返回，只允许填写数字字符，为Dial节点的属性
    
    record - 可选参数是否录音，可填项为true和false，默认值为false不录音，为Dial节点的属性
    
    disnumber - 可选参数用户方的显号号码，根据平台侧显号规则控制。
    
    返回:
  - voiceVerify
```
public HashMap<String,Object> voiceVerify(String verifyCode,
                                          String to,
                                          String displayNum,
                                          String playTimes,
                                          String respUrl,
                                          String lang,
                                          String userData,
                                          String welcomePrompt,
                                          String playVerifyCode,
                                          String maxCallTime)
```
    发起语音验证码请求
    
    参数:
    
    verifyCode - 必选参数验证码内容，为数字和英文字母，不区分大小写，长度4-8位
    
    to - 必选参数接收号码
    
    displayNum - 可选参数显示主叫号码，显示权限由服务侧控制
    
    playTimes - 可选参数循环播放次数，1－3次，默认播放1次
    
    respUrl - 可选参数语音验证码状态通知回调地址，云通讯平台将向该Url地址发送呼叫结果通知
    
    lang - 可选参数语言类型
    
    userData - 可选参数第三方私有数据
    
    welcomePrompt - 可选参数 wav格式的文件名，欢迎提示音，在播放验证码语音前播放此内容，配合verifyCode使用，默认值空，当playVerifyCode为空有效。
    
    playVerifyCode - 可选参数 wav格式的文件名，语音验证码的内容全部播放此节点下的全部语音文件，也就是实现了语音验证码功能播放用户自己的语音文件，该参数和verifyCode二者不能同时为空，当二者都不为空时优先使用playVerifyCode。
    
    maxCallTime - 可选参数最大通话时长
    
    返回:
  - landingCall
```
public HashMap<String,Object> landingCall(String to,
                                          String mediaName,
                                          String mediaTxt,
                                          String displayNum,
                                          String playTimes,
                                          String respUrl,
                                          String userData,
                                          String txtSpeed,
                                          String txtVolume,
                                          String txtPitch,
                                          String txtBgsound,
                                          String playMode)
```
    发送外呼通知请求
    
    参数:
    
    to - 必选参数被叫号码
    
    mediaName - 可选参数语音文件名称，格式 wav。与mediaTxt不能同时为空，不为空时mediaTxt属性失效
    
    mediaTxt - 可选参数文本内容，默认值为空
    
    displayNum - 可选参数显示的主叫号码，显示权限由服务侧控制
    
    playTimes - 可选参数循环播放次数，1－3次，默认播放1次
    
    respUrl - 可选参数外呼通知状态通知回调地址，云通讯平台将向该Url地址发送呼叫结果通知
    
    userData - 可选参数用户私有数据
    
    txtSpeed - 可选参数文本转语音后的发音速度，取值范围：-500至500，当mediaTxt有效才生效，默认值为0。
    
    txtVolume - 可选参数文本转语音后的音量大小，取值范围：-20至20，当mediaTxt有效才生效，默认值为0。
    
    txtPitch - 可选参数文本转语音后的音调，取值范围：-500至500，当mediaTxt有效才生效，默认值为0。
    
    txtBgsound - 可选参数文本转语音后的背景音编号，目前云通讯平台支持6种背景音，1到6的六种背景音编码，0为不需要背景音。暂时不支持第三方自定义背景音。当mediaTxt有效才生效。
    
    playMode - 可选参数是否同时播放文本和语音文件 , 0、否 1、是，默认0。优先播放文本。
    
    返回:
  - sendTemplateSMS
```
public HashMap<String,Object> sendTemplateSMS(String to,
                                              String templateId,
                                              String[] datas)
```
    发送短信模板请求
    
    参数:
    
    to - 必选参数短信接收端手机号码集合，用英文逗号分开，每批发送的手机号数量不得超过100个
    
    templateId - 必选参数模板Id
    
    datas - 可选参数内容数据，用于替换模板中{序号}
    
    返回:
  - querySubAccount
```
public HashMap<String,Object> querySubAccount(String friendlyName)
```
    获取子帐号信息
    
    参数:
    
    friendlyName - 必选参数子帐号名称
    
    返回:
  - getSubAccounts
```
public HashMap<String,Object> getSubAccounts(String startNo,
                                             String offset)
```
    获取子帐号
    
    参数:
    
    startNo - 可选参数开始的序号，默认从0开始
    
    offset - 可选参数一次查询的最大条数，最小是1条，最大是100条
    
    返回:
  - queryAccountInfo
```
public HashMap<String,Object> queryAccountInfo()
```
    获取主帐号信息查询
    
    返回:
  - createSubAccount
```
public HashMap<String,Object> createSubAccount(String friendlyName)
```
    创建子帐号
    
    参数:
    
    friendlyName - 必选参数子帐号名称。可由英文字母和阿拉伯数字组成子帐号唯一名称，推荐使用电子邮箱地址
    
    返回:
  - QuerySMSTemplate
```
public HashMap<String,Object> QuerySMSTemplate(String templateId)
```
    短信模板查询
    
    参数:
    
    templateId - 可选参数模板Id，不带此参数查询全部可用模板
    
    返回:
  - QueryCallState
```
public HashMap<String,Object> QueryCallState(String callid,
                                             String action)
```
    呼叫状态查询
    
    参数:
    
    callid - 必选参数呼叫Id
    
    action - 可选参数查询结果通知的回调url地址
    
    返回:
  - CallResult
```
public HashMap<String,Object> CallResult(String callSid)
```
    呼叫结果查询
    
    参数:
    
    callSid - 必选参数呼叫Id
    
    返回:
  - MediaFileUpload
```
public HashMap<String,Object> MediaFileUpload(String filename,
                                              FileInputStream fis)
```

类 CCPRestSDK

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

logger

App_ID

Callsid

Filename

构造器详细资料

CCPRestSDK

方法详细资料

init

setAccount

setSubAccount

setAppId

billRecords

ivrDial

voiceVerify

landingCall

sendTemplateSMS

querySubAccount

getSubAccounts

queryAccountInfo

createSubAccount

QuerySMSTemplate

QueryCallState

CallResult

MediaFileUpload