SmsApi (yunpian-java-sdk 1.2.5 API)

java.lang.Object
- com.yunpian.sdk.api.YunpianApi
- - com.yunpian.sdk.api.SmsApi

All Implemented Interfaces:

YunpianApiResult, YunpianConstant
```
public class SmsApi
extends YunpianApi
```
https://www.yunpian.com/api2.0/api-domestic.html

Since:

1.2.0

Author:

dzh

creation class date

Nov 23, 2016 1:12:05 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

Fields
Modifier and Type	Field and Description
`static String`	`NAME`

Constructor Summary

Constructors
Constructor and Description

SmsApi()

Constructors
Constructor and Description
`SmsApi()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Result<SmsBatchSend>`	`batch_send(Map<String,String> param)` 批量发送
`Result<Integer>`	`count(Map<String,String> param)` 统计短信条数
`Result<List<String>>`	`get_black_word(Map<String,String> param)` 查屏蔽词
`Result<List<SmsRecord>>`	`get_record(Map<String,String> param)` 查短信发送记录
`Result<List<SmsReply>>`	`get_reply(Map<String,String> param)` 查回复的短信
`void`	`init(YunpianClient clnt)`
`protected SmsBatchSend`	`map2SendBatchSmsInfo(Map<String,String> rsp)`
`protected SmsSingleSend`	`map2SendSingleSmsInfo(Map<String,String> rsp)`
`Result<List<Result<SmsSingleSend>>>`	`multi_send_v1(Map<String,String> param)` /v1/sms/multi_send.json
`Result<SmsBatchSend>`	`multi_send(Map<String,String> param)` 个性化发送
`String`	`name()` Api名称,如UserApi的name就是https://sms.yunpian.com/v2/user/get.json里的user
`Result<List<SmsReply>>`	`pull_reply(Map<String,String> param)` 获取回复短信
`Result<List<SmsStatus>>`	`pull_status(Map<String,String> param)` 获取状态报告
`Result<Void>`	`reg_complete(Map<String,String> param)` 注册成功回调 only v2
`Result<SmsSingleSend>`	`send(Map<String,String> param)` Deprecated.
`Result<SmsSingleSend>`	`single_send(Map<String,String> param)` 单条发送
`Result<SmsBatchSend>`	`tpl_batch_send(Map<String,String> param)` Deprecated.
`Result<SmsSingleSend>`	`tpl_send(Map<String,String> param)` Deprecated.
`Result<SmsSingleSend>`	`tpl_single_send(Map<String,String> param)` Deprecated.

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
  - SmsApi
```
public SmsApi()
```
- 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
```
@Deprecated
public Result<SmsSingleSend> send(Map<String,String> param)
```
    Deprecated.
    
    智能匹配模板发送 only v1
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 是接收的手机号;发送多个手机号请以逗号分隔，一次不要超过1000个国际短信仅支持单号码发送，国际号码需包含国际地区前缀号码，格式必须是"+"号开头("+"号需要urlencode处理，否则会出现格式错误)，国际号码不以"+"开头将被认为是中国地区的号码（针对国际短信，mobile参数会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见： https://en.wikipedia.org/wiki/E.164）单号码：15205201314 多号码：15205201314,15205201315 国际短信：+93701234567
    
    text String 是短信内容【云片网】您的验证码是1234
    
    extend String 否扩展号。默认不开放，如有需要请联系客服申请 001
    
    uid String 否该条短信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含这个ID 默认不开放，如有需要请联系客服申请 10001
    
    callback_url String 否本条短信状态报告推送地址。短信发送后将向这个地址推送短信发送报告。"后台-系统设置-数据推送与获取”可以做批量设置。如果后台已经设置地址的情况下，单次请求内也包含此参数，将以请求内的推送地址为准。
    
    Parameters:
    
    param -
    
    Returns:
  - single_send
```
public Result<SmsSingleSend> single_send(Map<String,String> param)
```
    单条发送
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 是接收的手机号；仅支持单号码发送；国际号码需包含国际地区前缀号码，格式必须是"+"号开头("+"号需要urlencode处理，否则会出现格式错误)，国际号码不以"+"开头将被认为是中国地区的号码（针对国际短信，mobile参数会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见： https://en.wikipedia.org/wiki/E.164）国内号码：15205201314 国际号码：urlencode("+93701234567");
    
    text String 是短信内容【云片网】您的验证码是1234
    
    extend String 否扩展号。默认不开放，如有需要请联系客服申请 001
    
    uid String 否该条短信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含这个ID 默认不开放，如有需要请联系客服申请 10001
    
    callback_url String 否本条短信状态报告推送地址。短信发送后将向这个地址推送短信发送报告。"后台-系统设置-数据推送与获取”可以做批量设置。如果后台已经设置地址的情况下，单次请求内也包含此参数，将以请求内的推送地址为准。 http://your_receive_url_address
    
    register Boolean 否是否为注册验证码短信，如果传入true，则该条短信作为注册验证码短信统计注册成功率。默认不开放，如有需要请联系客服申请 true
    
    mobile_stat Boolean 否按手机号统计短链接点击量，为手机号生成专属短链接，并自动替换短信中的短链接（限yp2.cn）。 true
    
    Parameters:
    
    param -
    
    Returns:
  - batch_send
