yunpian / yunpian-java-sdk

The https://www.yunpian.com java sdk.

yunpian-java-sdk

云片 SDK

快速开始

• 添加Maven依赖

<dependency>
    <groupId>com.yunpian.sdk</groupId>
    <artifactId>yunpian-java-sdk</artifactId>
    <version>1.2.7</version>
</dependency>

注: 可以在Maven获取

• 使用YunpianClient

//初始化clnt,使用单例方式
YunpianClient clnt = new YunpianClient("apikey").init();

//发送短信API
Map<String, String> param = clnt.newParam(2);
param.put(YunpianClient.MOBILE, "18616020***");
param.put(YunpianClient.TEXT, "【云片网】您的验证码是1234");
Result<SmsSingleSend> r = clnt.sms().single_send(param);
//获取返回结果，返回码:r.getCode(),返回码描述:r.getMsg(),API结果:r.getData(),其他说明:r.getDetail(),调用异常:r.getThrowable()

//账户:clnt.user().* 签名:clnt.sign().* 模版:clnt.tpl().* 短信:clnt.sms().* 语音:clnt.voice().* 流量:clnt.flow().* 隐私通话:clnt.call().*

//释放:clnt.close() 释放后clnt将无法再使用

注: v1.2开始使用YunpianClient，做了重新设计，改进性能、扩展性、便利性等。兼容v1.1.*版本，YunpianRestClient暂时保留,请尽快升级。

配置说明 (默认配置就行)

• 默认配置文件 src/main/resources/yunpian.properties
• 自定义配置方式
  • 构造器方式，如new YunpianClient(String apikey, String file)
  • 系统属性，如-Dyp.apikey=apikey -Dyp.file=配置文件路径
• apikey的优先级 接口级 > 默认值(YunpianConf.getApikey())

源码说明 yunpian-java-sdk

• 工程使用maven构造，jdk1.7 or higher
• 开发API可参考单元测试 test/com.yunpian.sdk.api
• YunpianClient使用单例方式，不要每次new和close
• 不推荐使用标注@Deprecated类
• 分支说明: master是发布版本,develop是待发布的分支(开源贡献可以pull request到develop)

联系我们

云片支持 QQ

SDK开源QQ群

文档链接

• api文档

yunpian-java-sdk's Issues

如何覆盖配置文件中的值

服务器在美国，调用国内云片服务器会有很大延迟。使用jar包或maven可以如下覆盖配置项：

import java.util.Properties;
// ..........

Properties prop = new Properties();
prop.setProperty("yp.user.host","https://us.yunpian.com");
prop.setProperty("yp.sign.host","https://us.yunpian.com");
prop.setProperty("yp.tpl.host","https://us.yunpian.com");
prop.setProperty("yp.sms.host","https://us.yunpian.com");
prop.setProperty("yp.short_url.host","https://us.yunpian.com");

//初始化clnt,使用单例方式
YunpianClient clnt = new YunpianClient("5dd0287******apikey*****900441", prop).init();

根据ID获取模版报异常

根据接口文档，传了模版ID的时候，应该返回的是单个对象，不传时，返回的是一个数组。根据java-sdk里面的接口定义，两种情况下返回的都是数组。现在在传了模版ID之后会报json异常。

ResultDO{data=null, success=false, e=com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: Expected BEGIN_ARRAY but was BEGIN_OBJECT at line 1 column 2 path $}

public ResultDO<List<TemplateInfo>> get(final String tplId) {
        return send(Config.URI_GET_TPL_SMS, new HashMap<String, String>() {{
            put(YunpianConstants.TPL_ID, tplId);
        }}, new TypeToken<List<TemplateInfo>>() {
        }.getType());
    }

    public ResultDO<List<TemplateInfo>> get() {
        return get("");
    }

短信内容有英文单词时，发送不成功，见图

用的是readme里面的方法发送：

//初始化clnt,使用单例方式
YunpianClient clnt = new YunpianClient("apikey").init();

