API 概覽
概覽
本文檔中列出的所有 API 基礎(chǔ)調(diào)用 URL 是 https://api-v4.mysubmail.com
( 如 API:voice/xsend
實(shí)際請(qǐng)求 URL https://api-v4.mysubmail.com/voice/xsend
) 。SUBMAIL 支持 json
(默認(rèn)) 和 xml
格式,如果你想要 API 返回碼的格式為 xml
,請(qǐng)?jiān)?完整 URL 的末尾加上 .xml
。
API URL 規(guī)則 :
https://api-v4.mysubmail.com/[model]/[function].[format]
RESTful API
SUBMAIL API 基于 RESTful API 風(fēng)格,它具備完整的 HTTP 請(qǐng)求規(guī)范,多數(shù)的 SUBMAIL API 需采用 POST 方式發(fā)送請(qǐng)求,少量的服務(wù)類(lèi) API 使用 GET 方式獲取數(shù)據(jù)。除 API 列舉的請(qǐng)求方式外,其他方法都不被支持。
繼承 RESTful API 風(fēng)格,所有的 SUBMAIL API 都具有 HTTP 返回代碼
2XX
- 請(qǐng)求成功。4XX
- 請(qǐng)求失敗。(具體出錯(cuò)原因,會(huì)在返回?cái)?shù)據(jù)中標(biāo)注錯(cuò)誤代碼和原因)5XX
- 服務(wù)器錯(cuò)誤。
參閱 HTTP 狀態(tài)碼 | API 錯(cuò)誤代碼
SUBMAIL WEB API
- voice/send ( 基礎(chǔ)語(yǔ)音發(fā)送 API )
- voice/xsend( 增強(qiáng)的語(yǔ)音發(fā)送 API )
- voice/multixsend( 語(yǔ)音群發(fā)API)
- voice/verify (語(yǔ)音驗(yàn)證碼API)
- balance/voice (語(yǔ)音余額API )
創(chuàng)建應(yīng)用
在使用 SUBMAIL API 之前,您需要創(chuàng)建 APP ID 。
點(diǎn)擊了解 創(chuàng)建/管理 APP ID 指南 。