```
public Result<SmsBatchSend> batch_send(Map<String,String> param)
```
    批量发送
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 是接收的手机号；发送多个手机号请以逗号分隔，一次不要超过1000个。单号码：15205201314 多号码：15205201314,15205201315
    
    text String 是短信内容【云片网】您的验证码是1234
    
    extend String 否扩展号。默认不开放，如有需要请联系客服申请 001
    
    uid String 否该条短信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含这个ID 默认不开放，如有需要请联系客服申请 10001
    
    callback_url String 否本条短信状态报告推送地址。短信发送后将向这个地址推送短信发送报告。"后台-系统设置-数据推送与获取”可以做批量设置。如果后台已经设置地址的情况下，单次请求内也包含此参数，将以请求内的推送地址为准。 http://your_receive_url_address
    
    Parameters:
    
    param -
    
    Returns:
  - multi_send
```
public Result<SmsBatchSend> multi_send(Map<String,String> param)
```
    个性化发送
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 是接收的手机号；多个手机号请以逗号分隔，一次不要超过1000个且手机号个数必须与短信内容条数相等；不支持国际号码发送；多号码：15205201314,15205201315
    
    text String 是短信内容，多个短信内容请使用UTF-8做urlencode后，使用逗号分隔，一次不要超过1000条且短信内容条数必须与手机号个数相等内容示意：UrlEncode("【云片网】您的验证码是1234", "UTF-8") + "," + UrlEncode("【云片网】您的验证码是5678", "UTF-8")
    
    extend String 否扩展号。默认不开放，如有需要请联系客服申请 001
    
    uid String 否该条短信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含这个ID 默认不开放，如有需要请联系客服申请 10001
    
    callback_url String 否本条短信状态报告推送地址。短信发送后将向这个地址推送短信发送报告。"后台-系统设置-数据推送与获取”可以做批量设置。如果后台已经设置地址的情况下，单次请求内也包含此参数，将以请求内的推送地址为准。 http://your_receive_url_address
    
    Parameters:
    
    param -
    
    Returns:
  - multi_send_v1
```
public Result<List<Result<SmsSingleSend>>> multi_send_v1(Map<String,String> param)
```
    /v1/sms/multi_send.json
    
    Parameters:
    
    param -
    
    Returns:
  - pull_status
```
public Result<List<SmsStatus>> pull_status(Map<String,String> param)
```
    获取状态报告
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    page_size Integer 否每页个数，最大100个，默认20个 20
    
    Parameters:
    
    param -
    
    Returns:
  - pull_reply
```
public Result<List<SmsReply>> pull_reply(Map<String,String> param)
```
    获取回复短信
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    page_size Integer 否每页个数，最大100个，默认20个 20
    
    Parameters:
    
    param -
    
    Returns:
  - get_reply
```
public Result<List<SmsReply>> get_reply(Map<String,String> param)
```
    查回复的短信
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    start_time String 是短信回复开始时间 2013-08-11 00:00:00
    
    end_time String 是短信回复结束时间 2013-08-12 00:00:00
    
    page_num Integer 是页码，默认值为1 1
    
    page_size Integer 是每页个数，最大100个 20
    
    mobile String 否填写时只查该手机号的回复，不填时查所有的回复 15205201314
    
    return_fields 否返回字段（暂未开放
    
    sort_fields 否排序字段（暂未开放）默认按提交时间降序
    
    Parameters:
    
    param -
    
    Returns:
  - get_black_word
```
public Result<List<String>> get_black_word(Map<String,String> param)
```
    查屏蔽词
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    text String 是要检查的短信模板或者内容这是一条测试短信
    
    Parameters:
    
    param -
    
    Returns:
  - get_record
```
public Result<List<SmsRecord>> get_record(Map<String,String> param)
```
    查短信发送记录
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 否需要查询的手机号 15205201314
    
    start_time String 是短信发送开始时间 2013-08-11 00:00:00
    
    end_time String 是短信发送结束时间 2013-08-12 00:00:00
    
    page_num Integer 否页码，默认值为1 1
    
    page_size Integer 否每页个数，最大100个 20
    
    Parameters:
    
    param -
    
    Returns:
  - count
