调用说明

  1. 调用方式

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

注:

  1. 云片网为确保您的账户和信息安全,请在功能上线前进入后台添加您要使用的 IP 地址到IP 白名单列表
  2. 单个账号(APIKEY)调用接口限制 3000TPS(Transactions Per Second),需要额外资源请联系技术支持.

  3. 统一请求格式

BASE URL:

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

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

URL 格式:

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

说明:
{resource}为资源名,通常对应一类 API

{function}为该资源提供的操作方法

{format}表示请求响应的结果格式

比如查账户信息的 url 为:https://sms.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 白名单可以有效提高账户安全性
  • 请补充完整您的账户资料信息
    包括设置余额提醒阈值、联系人和紧急联系人的联系方式等账户信息,方便我们提供更好的服务

  • 提高发送速度建议

  • 配置合适的线程数,避免网络拥塞导致您延迟增加。不同带宽下,推荐使用的连接类型和线程数。

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

results matching ""

    No results matching ""