//发送短信API
Map<String, String> param = clnt.newParam(2);
param.put(YunpianClient.MOBILE, "18616020***");
param.put(YunpianClient.TEXT, "【云片网】您的验证码是1234");
Result<SmsSingleSend> r = clnt.sms().single_send(param);
//获取返回结果，返回码:r.getCode(),返回码描述:r.getMsg(),API结果:r.getData(),其他说明:r.getDetail(),调用异常:r.getThrowable()

//账户:clnt.user().* 签名:clnt.sign().* 模版:clnt.tpl().* 短信:clnt.sms().* 语音:clnt.voice().* 流量:clnt.flow().* 隐私通话:clnt.call().*

//释放clnt
clnt.close() 

只是内容中包含英文字母，就发送失败

YunpianClient是否线程安全

RT

问题：使用了SDK之后系统日志输出跑到了tomcat目录之下，怎么改变呢？

没有使用云片SDK之前，日志都在tomcat的logs目录下保存，单现在用了SDK，发现原先的配置没有用了，日志保存在tomcat目录下面了。

关于直接发短信验证码变量未直接替换问题

使用接口：指定模板单发
使用模板样式：【#company#】验证码#code#,您正在进行#option#,#eftime#有效。若非本人操作，请勿泄露。
请求参数：apikey=XXXXXXXXX&tpl_id=25525&mobile=139***********&tpl_value=#code#=1342&#eftime#=10%E5%88%86%E9%92%9F&#company#=%E4%BC%97%E5%BA%B7%E4%BA%91&#option#=%E6%BF%80%E6%B4%BB%E8%B4%A6%E6%88%B7
如果发送错误：解析出来的结果如下

发送成功用户收到的样式：
只替换掉了company,code两个变量，option和eftime没有替换成功。结果为：
【签名】验证码1523,您正在进行#option#,#eftime#有效。若非本人操作，请勿泄露。
上面为问题反馈，虽然可以通过单发接口发送想要的样式。遇到了还是给你们说下。
另外不得不吐槽下你们的售后，态度太牛逼了。
给它各种说明情况，叫给查一下问题，然后说自己弄的不对。最气的是最后来一句自己百度怎么替换变量。

官网sdk的实例为什么和git不同步

官网sdk的实例为什么和git不同步，还在用着YunpianRestClient，我在使用国际短信，搞不清楚你的API究竟是哪个？

model包里面的类没有实现Serializable接口

model包里面基础类都没有实现序列化接口，在分布式环境下，对这些类的实例进行传递时，会出问题

希望有获取签名状态的API

maven version is 1.1.3, not 1.1.2 in README.md

look here:
http://mvnrepository.com/artifact/com.yunpian.sdk/yunpian-java-sdk
please update it.

为什么调用new SmsApi().single_send(params)会失败

Map<String, String> params = new HashMap<String, String>();
params.put("apikey", "xxxxxxxxxxxxxxxxxxx");
params.put("text", text);
params.put("mobile", mobile);
Result result = new SmsApi().single_send(params);

为什么会失败，失败的原因是YunpianApi 的uri()方法报空指针异常？还需要加什么参数呢？

com.yunpian.sdk.model.SmsStatus

应该新增字段： error_detail

少了签名API

log4j配置文件被重置，导致项目本身的日志文件不再记录

common.Config.java中有强制重新设置log4j配置文件的static代码，建议去掉这块否则会对用户自身项目造成干扰，无法正常记录日志。

1.2.x相比1.1.x变化太大了

没有简略的使用文档吗？我看了下基本上完全不兼容1.1.x了啊

关于指定模板单发和指定模板群发

关于指定模板单发和指定模板群发

这两个都被弃用了，没有指定替代方法或者是相关解释，请问，该如何使用指定模板发送短信相关功能？

指定模板单发

指定模板群发

sdk可以支持代理吗，内网访问不通云片网