```
public Result<Integer> count(Map<String,String> param)
```
    统计短信条数
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    start_time String 是短信发送开始时间 2013-08-11 00:00:00
    
    end_time String 是短信发送结束时间 2013-08-12 00:00:00
    
    mobile String 否需要查询的手机号 15205201314
    
    page_num Integer 否页码，默认值为1 1
    
    page_size Integer 否每页个数，最大100个 20
    
    Parameters:
    
    param -
    
    Returns:
  - tpl_send
```
@Deprecated
public Result<SmsSingleSend> tpl_send(Map<String,String> param)
```
    Deprecated.
    
    指定模板发送 only v1
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 是接收的手机号 15205201314
    
    tpl_id Long 是模板id 1
    
    tpl_value String 是变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考：代码示例。注：变量名和变量值都不能为空模板：【#company#】您的验证码是#code#。最终发送结果：【云片网】您的验证码是1234。 tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"); 若您直接发送报文请求则使用下面这种形式 tplvalue=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"));
    
    extend String 否扩展号。默认不开放，如有需要请联系客服申请 001
    
    uid String 否用户自定义唯一id。最大长度不超过256的字符串。默认不开放，如有需要请联系客服申请 10001
    
    Parameters:
    
    param -
    
    Returns:
  - tpl_single_send
```
@Deprecated
public Result<SmsSingleSend> tpl_single_send(Map<String,String> param)
```
    Deprecated.
    
    指定模板单发 only v2
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 是接收的手机号（针对国际短信，mobile参数会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见： https://en.wikipedia.org/wiki/E.164） 15205201314
    
    tpl_id Long 是模板id 1
    
    tpl_value String 是变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考：代码示例。注：变量名和变量值都不能为空模板：【#company#】您的验证码是#code#。最终发送结果：【云片网】您的验证码是1234。 tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"); 若您直接发送报文请求则使用下面这种形式 tplvalue=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"));
    
    extend String 否扩展号。默认不开放，如有需要请联系客服申请 001
    
    uid String 否用户自定义唯一id。最大长度不超过256的字符串。默认不开放，如有需要请联系客服申请 10001
    
    Parameters:
    
    param -
    
    Returns:
  - tpl_batch_send
```
@Deprecated
public Result<SmsBatchSend> tpl_batch_send(Map<String,String> param)
```
    Deprecated.
    
    指定模板群发 only v2
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 是接收的手机号（针对国际短信，mobile参数会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见： https://en.wikipedia.org/wiki/E.164） 15205201314
    
    tpl_id Long 是模板id 1
    
    tpl_value String 是变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考：代码示例。注：变量名和变量值都不能为空模板：【#company#】您的验证码是#code#。最终发送结果：【云片网】您的验证码是1234。 tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"); 若您直接发送报文请求则使用下面这种形式 tplvalue=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"));
    
    extend String 否扩展号。默认不开放，如有需要请联系客服申请 001
    
    uid String 否用户自定义唯一id。最大长度不超过256的字符串。默认不开放，如有需要请联系客服申请 10001
    
    Parameters:
    
    param -
    
    Returns:
  - reg_complete
```
public Result<Void> reg_complete(Map<String,String> param)
```
    注册成功回调 only v2
    
    参数名类型是否必须描述示例
    
    apikey String 是用户唯一标识 9b11127a9701975c734b8aee81ee3526
    
    mobile String 是注册成功的手机号，请和调用接口的手机号一致 15205201314
    
    time String 否注册成功的时间，格式yyyy-MM-dd HH:mm:ss，可以是一天前，超过时间无法记录，默认当前时间 2017-03-15 18:30:00
    
    如果需要更准确的注册成功数据（排除找回密码等类型验证码产生的数据），在注册页调用 single_send.json 接口时带上参数“register”（布尔类型），值为“true”，则该条短信会被认定为注册验证码短信。此功能需联系客服开通。
    
    Parameters:
    
    param -
    
    Returns:
    
    See Also:
    
    single_send(Map)
  - map2SendBatchSmsInfo
```
protected SmsBatchSend map2SendBatchSmsInfo(Map<String,String> rsp)
```
  - map2SendSingleSmsInfo
```
protected SmsSingleSend map2SendSingleSmsInfo(Map<String,String> rsp)
```

Class SmsApi

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

NAME

Constructor Detail

SmsApi

Method Detail

name

init

send

智能匹配模板发送 only v1

single_send

单条发送

batch_send

批量发送

multi_send

个性化发送

multi_send_v1

pull_status

获取状态报告

pull_reply

获取回复短信

get_reply

查回复的短信

get_black_word

查屏蔽词

get_record

查短信发送记录

count

统计短信条数

tpl_send

指定模板发送 only v1

tpl_single_send

指定模板单发 only v2

tpl_batch_send

指定模板群发 only v2

reg_complete

注册成功回调 only v2

map2SendBatchSmsInfo

map2SendSingleSmsInfo