接口文檔

秒賽為開發(fā)者提供了詳細的API文檔和代碼示例，幫助開發(fā)者快速接入短信平臺

短信API接口文檔（適用于驗證碼/通知/營銷）

2019-09-04 11:39:24 欄目：API文檔 查看( )

在開發(fā)前，建議您先了解一下調(diào)用短信接口發(fā)送短信的操作流程：

 

1、注冊賬號：用戶接入秒賽科技短信功能，首先需要用戶在秒賽科技官網(wǎng)注冊賬號；立即注冊>>
 

2、身份認證：注冊后在用戶中心，完成身份認證信息（支持企業(yè)認證&個人認證）；
 

3、創(chuàng)建簽名和模板：

      在對應(yīng)的產(chǎn)品欄目的【簽名管理】-新增簽名，審核通過后即可調(diào)用；
      在對應(yīng)的產(chǎn)品欄目的【模板管理】-添加短信模板，審核通過即可調(diào)用；


（注：接口調(diào)用內(nèi)容需與審核通過的簽名、模板完全匹配才能發(fā)送，否則會報錯，提示：自動審核駁回）
 

5、接口對接：開發(fā)調(diào)試過程請查看下方 API文檔 和 代碼示例（支持PHP、Java、c#等各種開發(fā)語言），接入后可使用系統(tǒng)贈送的100條短信條數(shù)進行測試；
 

6、套餐充值：測試條數(shù)有限，未避免影響正常使用，測試成功后請盡快充值。

.....................................................................................................................................................................

以下是接口文檔正文：
 

 

一、普通短信發(fā)送
 

本文檔主要定了短信平臺對用戶開放的主要接口和定義。
 
用戶通過HTTP的Get,POST方式提交短信發(fā)送請求。

 

1.短信提交地址
 

驗證碼通知短信地址

http://139.196.108.241:8080/Api/HttpSendSMYzm.ashx

 

營銷短信地址 

http://139.196.108.241:8080/Api/HttpSendSMYx.ashx

 

語音驗證碼地址

http://139.196.108.241:8080/Api/HttpSendSMVoice.ashx

 

2.參數(shù)定義


序號 參數(shù) 說明
1 account 必填參數(shù)。用戶賬號
2 ts 可選參數(shù)，時間戳，格式y(tǒng)yyyMMddHHmmss
3 pswd 必填參數(shù)。用戶密碼，ts參數(shù)為空時填明文密碼，ts參數(shù)不為空時填md5(賬號+密碼+時間戳)，對賬號密碼時間戳拼接的字符串進行md5加密
4 mobile 必填參數(shù)。合法的手機號碼，號碼間用英文逗號分隔。最大50000個號碼
5 msg 必填參數(shù)。短信內(nèi)容，長度不能超過700個字符。使用URL方式編碼為UTF-8格式。短信內(nèi)容超過70個字符時，會被拆分成多條，然后以長短信的格式發(fā)送。
6 sms_sign 短信簽名。默認不需要傳，需要使用特定簽名時可添加此參數(shù)

 

3.短信提交響應(yīng)

用戶短信通過http請求提交到服務(wù)器后，服務(wù)器返回響應(yīng)

 

1）返回JSON格式說明

 

{

"result": 0,

"result_msg": "提交成功",

"msgid": "1670510103017877300",

"ts": "20180510103019"

}

result為響應(yīng)狀態(tài)（0表示成功，其他表示失?。?，result_msg 為提示消息，ts為響應(yīng)時間,msgid 為消息id,狀態(tài)匹配使用

2）響應(yīng)狀態(tài)值說明
 

代碼

說明

-1

一般錯誤

0

提交成功

101

無此用戶

102

密碼錯

103

提交過快（提交速度超過流速限制）

104

系統(tǒng)忙（因平臺側(cè)原因，暫時無法處理提交的短信）

105

敏感短信（短信內(nèi)容包含敏感詞）

106

消息長度錯（>700或<=0）

107

包含錯誤的手機號碼

108

手機號碼個數(shù)錯（>50000或<=0）

109

無發(fā)送額度（該用戶可用短信條數(shù)為0）

110

不在發(fā)送時間內(nèi)

111

超出該賬戶當月發(fā)送額度限制

112

無此產(chǎn)品，用戶沒有訂購該產(chǎn)品

115

自動審核駁回

116

簽名不合法，未帶簽名（用戶必須帶簽名的前提下）

117

IP地址認證錯,請求調(diào)用的IP地址不是系統(tǒng)登記的IP地址

118

用戶沒有相應(yīng)的發(fā)送權(quán)限

119

用戶已過期

120

內(nèi)容不在白名單模板中

 

4.注意事項

 

用戶群發(fā)短信如果有審核的限制，則客戶的短信必須經(jīng)過管理人員的審核，審核通過后才能被提交到行業(yè)網(wǎng)關(guān)進行短信實際發(fā)送。

 

5.短信發(fā)送例子

 

驗證碼發(fā)送:

http://139.196.108.241:8080/Api/HttpSendSMYzm.ashx?account=xx&pswd=xx&mobile=xx&msg=xx

 

營銷短信發(fā)送:

