com.yunpian.sdk.api

Class VoiceApi

java.lang.Object

com.yunpian.sdk.api.YunpianApi

com.yunpian.sdk.api.VoiceApi

All Implemented Interfaces:

YunpianApiResult, YunpianConstant

public class VoiceApi
extends YunpianApi

https://www.yunpian.com/api2.0/api-voice.html

Since:

1.2.0

Author:

dzh

creation class date

Nov 23, 2016 1:12:57 PM

Nested Class Summary

Nested classes/interfaces inherited from interface com.yunpian.sdk.api.YunpianApiResult

YunpianApiResult.AbstractResultHandler<R,T>, YunpianApiResult.ListResultHandler<R,T>, YunpianApiResult.MapResultHandler<T>, YunpianApiResult.ResultHandler<R,T>, YunpianApiResult.SimpleListResultHandler<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from interface com.yunpian.sdk.constant.YunpianConstant

_SIGN, ALARM_BALANCE, ANONYMOUS_NUMBER, API_SECRET, API_VERSION, APIKEY, APPLYVIP, AREA_CODE, BALANCE, CALLBACK_URL, CARRIER, CHECK_STATUS, CODE, COUNT, COUNTRY_CODE, DATA, DEFAULT_ENCRYPT, DETAIL, DISPLAY_NUM, DURATION, EMAIL, EMERGENCY_CONTACT, EMERGENCY_MOBILE, ENCRYPT, END_TIME, EXTEND, FEE, FLOW_PACKAGE, FLOW_STATUS, FROM, GMT_CREATED, HTTP_CHARSET, HTTP_CHARSET_DEFAULT, HTTP_CONN_MAXPERROUTE, HTTP_CONN_MAXPREROUTE, HTTP_CONN_MAXTOTAL, HTTP_CONN_TIMEOUT, HTTP_SO_TIMEOUT, HTTP_SSL_KEYSTORE, HTTP_SSL_PASSWD, INDUSTRYTYPE, IP_WHITELIST, ISONLYGLOBAL, LANG, LICENSE_URL, LONG_URL, MESSAGE_ID, MOBILE, MOBILE_STAT, MSG, NICK, NOTIFY, NOTIFY_TYPE, OLD_SIGN, PAGE_NUM, PAGE_SIZE, PROVIDER, REASON, RECORD_ID, REGISTER, RESULT, SEPERATOR_COMMA, SHORT_URL, SID, SIGN, SMS, SMS_REPLY, SMS_STATUS, SN, START_TIME, STAT, STAT_DURATION, TEMPLATE, TEXT, TIME, TO, TOTAL, TOTAL_COUNT, TOTAL_FEE, TPL_CONTENT, TPL_ID, TPL_VALUE, UID, UNIT, USER, VERSION_V1, VERSION_V2, VOICE_STATUS, YP_APIKEY, YP_CALL_HOST, YP_FILE, YP_FLOW_HOST, YP_SHORT_URL_HOST, YP_SIGN_HOST, YP_SMS_HOST, YP_TPL_HOST, YP_USER_HOST, YP_VERSION, YP_VOICE_HOST

Constructor Summary

Constructors

Constructor and Description
VoiceApi()

Method Summary

Modifier and Type	Method and Description
void	init(YunpianClient clnt)
protected VoiceSend	map2VoiceResult(Map<String,String> rsp)
String	name() Api名称,如UserApi的name就是https://sms.yunpian.com/v2/user/get.json里的user
Result<List<VoiceStatus>>	pull_status(Map<String,String> param) 获取状态报告
Result<VoiceSend>	send(Map<String,String> param) 发语音验证码
Result<VoiceSend>	tpl_notify(Map<String,String> param) 发送语音通知

Methods inherited from class com.yunpian.sdk.api.YunpianApi

apikey, apikey, charset, charset, client, code, equals, host, host, param2pair, path, path, post, post, post, post, result, toString, uri, urlEncode, urlEncode, version, version

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

VoiceApi

public VoiceApi()

Method Detail

name

public String name()

Description copied from class: YunpianApi

Api名称,如UserApi的name就是https://sms.yunpian.com/v2/user/get.json里的user

Specified by:

name in class YunpianApi

Returns:

init

public void init(YunpianClient clnt)

Overrides:

init in class YunpianApi

send

public Result<VoiceSend> send(Map<String,String> param)

发语音验证码

参数名 类型 是否必须 描述 示例

apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526

mobile String 是 接收的手机号、固话（需加区号） 15205201314 01088880000

code String 是 验证码，支持4~6位阿拉伯数字 1234

encrypt String 否 加密方式 使用加密 tea (不再使用)

_sign String 否 签名字段 参考使用加密 393d079e0a00912335adfe46f4a2e10f (不再使用)

callback_url String 否 本条语音验证码状态报告推送地址 http://your_receive_url_address

display_num String 否 透传号码，为保证全国范围的呼通率，云片会自动选择最佳的线路，透传的主叫号码也会相应变化。 如需透传固定号码则需要单独注册报备，为了确保号码真实有效，客服将要求您使用报备的号码拨打一次客服电话

Parameters:

param -

Returns:

tpl_notify

public Result<VoiceSend> tpl_notify(Map<String,String> param)

发送语音通知

参数名 类型 是否必须 描述 示例

apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526

mobile String 是 接收的手机号、固话（需加区号） 15205201314 01088880000

tpl_id Long 是 审核通过的模版ID 1136

tpl_value String 是 模版的变量值 如模版内容"课程#name#在#time#开始",那么这里的值为"name=计算机&time=17点",注意若出现特殊字符(如'=','&')则需要URLEncode内容

callback_url String 否 本条语音验证码状态报告推送地址 http://your_receive_url_address

Parameters:

param -

Returns:

pull_status

public Result<List<VoiceStatus>> pull_status(Map<String,String> param)

获取状态报告

参数名 是否必须 描述 示例

apikey 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526

page_size 否 每页个数，最大100个，默认20个 20

type Integer 否 拉取类型，1-语音验证码 2-语音通知，默认type=1 1

Parameters:

param -

Returns:

map2VoiceResult

protected VoiceSend map2VoiceResult(Map<String,String> rsp)