超碰人妻在线,优优色影院,色视频在线看,亚洲国产成在人网站天堂

HTTP(S)短信接口開發(fā)文檔

第一章 接入說明

1.1 API基路徑

接口統(tǒng)一訪問地址:{API基路徑}/service/httpService/httpInterface.do

API基路徑說明:

請(qǐng)求 API基路徑 說明
HTTP http://*:* 接入時(shí)客服提供接口參數(shù)
HTTP+SSL https://*:* 接入時(shí)客服提供接口參數(shù)

1.2 接口參數(shù)說明

聯(lián)系客服獲取短信帳號(hào)接入?yún)?shù)。

參數(shù) 名稱 說明
method 接口方法 一個(gè)接口對(duì)應(yīng)一個(gè)固定方法名,詳情說明見各接口說明。 getAmount:獲取賬戶余額接口 sendMsg、sendUtf8Msg、sendGbkMsg:短信發(fā)送接口 queryReport:獲取短信狀態(tài)報(bào)告 queryMo:獲取上行短信
username 用戶賬號(hào)
password 用戶密碼
veryCode 通信key(通信認(rèn)證密碼)

1.3 接口對(duì)接規(guī)范

  1. 請(qǐng)勿在瀏覽器直接測(cè)試,因?yàn)槭転g覽器編碼影響,建議采用代碼或postman工具調(diào)試。
  2. 采用HTTP POST方式,請(qǐng)求參數(shù)寫入HTTP請(qǐng)求體,不建議拼接在url后面。
  3. Content-type:application/x-www-form-urlencoded
  4. 參考開發(fā)示例代碼進(jìn)行修改調(diào)試。

第二章、賬號(hào)余額接口

獲取短信賬號(hào)的余額(短信條數(shù)=余額*10)。

2.1 請(qǐng)求地址

{API基路徑}/service/httpService/httpInterface.do

2.2 參數(shù)說明

參數(shù) 名稱 說明
method 接口方法 一個(gè)接口對(duì)應(yīng)一個(gè)固定方法名,詳情說明見各接口說明。 getAmount:獲取賬戶余額接口 sendMsg、sendUtf8Msg、sendGbkMsg:短信發(fā)送接口 queryReport:獲取短信狀態(tài)報(bào)告 queryMo:獲取上行短信
username 用戶賬號(hào)
password 用戶密碼
veryCode 通信key(通信認(rèn)證密碼)
返回值說明:
參數(shù)名稱 含義 說明
method 查詢余額 查詢余額,固定為getAmount
username 用戶賬號(hào) 用戶賬號(hào)
password 用戶密碼 用戶密碼
veryCode 通信認(rèn)證密碼
rt 響應(yīng)數(shù)據(jù)格式 xml、json 默認(rèn):xml
示例(實(shí)際對(duì)接請(qǐng)參考《1.3 接口對(duì)接規(guī)范》):
http(s)://*:*/service/httpService/httpInterface.do?method=getAmount&username=JSM001&password=123&veryCode=456

2.3返回值

XML響應(yīng)數(shù)據(jù)格式:
<?xml version="1.0" encoding="UTF-8" ?>

    
    0		--返回狀態(tài)值:成功返回0 失敗返回:失敗代碼
    5000	--當(dāng)status為0時(shí),會(huì)出現(xiàn)該屬性
    

JSON數(shù)據(jù)格式:
   {"status":"0","account":"735"}
JSON返回值說明:
名稱 說明
status 返回狀態(tài)值,具體參照狀態(tài)碼說明,0-成功,其他代碼-失敗
account 賬號(hào)余額,條數(shù)= acount * 10 請(qǐng)求成功才會(huì)有此節(jié)點(diǎn)
狀態(tài)碼說明:
返回碼 描 述
0 查詢成功
100 查詢余額失敗
101 用戶賬號(hào)不存在或密碼錯(cuò)誤
102 賬號(hào)已禁用
103 參數(shù)不正確
105 認(rèn)證碼錯(cuò)誤
117 未開通此接入方式

第三章 短信發(fā)送接口

