调用说明

云片接口调用说明

调用方式

云片短信API是使用HTTP并遵循REST原则设计的Web服务接口,您可以使用几乎任何客户端和任何编程语言与REST API进行交互。通过发送简单的HTTP POST请求就可以轻松接入使用。

注:云片网为确保您的账户和信息安全,请在功能上线前进入后台添加您要使用的IP地址到 IP白名单列表中

统一请求格式

BASE URL:

https://{type}.yunpian.com/{version}

其中,{type}为业务类型,如短信为sms,语音为voice,流量为flow;{version}为版本号,如当前的版本号为v1

URL格式:

/{resource}/{function}.{format}

说明:
{resource}为资源名,通常对应一类API
{function}为该资源提供的操作方法
{format}表示请求响应的结果格式
比如查账户信息的url为:http://yunpian.com/v1/user/get.json 表示调用user的get方法,并且返回json格式的字符串。 我们目前已经提供的接口,请参考API。

HTTP头信息:

Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;

说明:
请求方式(Method):统一用POST方式
编码:UTF-8
最佳实践:
 •请使用发短信接口
    可以自动匹配模板,开发更简单
 •请设置好IP白名单
    IP白名单可以有效提高账户安全性
 •请补充完整您的账户资料信息
    包括设置余额提醒阈值、联系人和紧急联系人的联系方式等账户信息,方便我们提供更好的服务

提高发送速度建议

1)使用长连接代替短连接,减少TCP连接建立过程中不必要的消耗。
2)推荐您使用批量发送或者multi_send接口,进一步降低网络消耗。
3)配置合适的线程数,避免网络拥塞导致您延迟增加。不同带宽下,推荐使用的连接类型和线程数:

客户端带宽 连接类型 客户端最优线程
1M 长连接 10
5M 长连接 100
15M 长连接 150
50M 长连接 200

注:如果您的发送速度达不到预期,可联系我们技术支持协助。

4)海外用户可以调用海外服务器地址 us.yunpian.com ,获得更快的请求和处理速度。例如使用短信接口时,将 sms.yunpian.com 替换为 us.yunpian.com 即可。