php短信接口開發(http協議)
本文由動力思維樂信原創文章,技術楊工提供,歡迎交流合作,動力思維樂信短信接口官網:http://www.lx598.com/ 。
一、接口說明
1、提交方式與編碼
http請求都應以POST形式提交,編碼為UTF-8
2、請求地址
請求地址(host)為: http://www.lx198.com/sdk/
不同的協議擁有不同的提交地址 方式是在以上地址後面增加相應的地址;
二、主體協議
1、發送短信
發送普通短信調用此方法,可單個或批量發送。
註意:①、短信內容格式為:短信內容【簽名】,要使用中文’【‘。
2、發送地址
http://host/send
3、發送參數
字段名稱 |
是否可空 |
說明 |
accName |
否 |
用戶名( |
accPwd |
否 |
密碼(樂信登錄密碼32位MD5加密後轉大寫,如123456加密完以後為:E10ADC3949BA59ABBE56E057F20F883E) |
aimcodes |
否 |
手機號碼(多個手機號碼之間用英文半角“,” |
content |
否 |
內容(內容長度請參照樂信(http://www.lx198.com)發送短信頁面提示),註意:在內容的最後需要加上在樂信(http://www.lx198.com)設置並通過審核的簽名。如:公司定於1月25日召開今年的企業年會,請務必安排好時間。【動力思維】 |
schTime |
是 |
定時時間(格式為: 如為空則為即時短信,如需定時時間格式為“yyyy-mm-dd hh24:mi:ss”) |
dataType |
是 |
返回的數據(類型支持:json/xml/string 三種形式 默認string) |
msgId |
是 |
提交短信包的唯一id,推送短信回執時,會推送此值,用此值和手機號碼來匹配短信的狀態,如需要接受回執則必須提交此參數,單次提交只需要提交一個即可 |
接口測試實例,可以在瀏覽器中直接輸入測試(建議使用POST方式)
http://www.lx198.com/sdk/send?accName=***&accPwd=***&aimcodes=***&content=內容【簽名】&bizId=***&dataType=string
4、發送響應Json格式
字段名稱 |
類型 |
說明 |
replyCode |
整型 |
執行結果 1 成功 0失敗 |
replyMsg |
Text |
成功或失敗原因具體信息 |
succeedNum |
整型 |
成功條數(當次提交成功的手機號碼個數) |
failedNum |
整型 |
失敗條數(當次提交失敗的手機號碼個數) |
chargCount |
整型 |
計費條數(當次提交計費的短信條數) |
deduction |
整型 |
計費金額(當次提交的計費金額,單位:厘) |
balance |
整型 |
余額(當次提交後的賬戶余額:單位:厘) |
示例:
{"balance":"12882680","chargCount":61,"deduction":"3660","failedNum":0,"replyCode":1,"replyMsg":"發送成功!","succeedNum":61}
5、發送相應xml格式
字段名稱 |
類型 |
說明 |
replyCode |
整型 |
執行結果 1 成功 0失敗 |
replyMsg |
文本 |
成功或失敗原因具體信息 |
succeedNum |
整型 |
成功條數(當次提交成功的手機號碼個數) |
failedNum |
整型 |
失敗條數(當次提交失敗的手機號碼個數) |
chargCount |
整型 |
計費條數(當次提交計費的短信條數) |
deduction |
整型 |
計費金額(當次提交的計費金額,單位:厘) |
balance |
整型 |
余額(當次提交後的賬戶余額,單位:厘) |
示例:
<?xml version="1.0" encoding="UTF-8"?>
<SendSmsReply>
<replyCode>1</replyCode>
<replyMsg>發送成功!</replyMsg>
<succeedNum>61</succeedNum>
<failedNum>0</failedNum>
<deduction>3660</deduction>
<balance>12028040</balance>
<chargCount>61</chargCount>
</SendSmsReply>
6、發送相應string格式
說明:
多個響應參數之前以”;”隔開,格式為:成功或失敗代碼;成功或失敗信息;成功條數;失敗條數;計費條數;計費金額;余額;
示例:
1;發送成功!;61;0;61;3660;12024380;
三、短信接口接入步驟:
1、 註冊短信接口平臺賬戶:http://www.lx598.com/acc/x5?i=110792
2、 申請短信接口使用,或者聯系客服開通,400電話:400-6699-521。
3、下載完整接口文件,下載地址:http://www.lx598.com/api/sdk_php.zip。
4、參考代碼示例完成。
<?php
require_once ’HttpClient.class.php’;
class dlswSdk {
const HOST = ’www.lx198.com’;
final private static function __replyResult($xmlStr) {
$doc = new DOMDocument ();
$doc->loadXML ( $xmlStr );
print($xmlStr);
$xpath = new DOMXpath ( $doc );
$arr = $xpath->query ( ’/reply/ErrorCode/text()’, $doc );
$ret = ’’;
foreach ( $arr as $o ) {
$ret = $o->nodeValue;
}
return $ret;
}
final public static function sendSms($user, $password,$content,$mobiles) {
$client = new HttpClient ( self::HOST );
$client->setDebug ( true );
if (! $client->post ( ’/sdk/send’, array (
’accName’ => $user,
’accPwd’ => strtoupper ( md5 ( $password ) ),
’bizId’ => date ( ’YmdHis’ ),
’content’ => mb_convert_encoding ( $content, ’UTF-8’, ’UTF-8’ ),
’aimcodes’ =>$mobiles ,
’dataType’=>"xml"
) )) {
return ’-10000’;
} else {
return self::__replyResult ( $client->getContent () );
}
}
}
print(dlswSdk::sendSms( ’[email protected]’, ’123456’,’下午好php【楊超】’,’13592605881’));
?>
php短信接口開發(http協議)