支持普通短信/模板短信/定時(shí)短信發(fā)送,賬號(hào)接口發(fā)送最大速率20條/s,根據(jù)客戶實(shí)際業(yè)務(wù)發(fā)送量可以申請(qǐng)?zhí)崴佟?em>普通短信需人工審核。定時(shí)短信需人工審核,審核通過且到達(dá)定時(shí)發(fā)送間才發(fā)送,在未到達(dá)定時(shí)發(fā)送時(shí)間允許聯(lián)系客服撤銷。模板短信免審,短信模板需要事先登陸客戶端申請(qǐng)報(bào)備并審核通過,短信3-5秒收到,所有行業(yè)短信(業(yè)務(wù)通知\驗(yàn)證碼)優(yōu)先采用模板短信發(fā)送,以免影響短信時(shí)效性。

3.1 請(qǐng)求地址

{API基路徑}/service/httpService/httpInterface.do

method參數(shù)說明:{API基路徑}/service/httpService/httpInterface.do?method=sendMsg&code=utf-8

指定字符編碼提交地址,無需攜帶code參數(shù)
Utf8編碼:
{API基路徑}/service/httpService/httpInterface.do?method=sendUtf8Msg
GBK編碼
{API基路徑}/service/httpService/httpInterface.do?method=sendGbkMsg

2.2 參數(shù)說明

參數(shù)名稱

含義

說明

method

發(fā)送短信(必填)

取值范圍:sendMsg,sendUtf8Msg,sendGbkMsg
username

用戶賬號(hào)(必填)

用戶賬號(hào)

password

用戶密碼(必填)

用戶密碼

veryCode

通信認(rèn)證密碼(必填)
mobile 手機(jī)號(hào)碼(必填) 手機(jī)號(hào)碼(群發(fā)短信時(shí),最多100個(gè),英文逗號(hào),隔開),發(fā)送前過濾錯(cuò)號(hào)并去除重復(fù)號(hào)碼
content 短信內(nèi)容(必填) 短信內(nèi)容(最多300個(gè)漢字),含特殊字符請(qǐng)URL編碼,編碼后不影響計(jì)費(fèi);如果使用模板短信發(fā)送,此參數(shù)用來傳遞模板短信的變量和值,參數(shù)之間以逗號(hào)隔開
sendtime 定時(shí)時(shí)間(24小時(shí)制) 定時(shí)短信的定時(shí)時(shí)間,格式為: (yyyyMMddHHmmss),例如:20140504111010 代表2014年5月4日 11時(shí)10分10秒,短信會(huì)在指定的時(shí)間發(fā)送出去 sendTime值為空時(shí),為即時(shí)發(fā)送短信 sendTime值不為空時(shí),為定時(shí)發(fā)送短信,值為空時(shí)表示即時(shí)發(fā)送短信

msgtype

短信類型(必填)

短信類型。1-普通短信,2-模板短信。

tempid

模板短信編號(hào)

模板編號(hào),(msgtype=2時(shí)參數(shù)必填)
code 編碼格式 編碼方式(utf-8,gbk),默認(rèn):gbk;指定字符編碼提交地址時(shí)無需賦值
rt 響應(yīng)數(shù)據(jù)格式 xml、json 默認(rèn):xml
說明:
1) IP:如果用戶開賬戶時(shí)指定IP,則接口只接收來自該IP的請(qǐng)求。
2) 模板變量值不允許包含英文逗號(hào)(,)和等號(hào)(=)
3) 短信內(nèi)容或變量值包含url特殊字符請(qǐng)進(jìn)行轉(zhuǎn)義,部分http框架會(huì)自動(dòng)對(duì)參數(shù)值進(jìn)行轉(zhuǎn)義
4) 發(fā)送短信建議采用post方式,請(qǐng)求參數(shù)放入http請(qǐng)求體中,不建議拼接在URL后面
例如:以下請(qǐng)求示例僅供參考,實(shí)際對(duì)接請(qǐng)參考《1.3 接口對(duì)接規(guī)范》
1 發(fā)送普通短信示例(需要人工審核):
http://*:*/service/httpService/httpInterface.do?method=sendMsg&username=JSM001&password=123&veryCode=456&mobile=15951977097&content=您好!您本次驗(yàn)證碼為:174687,請(qǐng)勿告知他人&msgtype=1&code=gbk
2 發(fā)送定時(shí)短信示例:
http://*:*/service/httpService/httpInterface.do?method=sendMsg&username=JSM001&password=123&veryCode=456&mobile=15951977097&content=您好!您本次驗(yàn)證碼為:174687,請(qǐng)勿告知他人&msgtype=1&code=gbk&sendtime=20150501093030

