您在這里:文檔首頁 - 接口文檔

接口說明

用戶在遵循 HTTP協議的前提下,可通過GET和POST方式提交短信發送請求

短信提交地址
短信可以提交不超過 5000個手機號碼,每個號碼用英文逗號間隔。 (一次提交發送超過200個手機號碼,請使用POST請求)

URL 地址為:

     //116.62.212.142/msg/HttpBatchSendSM (群發接口)

     //116.62.212.142/msg/HttpSendSM (單發接口)

參數定義

序號

參數

說明

1

account

必填參數。用戶賬號

2

ts

可選參數,時間戳,格式 yyyyMMddHHmmss

3

pswd

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

4

mobile

必填參數。合法的手機號碼,號碼間用英文逗號分隔

5

msg

必填參數。短信內容,長度不能超過 700 個字符。使用 URL 方式編碼為 UTF-8 格式。短信內容超過 70 個字符時,會被拆分成多條,然后以長短信的格式發送。 內容格式:內容【自定義簽名】

6

needstatus

必填參數。是否需要狀態報告,取值 true 或 false , true ,表明需要狀態報告; false 不需要狀態報告

7

product

可選參數。用戶訂購的產品 id ,不填寫時使用用戶的默認產品,用戶訂購多個產品時必填,否則會發生計費錯誤。

8

extno

可選參數,擴展碼,用戶自定義擴展碼

9

resptype

可選參數,響應格式,默認返回文本格式,填 json 返回 json 格式

短信提交響應
用戶短信通過 http請求提交到服務器后,服務器返回響應碼,響應碼的格式如下:

resptime,respstatus

msgid

格式說明
短信提交響應分為兩行(每行以換行符 (0x0a,即\n)分割),第一行為響應時間和狀態,第二行為服務器給出提交msgid,一個發送請求只返回一個msgid。如果響應的狀態不是“0”,或者提交時needstatus不等于true,則沒有msgid,即第二行數據為空。

示例
提交成功

20110725160412,0

1234567890100

響應時間為 20110725160412,響應狀態為0 表明成功提交到服務器;1234567890100為返回的msgid,供狀態報告匹配時使用。

提交失敗

20110725160412,101

本示例表明用戶提交失敗,返回錯誤碼為 101,服務器端并未返回messageid。

響應狀態值說明

代碼

說明

0

提交成功

101

無此用戶

102

密碼錯

103

提交過快(提交速度超過流速限制)

104

系統忙(因平臺側原因,暫時無法處理提交的短信)

105

敏感短信(短信內容包含敏感詞)

106

消息長度錯(>700或<=0)

107

包含錯誤的手機號碼

108

手機號碼個數錯(群發>50000或<=0;單發>200或<=0)

109

無發送額度(該用戶可用短信數已使用完)

110

不在發送時間內

111

超出該賬戶當月發送額度限制

112

無此產品,用戶沒有訂購該產品

113

extno格式錯(非數字或者長度不對)

114

可用參數組個數錯誤(小于最小設定值或者大于1000)

115

自動審核駁回

116

簽名不合法,未帶簽名(用戶必須帶簽名的前提下)

117

IP地址認證錯,請求調用的IP地址不是系統登記的IP地址

118

用戶沒有相應的發送權限

119

用戶已過期

120

內容不在白名單模板中


注意事項
用戶群發短信如果有審核的限制,則客戶的短信必須經過管理人員的審核,審核通過后才能被提交到網關進行短信實際發送。
用戶群發短信必須滿足手機號碼最低個數的限制,低于系統設定的群發最小手機號碼數,則該提交請求會被拒絕,響應碼為 108。

短信發送例子

【您的簽名】您的發送內容

Ø 短信單發

//116.62.212.142/msg/HttpSendSM?account=111111&pswd=123456&mobile=18900000000,13800138000&msg=test【自定義簽名】 &needstatus=true&product=99999

Ø 短信群發

//116.62.212.142/msg/HttpBatchSendSM?account=test01&pswd=123456&mobile=18900000000,13800138000&msg=test【自定義簽名】 &needstatus=true&product=274463133

狀態報告推送
如果管理員設置用戶賬戶需要狀態報告,并且也配置了賬戶的狀態報告接收地址,則用戶可以接收到其發送短信的狀態報告。用戶側啟動一個 HTTP服務用于接收狀態報告。(使用HTTP GET方式推送狀態,每次一條)

參數定義

序號

參數

說明

1

receiver

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

2

pswd

接收狀態報告驗證的密碼,可以為空

3

msgid

提交短信時平臺返回的msgid,參見 普通短信發送 - 參數定義

4

reportTime

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

5

mobile

單一的手機號碼

6

status

狀態報告數值

狀態報告值
狀態報告的值即, status后面的數據,如下

狀態值(字符串)

說明

MBBLACK

黑名單號碼

NOROUTE

無通道

ROUTEERR

通道異常

REJECT

審核駁回

DISTURB

手機號碼發送次數過多

EMSERR

長短信不完整

SIGNERR

簽名錯

KEYWORD

敏感詞

其他

網關內部狀態

示例

//pushUrl?receiver=admin&pswd=12345&msgid=12345&reportTime=1012241002&mobile=13900210021&status=DELIVRD

其中, pushUrl為用戶啟動的服務地址。
在收到狀態報告后需要自己寫個方法去做處理收到的參數。

短信接收

參數定義

序號

參數

說明

1

receiver

接收信息驗證的用戶名(不是賬戶名),是按照用戶要求配置的名稱,可以為空

2

pswd

接收信息服務需驗證的密碼,可以為空

3

moTime

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

4

mobile

單一的手機號碼

5

msg

MO短信內容,文字內容使用UTF-8編碼

6

destcode

用戶上行的目的號碼

7

isems

是否為長短信的一部分,1:是,0,不是。不帶該參數,默認為普通短信

8

emshead

Isems為1時,本參數以ASCII碼形式顯示長短信的頭信息。用“,”隔開,分為三個部分,第一部分標識該條長短信的ID(該ID為短信中心生成);第二部分,表明該長短信的總條數(pk_total);第三部分,該條短信為該長短信的第幾條(pk_number)。 例如:234,4,1,該短信的ID為234,該長短信的總長度為4條,1,當前為第一條。

示例
普通短信:

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

其中, pushUrl為用戶啟動的服務地址。
在收到短信上行后需要自己寫個方法去做處理收到的參數。

額度查詢接口

接口地址

URL 地址為:

   //116.62.212.142/msg/QueryBalance

參數定義

序號

參數

說明

1

account

必填參數。用戶賬號

2

pswd

必填參數。用戶密碼

提交響應

20130303180000,0

1234567,1000

1234531,2000

第一行顯示返回額度時的時間,提交響應值。
第二行開始,每一行顯示一個產品 ID及其額度,有多少個產品顯示多少行。

提交響應值

代碼

說明

0

成功

101

無此用戶

102

密碼錯誤

103

查詢過快(30秒查詢一次)

示例

//116.62.212.142/msg/QueryBalance?un=111111&pw=123456

COPYRIGHT @ 2017-2018 深圳市麥訊通科技有限公司 ALL RIGHTS RESERVED. 備案號:粵ICP備08026943號

粵公網安備 44030702001630號

技術支持:百川網絡