http://139.196.108.241:8080/Api/HttpSendSMYx.ashx?account=xx&pswd=xx&mobile=xx&msg=xx

 

語音驗證碼發(fā)送:

http://139.196.108.241:8080/Api/HttpSendSMVoice.ashx?account=xx&pswd=xx&mobile=xx&msg=xx


二、狀態(tài)報告推送
 

如果配置了賬戶的狀態(tài)報告接收地址，則用戶可以接收到其發(fā)送短信的狀態(tài)報告。用戶側(cè)啟動一個HTTP服務(wù)用于接收狀態(tài)報告。

使用HTTP GET方式推送狀態(tài)，每次一條。

 

1.參數(shù)定義

 

序號

參數(shù)

說明

1

receiver

接收狀態(tài)報告驗證的用戶名（不是賬戶名），是按照用戶要求配置的名稱，可以為空

2

pswd

接收狀態(tài)報告驗證的密碼，可以為空

3

msgid

提交短信時平臺返回的msgid，參見1.2

4

reportTime

格式YYMMDDhhmmss，其中YY=年份的最后兩位（00-99），MM=月份（01-12），DD=日（01-31），hh=小時（00-23），mm=分鐘（00-59）ss=秒(00-59)

5

mobile

單一的手機號碼

6

status

狀態(tài)報告數(shù)值

7

status_msg

狀態(tài)報告中文釋義


2.示例

 

http://pushUrl?receiver=admin&pswd=12345&msgid=1234567890&reportTime=1012241002&mobile=13900210021&status=DELIVRD&status_msg=發(fā)送成功

 

其中，pushUrl為用戶啟動的服務(wù)地址。

三、短信接收
 

1、參數(shù)定義

 

序號

參數(shù)

說明

1

receiver

接收信息驗證的用戶賬號

2

moTime

 

格式YYMMDDhhmmss，其中YY=年份的最后兩位（00-99），MM=月份（01-12），DD=日（01-31），hh=小時（00-23），mm=分鐘（00-59）ss=秒(0-59)

3

mobile

單一的手機號碼

4

msg

MO短信內(nèi)容，文字內(nèi)容使用UTF-8編碼

5

destcode

用戶上行的目的號碼

6

isems

是否為長短信的一部分，1:是，0，不是。

不帶該參數(shù)，默認為普通短信

7

emshead

Isems為1時，本參數(shù)以ASCII碼形式顯示長短信的頭信息。用“,”隔開，分為三個部分，第一部分標識該條長短信的ID（該ID為短信中心生成）；第二部分，表明該長短信的總條數(shù)（pk_total）；第三部分，該條短信為該長短信的第幾條(pk_number)。

例如：234,4,1，該短信的ID為234,該長短信的總長度為4條，1，當前為第一條。


2.示例

 

普通短信：

http://pushMoUrl?receiver=admin&pswd=12345&moTime=1208212205&destcode=1065751600001&mobile=13800210021&msg=hello

 

長短信短信：

http://pushMoUrl?receiver=admin&pswd=12345&moTime=1208212205&destcode=1065751600001&mobile=13800210021&msg=hello&isems=1&emshead=255,5,5

 

其中，pushUrl為用戶啟動的服務(wù)地址。

 

四、額度查詢接口
 

1.接口地址

http://139.196.108.241:8080/Api/ HttpQueryBalance.ashx

 

2.參數(shù)定義

 

序號

參數(shù)

說明

1

account

必填參數(shù)。用戶賬號

2

ts

可選參數(shù)，時間戳，格式y(tǒng)yyyMMddHHmmss

3

pswd

必填參數(shù)。用戶密碼，ts參數(shù)為空時填明文密碼，ts參數(shù)不為空時填md5(賬號+密碼+時間戳)，對賬號密碼時間戳拼接的字符串進行md5加密

 

3.提交響應(yīng)

 

1）JSON格式說明

{

"result": 0,

"ts": "20180510102315",

"products": [{

"product": "驗證碼/通知",

"num": 17907

}, {

"product": "營銷",

"num": 5072

}, {

"product": "語音驗證碼",

"num": 25

}]

}

result為響應(yīng)狀態(tài)（0表示成功，其他表示失?。? ts為響應(yīng)時間，products為產(chǎn)品列表（product為產(chǎn)品名稱, num為產(chǎn)品剩余條數(shù)。

 

4.提交響應(yīng)值

 

代碼

說明

0

成功

101

無此用戶

102

密碼錯

103

查詢過快（30秒查詢一次）

 

5.示例


http://139.196.108.241:8080/Api/HttpQueryBalance.ashx?account=XX&pswd=xx

 

微信掃一掃

認證、簽名模板審核結(jié)果通知

賬號短信余額不足提醒

平臺促銷活動及最新資訊

鄭重申明：①任何個人和或機構(gòu)在未經(jīng)過本人同意的情況下，不得擅自轉(zhuǎn)載或大段引用到網(wǎng)站或者第三方平臺使用，對于擅自盜用文章將通過法律訴訟途徑等一切手段來解決?、诓糠炙夭膩碓从诨ヂ?lián)網(wǎng)，如有侵權(quán),請聯(lián)系作者刪除!