登錄綜合信息管理系統(tǒng)客戶端后,菜單:短信中/短信模版,詳細(xì)操作流程請(qǐng)查看《綜合信息管理系統(tǒng)_使用手冊(cè)(客戶端).docx》,如客戶定義的編號(hào)為JSM4001-0001模板短信為:

尊敬的@1@您好,您在江蘇美圣網(wǎng)站(gushi788.cn),注冊(cè)的手機(jī)驗(yàn)證碼為@2@,請(qǐng)?jiān)隍?yàn)證頁面及時(shí)輸入。

http://*:*/service/httpService/httpInterface.do?method=sendMsg&username=JSM001&password=123&veryCode=456&mobile=15951977097&tempid=JSM4001-000&content=@1@=李先生,@2@=928371&msgtype=2&code=gbk

發(fā)送短信內(nèi)容:【江蘇美圣】尊敬的李先生你好,您在江蘇美圣網(wǎng)站(gushi788.cn),注冊(cè)的手機(jī)驗(yàn)證碼為928371,請(qǐng)?jiān)隍?yàn)證頁面及時(shí)輸入。

Content變量為模版中各變量對(duì)應(yīng)的變量值,多個(gè)變量以英文逗號(hào)隔開:content=@1@=李先生,@3@=928371。

測(cè)試注意事項(xiàng):
1、正式賬號(hào)發(fā)送模板短信都為免審,直接轉(zhuǎn)發(fā)至運(yùn)營(yíng)商下發(fā)。
2、測(cè)試賬號(hào)發(fā)送模板短信,若模板變量值不包含中文則免審;若模板變量值中包含中文則上審核平臺(tái);
3、發(fā)送常用語短信模板(無變量的模板),content傳遞空值,即“content=”后面不賦值,直接連接下一個(gè)參數(shù)。如:&content=&msgtype=2&tempid=模板編號(hào)

3.3返回值

XML響應(yīng)數(shù)據(jù)格式:
<?xml version="1.0" encoding="UTF-8" ?>
<sms>
    <mt>
        <status>0</status>
        <msgid>816f333305664fb9bdd8c1bc96ae12b8</msgid>
    </mt>
</sms>
JSON數(shù)據(jù)格式:
{
	"status": "0",
	"msgid": "d7cd217727894a2ab6a818d75180959a,91a63c911d114f19bc25d8649d869fdb"
}
返回值說明:
名稱 說明
status 返回狀態(tài)碼,請(qǐng)參照狀態(tài)碼說明
msgid 群發(fā)短信時(shí)返回多個(gè)msgid,英文逗號(hào)隔開,且以發(fā)送號(hào)碼順序?qū)?yīng)。
群發(fā)時(shí)返回示例:
<?xml version="1.0" encoding="UTF-8" ?>

    
    0
        
    816f33336ae12b1,830c96ae12b2, 816f3338c6ae12b3
    

狀態(tài)碼說明:
返回碼 描述
0 提交成功
100 獲取上行短信失敗
101 用戶賬號(hào)不存在或密碼錯(cuò)誤
102 賬號(hào)已禁用
103 參數(shù)不正確 若是發(fā)送模板短信,可能模板變量值中包含英文逗號(hào)(,)如:@1@=訂單號(hào)DD01,DD02
104 暫無上行短信
105 短信內(nèi)容超過300字或?yàn)榭铡⒒騼?nèi)容編碼格式不正確
106 手機(jī)號(hào)碼超過100個(gè)或有錯(cuò)誤號(hào)碼
108 余額不足
109 ip錯(cuò)誤
110 短信內(nèi)容存在系統(tǒng)保留關(guān)鍵詞,可以登錄客戶端,查找具體的敏感詞。
114 模板短信序號(hào)不存在
115 短信簽名標(biāo)簽序號(hào)不存在
116 認(rèn)證碼不正確
117 未開通此接入方式

四、狀態(tài)報(bào)告接口

獲取短信狀態(tài)報(bào)告接口,只能獲取當(dāng)天短信的狀態(tài)報(bào)告,每次調(diào)用只查詢未被獲取的狀態(tài)報(bào)告。訪問頻率:建議控制在1-3分鐘調(diào)用一次

