動(dòng)力思維web版樂信SDK接口文檔

動(dòng)力思維專業(yè)源自專注—樂信短信平臺(tái)河南省動(dòng)力思維信息技術(shù)有限公司400-6699-521動(dòng)力思維web版樂信SDK接口文檔beta1.0動(dòng)力思維AllRightsReserved

1. 說明 31.1. 提交方式與編碼 31.2. 請(qǐng)求地址 31.3. 提交業(yè)務(wù)限制 31.4. 短信回執(zhí)、賬單 32. 主體協(xié)議 32.1. 發(fā)送短信 32.1.1. 發(fā)送地址 42.1.2. 發(fā)送參數(shù) 42.1.3. 發(fā)送響應(yīng)Json格式 42.1.4. 發(fā)送響應(yīng)xml格式 52.1.5. 發(fā)送響應(yīng)string格式 62.2. 查詢余額 62.2.1. 請(qǐng)求地址 62.2.2. 發(fā)送參數(shù) 62.2.3. 發(fā)送響應(yīng)Json格式 62.2.4. 發(fā)送響應(yīng)xml格式 72.2.5. 發(fā)送響應(yīng)string格式 72.3. 短信報(bào)告查詢 72.3.1. 請(qǐng)求地址 72.3.2. 發(fā)送參數(shù) 82.3.3. 發(fā)送響應(yīng)Json格式 82.3.4. 響應(yīng)xml格式 82.3.5. 響應(yīng)String格式 92.4. 回復(fù)短信查詢 92.4.1. 請(qǐng)求地址 92.4.2. 發(fā)送參數(shù) 102.4.3. 發(fā)送響應(yīng)Json格式 102.4.4. 發(fā)送響應(yīng)xml格式 102.4.5. 發(fā)送響應(yīng)string格式 112.5. 回執(zhí)推送 112.5.1. 推送地址 112.5.2. 推送參數(shù)及說明 112.5.3. 推送返回響應(yīng) 112.6. 回復(fù)推送 122.6.1. 推送地址 122.6.2. 推送參數(shù)及說明 122.6.3. 推送返回響應(yīng) 12說明提交方式與編碼http請(qǐng)求都應(yīng)以POST形式提交,編碼為UTF-8請(qǐng)求地址請(qǐng)求地址(host)為:/sdk/不同的協(xié)議擁有不同的提交地址方式是在以上地址后面增加響應(yīng)的地址提交業(yè)務(wù)限制單個(gè)短信數(shù)據(jù)包提交最多支持5000個(gè)號(hào)碼,相同內(nèi)容請(qǐng)拼接號(hào)碼提交1分鐘內(nèi)提交短信數(shù)據(jù)包數(shù)量不能大于100個(gè)如有個(gè)性化短信需求請(qǐng)使用發(fā)送個(gè)性短信協(xié)議超出以上規(guī)定的，SDK功能將被停用短信回執(zhí)、賬單請(qǐng)登錄查詢主體協(xié)議發(fā)送短信發(fā)送普通短信調(diào)用此方法，可單個(gè)或批量發(fā)送。注意：1、短信內(nèi)容格式為：短信內(nèi)容【簽名】，要使用中文’【‘，簽名可向客戶經(jīng)理咨詢。發(fā)送地址http://host/send參數(shù)字段名稱是否可空說明accName否用戶名(樂信登錄賬號(hào))accPwd否密碼(樂信登錄密碼32位MD5加密后轉(zhuǎn)大寫，如123456加密完以后為：E10ADC3949BA59ABBE56E057F20F883E)aimcodes否手機(jī)號(hào)碼(多個(gè)手機(jī)號(hào)碼之間用英文半角“,”隔開,單次最多支持5000個(gè)號(hào)碼)content否內(nèi)容(內(nèi)容長度請(qǐng)參照樂信()發(fā)送短信頁面提示)，注意：在內(nèi)容的最后需要加上在樂信()設(shè)置并通過審核的簽名。如：公司定于1月25日召開今年的企業(yè)年會(huì)，請(qǐng)務(wù)必安排好時(shí)間。【動(dòng)力思維】schTime是定時(shí)時(shí)間(格式為:如為空則為即時(shí)短信,如需定時(shí)時(shí)間格式為“yyyy-mm-ddhh24:mi:ss”。如果是GET提交，需要轉(zhuǎn)碼)dataType是返回的數(shù)據(jù)(類型支持:json/xml/string三種形式默認(rèn)string)msgId是提交短信包的唯一id(15位以內(nèi)數(shù)字)，推送短信回執(zhí)時(shí)，會(huì)推送此值，用此值和手機(jī)號(hào)碼來匹配短信的狀態(tài)，如需要接受回執(zhí)則必須提交此參數(shù),單次提交只需要提交一個(gè)即可接口測(cè)試實(shí)例，可以在瀏覽器中直接輸入測(cè)試（建議使用POST方式）/sdk/send?accName=***&accPwd=***&aimcodes=***&content=內(nèi)容【簽名】&dataType=string響應(yīng)Json格式字段名稱類型說明replyCode整型執(zhí)行結(jié)果

