本文有动力思维乐信原创文章,技术杨工提供,欢迎交流合作,动力思维乐信短信接口官网: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 |
否 |
手机号码(多个手机号码之间用英文半角“,”隔开,单次最多支持5000个号码) |
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( 'yangchao_713@163.com', '123456','下午好php【杨超】','13592605881'));
?>