4.1 請(qǐng)求地址

{API基路徑}/service/httpService/httpInterface.do

4.2參數(shù)說明

參數(shù)名稱 含義 說明
method 獲取狀態(tài)報(bào)告(必填) 固定為queryReport
username 用戶賬號(hào)(必填) 用戶賬號(hào)
password 用戶密碼(必填) 用戶密碼
veryCode 通信認(rèn)證密碼(必填)
rt 響應(yīng)數(shù)據(jù)格式 xml、json 默認(rèn):xml

示例(實(shí)際對(duì)接請(qǐng)參考《1.3 接口對(duì)接規(guī)范》):

http://*:*/service/httpService/httpInterface.do?method=queryReport&username=JSM40001&password=123456&veryCode=123456

4.3返回值

XML響應(yīng)數(shù)據(jù)格式:
        <?xml version="1.0" encoding="UTF-8" ?>
        <sms>
            <rpt>
                <mobile>1595****097</mobile>        <!--手機(jī)號(hào)碼-->
                <msgid>7506751276725633025</msgid>	<!--消息ID ,對(duì)應(yīng)發(fā)送的消息id-->
                <status>MA:0006</status>		    <!--狀態(tài)報(bào)告,DELIVRD-成功,其他-失敗-->
                <time>2015-06-08 11:21:46</time>	<!--報(bào)告時(shí)間-->
                <extno></extno>						<!--擴(kuò)展碼-->
            </rpt>
            <rpt>
                <mobile>1595****097</mobile>
                <msgid>7506751276725633026</msgid>
                <status>MA:0006</status>
                <time>2015-06-08 11:21:46</time>
                <extno></extno>
            </rpt>
            <rpt>
                <mobile>1595****097</mobile>
                <msgid>7507418680283693057</msgid>
                <status>DELIVRD</status>
                <time>2015-06-08 11:59:37</time>
                <extno></extno>
            </rpt>
        </sms>
    
JSON數(shù)據(jù)格式:
        var a= {
            "status": "0",
            "rpts": [
                {
                    "mobile": "18120130706",
                    "msgid": "d239bbe3bba24163b27066caef635829",
                    "status": "DELIVRD",
                    "time": "2021-04-12 13:44:20",
                    "extno": ""
                },
                {
                    "mobile": "18120130706",
                    "msgid": "d7cd217727894a2ab6a818d75180959a",
                    "status": "DELIVRD",
                    "time": "2021-04-12 15:15:57",
                    "extno": ""
                }
            ]
        }
    
返回值說明:
名稱 說明
mobile 手機(jī)號(hào)碼
msgid 消息id,和發(fā)送接口內(nèi)msgid匹配的
status 狀態(tài)碼,DELIVRD-成功,其他-失敗,見《附表一:常用狀態(tài)報(bào)告碼》
time 狀態(tài)報(bào)告時(shí)間
extno 擴(kuò)展碼

4.4 錯(cuò)誤返回值

XML響應(yīng)數(shù)據(jù)格式:
    <?xml version="1.0" encoding="utf-8" ?>
        <sms>
        <mt>
            <status>104</status>
        </mt>
    </sms>
JSON數(shù)據(jù)格式:
{
	"status": "104",
}
返回值說明:
返回碼 描 述
status 返回狀態(tài)碼,具體參照狀態(tài)碼說明
狀態(tài)碼說明:
返回碼 描 述
100 獲取狀態(tài)報(bào)告失敗
101 用戶賬號(hào)不存在或密碼錯(cuò)誤
102 賬號(hào)已禁用
103 參數(shù)不正確
104 暫無短信狀態(tài)報(bào)告,表示當(dāng)前無未被獲取的狀態(tài)報(bào)告
105 認(rèn)證碼錯(cuò)誤
117 未開通此接入方式
118 未開通此接口,聯(lián)系客服申請(qǐng)開通“獲取狀態(tài)報(bào)告接口”權(quán)限

五、上行回復(fù)接口

獲取短信狀態(tài)報(bào)告接口,只能獲取當(dāng)天上行回復(fù)短信,每次調(diào)用只查詢未被獲取的上行回復(fù)短信告。 訪問頻率:建議控制在1-3分鐘調(diào)用一次,具體根據(jù)客戶實(shí)際業(yè)務(wù)設(shè)置。

