調(diào)用說明
云片短信 API 是使用 HTTP 并遵循 REST 原則設(shè)計的 Web 服務(wù)接口,您可以使用幾乎任何客戶端和任何編程語言與 REST API 進(jìn)行交互。通過發(fā)送簡單的 HTTP POST 請求就可以輕松接入使用。
注:
- 云片網(wǎng)為確保您的賬戶和信息安全,請在功能上線前進(jìn)入后臺添加您要使用的 IP 地址到IP 白名單列表中
- 單個賬號(APIKEY)調(diào)用接口限制3000TPS(Transactions Per Second),需要額外資源請聯(lián)系技術(shù)支持.
統(tǒng)一請求格式
BASE URL:
https://{type}.yunpian.com/{version}
其中,{type}為業(yè)務(wù)類型,如短信為 sms,語音為 voice;{version}為版本號,如當(dāng)前的版本號為 v2
URL 格式:
/{resource}/{function}.{format}
說明:
- {resource}為資源名,通常對應(yīng)一類 API
- {function}為該資源提供的操作方法
- {format}表示請求響應(yīng)的結(jié)果格式
比如查賬戶信息的 url 為:https://sms.yunpian.com/v2/user/get.json 表示調(diào)用 user 的 get 方法,并且返回 json 格式的字符串。 我們目前已經(jīng)提供的接口,請參考 API。
HTTP 頭信息:
Accept:application/json;charset=utf-8; Content-Type:application/x-www-form-urlencoded;charset=utf-8;
**說明:``
Http Method:統(tǒng)一用 POST 方式 編碼:UTF-8 支持 https 與 http 兩種訪問,建議使用 https
最佳實(shí)踐:
- 請使用發(fā)短信接口: 可以自動匹配模板,開發(fā)更簡單
- 請設(shè)置好 IP 白名單: IP 白名單可以有效提高賬戶安全性
- 請補(bǔ)充完整您的賬戶資料信息: 包括設(shè)置余額提醒閾值、聯(lián)系人和緊急聯(lián)系人的聯(lián)系方式等賬戶信息,方便我們提供更好的服務(wù)
提高發(fā)送速度建議
- 配置合適的線程數(shù),避免網(wǎng)絡(luò)擁塞導(dǎo)致您延遲增加。不同帶寬下,推薦使用的連接類型和線程數(shù)。
- 海外用戶可以調(diào)用海外服務(wù)器地址 us.yunpian.com,獲得更快的請求和處理速度。例如使用短信接口時,將 sms.yunpian.com 替換為 us.yunpian.com 即可。