1成功

0失敗replyMsgText成功或失敗原因具體信息succeedNum整型成功條數(shù)(當(dāng)次提交成功的手機(jī)號(hào)碼個(gè)數(shù))failedNum整型失敗條數(shù)(當(dāng)次提交失敗的手機(jī)號(hào)碼個(gè)數(shù))chargCount整型計(jì)費(fèi)條數(shù)(當(dāng)次提交計(jì)費(fèi)的短信條數(shù))deduction整型計(jì)費(fèi)金額(當(dāng)次提交的計(jì)費(fèi)金額,單位:厘)balance整型余額(當(dāng)次提交后的賬戶余額:單位:厘)示例:{"balance":"12882680","chargCount":61,"deduction":"3660","failedNum":0,"replyCode":1,"replyMsg":"發(fā)送成功!","succeedNum":61}響應(yīng)xml格式字段名稱類型說明replyCode整型執(zhí)行結(jié)果

1成功

0失敗replyMsg文本成功或失敗原因具體信息succeedNum整型成功條數(shù)(當(dāng)次提交成功的手機(jī)號(hào)碼個(gè)數(shù))failedNum整型失敗條數(shù)(當(dāng)次提交失敗的手機(jī)號(hào)碼個(gè)數(shù))chargCount整型計(jì)費(fèi)條數(shù)(當(dāng)次提交計(jì)費(fèi)的短信條數(shù))deduction整型計(jì)費(fèi)金額(當(dāng)次提交的計(jì)費(fèi)金額,單位:厘)balance整型余額(當(dāng)次提交后的賬戶余額,單位:厘)示例:<?xmlversion="1.0"encoding="UTF-8"?><SendSmsReply><replyCode>1</replyCode><replyMsg>發(fā)送成功!</replyMsg><succeedNum>61</succeedNum><failedNum>0</failedNum><deduction>3660</deduction><balance>12028040</balance><chargCount>61</chargCount></SendSmsReply>響應(yīng)string格式說明:多個(gè)響應(yīng)參數(shù)之前以”;”隔開,格式為:成功或失敗代碼;成功或失敗信息;成功條數(shù);失敗條數(shù);計(jì)費(fèi)條數(shù);計(jì)費(fèi)金額;余額;示例:1;發(fā)送成功!;61;0;61;3660;12024380;查詢余額請(qǐng)求地址http://host/qryBalance參數(shù)字段名稱是否可空說明accName否用戶名(樂信登錄賬號(hào))accPwd否密碼(樂信登錄密碼32位MD5加密后轉(zhuǎn)大寫，如123456加密完以后為：E10ADC3949BA59ABBE56E057F20F883E)響應(yīng)Json格式字段名稱類型說明replyCode整型執(zhí)行結(jié)果

1成功

0失敗replyMsgText成功或失敗原因具體信息balance整型余額,單位厘示例:{"balance":"4750","replyCode":1,"replyMsg":"查詢成功"}響應(yīng)xml格式字段名稱類型說明replyCode整型執(zhí)行結(jié)果

1成功

0失敗replyMsg文本成功或失敗原因具體信息balance整型余額,單位厘示例:<?xmlversion="1.0"encoding="UTF-8"?><QueryBalanceReply><replyCode>1</replyCode><replyMsg>查詢成功</replyMsg><balance>4750</balance></QueryBalanceReply>響應(yīng)string格式說明:多個(gè)響應(yīng)參數(shù)之前以”;”隔開,格式為:成功或失敗代碼;成功或失敗信息;余額(單位厘);示例:1;查詢成功;4750短信報(bào)告查詢請(qǐng)求地址http://host/qryReport參數(shù)字段名稱是否可空說明accName否用戶名(樂信登錄賬號(hào))accPwd否密碼(樂信登錄密碼32位MD5加密后轉(zhuǎn)大寫，如123456加密完以后為：E10ADC3949BA59ABBE56E057F20F883E)dataType是返回的數(shù)據(jù)(類型支持:json/xml/string三種形式默認(rèn)string)響應(yīng)Json格式字段名稱類型說明replyCode整型執(zhí)行結(jié)果1成功0失敗replyMsgText成功或失敗原因具體信息total整型本次查詢的總條數(shù)reportDetails報(bào)告列表MSGID:發(fā)送時(shí)提交的msgId參數(shù),AIMCODE:手機(jī)號(hào)SMS_STATUS:0或11表示成功0表示失敗示例:{“replyCode”:”1”,”replyMsg”:"查詢成功！","hasNext":"0","receiveCount":"0","replyInfos":[{MSGID:發(fā)送時(shí)提交的msgId參數(shù),AIMCODE:手機(jī)號(hào)SMS_STATUS:0或11表示成功0表示失敗}]}響應(yīng)xml格式字段名稱類型說明replyCode整型執(zhí)行結(jié)果

1成功

0失敗replyMsg文本成功或失敗原因具體信息total整型本次查詢的總條數(shù)reportDetails報(bào)告列表MSGID:發(fā)送時(shí)提交的msgId參數(shù),AIMCODE:手機(jī)號(hào)SMS_STATUS:0或11表示成功0表示失敗示例:<?xmlversion="1.0"encoding="UTF-8"?><QryReportDetailReply><replyCode>1</replyCode><replyMsg>查詢成功！</replyMsg><total>0</total><reportDetails> <SendReport> <MSGID></MSGID> <AIMCODE></AIMCODE> <SMS_STATUS></SMS_STATUS> </SendReport></reportDetails></QryReportDetailReply>響應(yīng)String格式說明:多個(gè)響應(yīng)參數(shù)之前以”;”隔開,格式為:成功或失敗代碼;成功或失敗信息;總條數(shù)#MSGID,AIMCODE,SMS_STATUS1;查詢成功!;1#11;20;11;回復(fù)短信查詢請(qǐng)求地址http://host/receiveSms參數(shù)字段名稱是否可空說明accName否用戶名(樂信登錄賬號(hào))accPwd否密碼(樂信登錄密碼32位MD5加密后轉(zhuǎn)大寫，如123456加密完以后為：E10ADC3949BA59ABBE56E057F20F883E)dataType是返回的數(shù)據(jù)(類型支持:json/xml/string三種形式默認(rèn)string)響應(yīng)Json格式字段名稱類型說明replyCode整型執(zhí)行結(jié)果1成功0失敗replyMsgText成功或失敗原因具體信息示例:{"replyCode":"1","replyMsg":"接受短信成功！","hasNext":"0","receiveCount":"0","replyInfos":[]}響應(yīng)xml格式字段名稱類型說明replyCode整型執(zhí)行結(jié)果

1成功

0失敗replyMsg文本成功或失敗原因具體信息示例:<?xmlversion="1.0"encoding="UTF-8"?><ReceiveSmsReply><replyCode>1</replyCode><replyMsg>接受短信成功！</replyMsg><hasNext>0</hasNext><receiveCount>0</receiveCount><replyInfos/></ReceiveSmsReply>回執(zhí)推送推送地址如需接收回執(zhí)請(qǐng)聯(lián)系客戶經(jīng)理綁定推送地址,要求地址可訪問;推送參數(shù)及說明參數(shù)名稱類型說明aimcodes字符串手機(jī)號(hào)，多個(gè)手機(jī)號(hào)以’,’隔開msgids字符串短信的唯一ID(15位以內(nèi)數(shù)字)，多個(gè)ID以’,’隔開statuses字符串狀態(tài)，多個(gè)狀態(tài)以’,’隔開。1表示回執(zhí)成功；0表示回執(zhí)失??；acname字符串用戶名type字符串參數(shù)類型，0表示回執(zhí)信息推送返回響應(yīng)合作方收到