5.1 請(qǐng)求地址

{API基路徑}/service/httpService/httpInterface.do

5.2參數(shù)說明

參數(shù)名稱 含義 說明
method 獲取上行短信(必填) 固定為queryMo
username 用戶賬號(hào)(必填) 用戶賬號(hào)
password 用戶密碼(必填) 用戶密碼
veryCode 通信認(rèn)證密碼(必填)
rt 響應(yīng)數(shù)據(jù)格式 xml、json 默認(rèn):xml

示例(實(shí)際對(duì)接請(qǐng)參考《1.3 接口對(duì)接規(guī)范》):

http://*:*/service/httpService/httpInterface.do?method=queryMo&username=test&password=123&veryCode=456

5.3返回值

XML響應(yīng)數(shù)據(jù)格式:
<?xml version="1.0" encoding="utf-8" ?>
<sms>
    <mo>
    <mobile>15951****97</mobile>				<!--手機(jī)號(hào)碼-->
        <recvcode>106905994140001</recvcode>		<!--接受號(hào)碼-->
        <content>江蘇美圣信息技術(shù)有限公司</content><!--回復(fù)內(nèi)容-->
        <time>2015-04-02 22:12:11</time>			 <!--接收時(shí)間-->
    </mo>
    <mo>
        <mobile>15951****97</mobile>				<!--對(duì)應(yīng)的手機(jī)號(hào)碼-->
        <recvcode>106905994140001</recvcode>		<!--接受號(hào)碼-->
        <content>4006000699</content>				<!--回復(fù)內(nèi)容-->
        <time>2014-04-03 08:12:11</time>			<!--接收時(shí)間-->
    </mo>
</sms>
JSON數(shù)據(jù)格式:
{
	"status": "0",
	"mos": [
		{
			"mobile": "1812***706",
			"recvcode": "106905994540001",
			"content": "收到",
			"time": "2021-04-12 15:49:19"
		}
	]
}
返回值說明:
名稱 說明
mobile 對(duì)應(yīng)的手機(jī)號(hào)碼
recvcode 接受號(hào)碼
content 回復(fù)內(nèi)容
time 接收時(shí)間

4.4錯(cuò)誤返回值

<?xml version="1.0" encoding="utf-8" ?>
<sms>
    <mt>
        <status></status>
    </mt>
</sms>
返回值說明:
名稱 說明
status 返回狀態(tài)碼,請(qǐng)參照狀態(tài)碼說明
狀態(tài)碼說明:
返回碼 描 述
100 獲取上行短信失敗
101 用戶賬號(hào)不存在或密碼錯(cuò)誤
102 賬號(hào)已禁用
103 參數(shù)不正確
104 暫無上行短信,表示當(dāng)前無未被獲取的上行回復(fù)短信
105 認(rèn)證碼錯(cuò)誤
117 未開通此接入方式
118 未開通此接口,聯(lián)系客服申請(qǐng)開通“獲取上行接口”權(quán)限

五、常用狀態(tài)報(bào)告碼

查看常用狀態(tài)
久久av免费天堂| 欧美黑人精品久久免费| 亚洲精品人妻| 久久国产有码| 色窝窝一区二区三区| 韩日第一页| 日本亚洲欧成人| 99福利视频一区二区三区| 新天堂网AV| 一本日本久久九免费| 人成影院| 婷婷一区二区不卡| 色视频无码专区在线观看| 日韩av一区二区| 成人另类无码| 国产丝袜无码一区二区三区视频| 成人小说一区| av片网站婷婷五月天| 久久精品美女| 综合五月丁香婷婷| 四虎精品成人免费视频| 欧美色图亚洲第一色图| 麻豆免费网站| 99无码αv| 性AV天| 伊人| 日本午夜成人18视频| 国产成人高清精品亚洲| 欧美日韩综合中文| 亚洲色图在线一区| AV蜜臀在线网站| 日韩有吗在线观看视频| 日韩毛片| 四色开心播播网| 丰满人妻3HD中文| 在线无码日批视频| 密臀01国产视频| 久久不射网站| 婷婷色综| 久久久久亚洲AV| 亚洲国产大陆|