com.yunpian.sdk.api

Class ShortUrlApi

java.lang.Object

com.yunpian.sdk.api.YunpianApi

com.yunpian.sdk.api.ShortUrlApi

All Implemented Interfaces:

YunpianApiResult, YunpianConstant

public class ShortUrlApi
extends YunpianApi

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

Since:

1.2.5

Author:

liujie

creation class date

2017/9/29

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
ShortUrlApi()

Method Summary

Modifier and Type	Method and Description
void	init(YunpianClient clnt)
String	name() Api名称,如UserApi的name就是https://sms.yunpian.com/v2/user/get.json里的user
Result<ShortUrl>	shorten(Map<String,String> param) 生成短链接 only v2
Result<Map<String,Long>>	stat(Map<String,String> param) 获取短链接统计 only v2

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

ShortUrlApi

public ShortUrlApi()

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

shorten

public Result<ShortUrl> shorten(Map<String,String> param)

生成短链接 only v2

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

apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526

long_url String 是 待转换的长网址，必须http://或https://开头 https://www.yunpian.com

stat_duration Integer 否 点击量统计持续时间（天），过期后不再统计，区间[0,30]，0表示不统计，默认30 30

provider Integer 否 生成的链接的域名，传入1是yp2.cn，2是t.cn，默认1 1

name String 否 取名方便区分，默认为“MM-dd HH:mm生成的短链接” yunpian

Parameters:

param -

Returns:

stat

public Result<Map<String,Long>> stat(Map<String,String> param)

获取短链接统计 only v2

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

apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526

sid String 是 短链接唯一标识 ckAclC

start_time String 否 开始时间，默认一个小时前 2017-03-29 11:30:00

end_time String 否 结束时间，默认当前时间 2017-03-29 12:10:00

Parameters:

param -

Returns: