com.yunpian.sdk.api

Class FlowApi

java.lang.Object

com.yunpian.sdk.api.YunpianApi

com.yunpian.sdk.api.FlowApi

All Implemented Interfaces:

YunpianApiResult, YunpianConstant

public class FlowApi
extends YunpianApi

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

Since:

1.2.0

Author:

dzh

creation class date

Nov 23, 2016 1:13:27 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
FlowApi()

Method Summary

Modifier and Type	Method and Description
Result<List<FlowPackage>>	get_package(Map<String,String> param) 查询流量包
void	init(YunpianClient clnt)
protected FlowSend	map2flowResult(Map<String,String> rsp)
String	name() Api名称,如UserApi的name就是https://sms.yunpian.com/v2/user/get.json里的user
Result<List<FlowStatus>>	pull_status(Map<String,String> param) 获取状态报告
Result<FlowSend>	recharge(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

FlowApi

public FlowApi()

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

get_package

public Result<List<FlowPackage>> get_package(Map<String,String> param)

查询流量包

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

apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526

carrier String 否 运营商ID 传入该参数则获取指定运营商的流量包， 否则获取所有运营商的流量包 移动：10086 联通：10010 电信：10000

Parameters:

param -

Returns:

recharge

public Result<FlowSend> recharge(Map<String,String> param)

充值流量

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

apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526

mobile String 是 接收的手机号（仅支持大陆号码） 15205201314

sn String 是 流量包的唯一ID 点击查看 1008601

callback_url String 否 本条流量充值的状态报告推送地址 http://your_receive_url_address

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

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

Parameters:

param -

Returns:

pull_status

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

获取状态报告

参数名 是否必须 描述 示例

apikey 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526

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

Parameters:

param -

Returns:

map2flowResult

protected FlowSend map2flowResult(Map<String,String> rsp)