13年匠心 只为更好

API文档
Api列表 功能说明 详细文档
发送短信 发送普通短信,可单个或批量发送
个性短信发送 群发不同内容的短信
查询余额 查询剩余可用短信条数
回复短信查询 从服务器查询客户回复的短信
短信报告查询 查询短信发送成功、失败报告
回执推送 短信发送成功、失败回执报告
回复推送 将客户回复的短信推送到账户收件箱

说明:

发送普通短信调用此方法,可单个或批量发送。

注意:1、短信内容格式为:短信内容【签名】,要使用中文’【‘,签名可向客户经理咨询。

          2、bizId必须为唯一的

1.发送地址:

http://www.lx598.com/sdk/send.com

2.发送参数:

字段名称 是否可空 说明
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”)
bizId 业务ID(为了方便您的使用,请将当前时间格式化为“yyyymmddhh24miss”格式作为业务ID提交)
dataType 返回的数据(类型支持:json/xml/string 三种形式 默认string)
msgId 提交短信包的唯一id,推送短信回执时,会推送此值,用此值和手机号码来匹配短信的状态,如需要接受回执则必须提交此参数,单次提交只需要提交一个即可

注:接口测试实例,可以在浏览器中直接输入测试(建议使用POST方式) http://www.lx198.com/sdk/send?accName=***&accPwd=***&aimcodes=***&content=内容【签名】&bizId=***&dataType=string

3.响应数据:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg 文本 成功或失败原因具体信息
succeedNum 整型 成功条数(当次提交成功的手机号码个数)
failedNum 整型 失败条数(当次提交失败的手机号码个数)
chargCount 整型 计费条数(当次提交计费的短信条数)
deduction 整型 计费金额(当次提交的计费金额,单位:厘)
balance 整型 余额(当次提交后的账户余额,单位:厘)

4.json返回格式示例:

{"balance":"12882680","chargCount":61,"deduction":"3660","failedNum":0,"replyCode":1,"replyMsg":"发送成功!","succeedNum":61}

5.xml返回格式示例:

<?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/sendCustom

2.发送参数:

字段名称 是否可空 说明
accName 用户名(乐信登录账号)
accPwd 密码(乐信登录密码32位MD5加密后转大写,如123456加密完以后为:E10ADC3949BA59ABBE56E057F20F883E)
content 内容(内容长度请参照乐信(http://www.lx198.com)发送短信页面提示)
schTime 定时时间(格式为: 如为空则为即时短信,如需定时时间格式为“yyyy-mm-dd hh24:mi:ss”)
bizId 业务ID(为了方便您的使用,请将当前时间格式化为“yyyymmddhh24miss”格式作为业务ID提交)
dataType 返回的数据(类型支持:json/xml/string 三种形式 默认string)
place 占位字符串(多个字符串用英文半角“,”隔开)
replace 替换字符串(格式为:唯一编号,手机号码,替换字符串1,替换字符串2…以此类推;单个号码的多个参数以英文半角“,”隔开,多个号码用英文半角“;”隔开)

3.json返回格式示例:

content:{姓名}:你好,您{月份}月份的工资为:{总数}元,其中基本工资:{基本}元,绩效工资:{绩效}元

place:{姓名},{月份},{总数},{基本},{绩效}

replace:100001,13500008888,张三,3,6780,5000,1780;

             100002,13500008889,李四,3,7780,5700,2080;

则:

13500008888收到的内容为: 张三:你好,您3月份的工资为: 6780元,其中基本工资: 5000元,绩效工资: 1780元

13500008889收到的内容为: 李四:你好,您3月份的工资为: 7780元,其中基本工资: 5700元,绩效工资: 2080元

备注:唯一编号的作用为:如个别号码对应的内容拼接后因为个别原因(如拼接后内容过长)提交失败,则返回编号及对应的失败原因

4.发送响应json形式:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg 文本 成功或失败原因具体信息
succeedNum 整型 成功条数(当次提交成功的手机号码个数)
failedNum 整型 失败条数(当次提交失败的手机号码个数)
chargCount 整型 计费条数(当次提交计费的短信条数)
deduction 整型 计费金额(当次提交的计费金额,单位:厘)
balance 整型 余额(当次提交后的账户余额,单位:厘)
mobResult 文本 个别号码失败结果(可能为空 每个号码对应的失败信息为:唯一编号,手机号码,失败原因)

5.json返回格式示例:

{"balance":"12009800","chargCount":60,"deduction":"3600","failedNum":0,"mobResult":[["62","13592605943","存在黑字典:发票"],["61","13592605942","存在黑字典:平米"]],"pkgId":"","replyCode":1,"replyMsg":"发送成功!","succeedNum":60}

6.发送响应XML格式:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg 文本 成功或失败原因具体信息
succeedNum 整型 成功条数(当次提交成功的手机号码个数)
failedNum 整型 失败条数(当次提交失败的手机号码个数)
chargCount 整型 计费条数(当次提交计费的短信条数)
deduction 整型 计费金额(当次提交的计费金额,单位:厘)
balance 整型 余额(当次提交后的账户余额,单位:厘)
mobResult 文本 个别号码失败结果(可能为空 单个手机号码失败原因格式为:唯一编号手机号码失败原因)

7.xml返回格式示例:

<?xml version="1.0" encoding="UTF-8"?> <SmsCustomSmsReply> <replyCode>1</replyCode> <replyMsg>发送成功!</replyMsg> <succeedNum>60</succeedNum> <failedNum>0</failedNum> <deduction>3600</deduction> <balance>12006200</balance> <chargCount>60</chargCount> <mobResult> <list> <string>62</string> <string>13592605943</string> <string>存在黑字典:发票</string> </list> <list> <string>61</string> <string>13592605942</string> <string>存在黑字典:平米</string> </list> </mobResult> </SmsCustomSmsReply>

8.发送响应string格式:

● 说明: 多个响应参数之前以英文半角 “;” 隔开,和失败号码详细信息之间用英文半角“#”隔开。格式为:

   成功或失败代码;成功或失败信息;成功条数;失败条数;计费条数;计费金额;余额#唯一编号1,手机号码1,失败原因1;唯一编号2,手机号码2;失败原因2;

● 示例:

   1;发送成功!;60;0;60;3600;12002600#62,13592605943,存在黑字典:发票;61,13592605942,存在黑字典:平米;

1.发送地址

http://www.lx598.com/qryBalance

2.发送参数

字段名称 是否可空 说明
accName 用户名(乐信登录账号)
accPwd 密码(乐信登录密码32位MD5加密后转大写,如123456加密完以后为:E10ADC3949BA59ABBE56E057F20F883E)

3. 发送响应json格式:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg Text 成功或失败原因具体信息
balance 整型 余额,单位厘

4.json返回格式示例:

{"balance":"4750","replyCode":1,"replyMsg":"查询成功"}

5.发送响应XML格式:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg 文本 成功或失败原因具体信息
balance 整型 余额,单位厘

6.xml返回格式示例:

<?xml version="1.0" encoding="UTF-8"?> <QueryBalanceReply> <replyCode>1</replyCode> <replyMsg>查询成功</replyMsg> <balance>4750</balance> </QueryBalanceReply>

7.发送相应string格式:

● 说明:

多个响应参数之前以”;”隔开,格式为:成功或失败代码;成功或失败信息;余额(单位厘);

● 示例:

1;查询成功;4750

1.发送地址

http://www.lx598.com/qryBalance

2.发送参数

字段名称 是否可空 说明
accName 用户名(乐信登录账号)
accPwd 密码(乐信登录密码32位MD5加密后转大写,如123456加密完以后为:E10ADC3949BA59ABBE56E057F20F883E)
dataType 返回的数据(类型支持:json/xml/string 三种形式 默认string)

3. 发送响应json格式:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg Text 成功或失败原因具体信息

4.json返回格式示例:

{"replyCode":"1","replyMsg":"接受短信成功!","hasNext":"0","receiveCount":"0","replyInfos":[]}

5.发送响应XML格式:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg 文本 成功或失败原因具体信息

6.xml返回格式示例:

<?xml version="1.0" encoding="UTF-8"?> <ReceiveSmsReply> <replyCode>1</replyCode> <replyMsg>接受短信成功!</replyMsg> <hasNext>0</hasNext> <receiveCount>0</receiveCount> <replyInfos/> </ReceiveSmsReply>

7.发送响应string格式:

● 说明:

多个响应参数之前以”;”隔开,格式为:成功或失败代码;成功或失败信息;成功条数;失败条数;计费条数;计费金额;余额;

● 示例:

1;发送成功!;61;0;61;3660;12024380;

1.推送地址

http://www.lx598.com/qryReport

2.推送参数

参数名称 是否可空 说明
accName 用户名(乐信登录账号)
accPwd 密码(乐信登录密码32位MD5加密后转大写,如123456加密完以后为:E10ADC3949BA59ABBE56E057F20F883E)
dataType 返回的数据(类型支持:json/xml/string 三种形式 默认string)

3. 发送响应json格式:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg Text 成功或失败原因具体信息
total 整型 本次查询的总条数
reportDetails 报告列表 MSGID:发送时提交的msgId参数 ,AIMCODE:手机号 SMS_STATUS:0或1 1表示成功0表示失败

4.json返回格式示例:

{“replyCode”:”1”,”replyMsg”:"查询成功!","hasNext":"0","receiveCount":"0","replyInfos":[{MSGID:发送时提交的msgId参数 ,AIMCODE:手机号 SMS_STATUS:0或1 1表示成功0表示失败}]}

5.发送响应XML格式:

字段名称 类型 说明
replyCode 整型 执行结果 1 成功 0失败
replyMsg 文本 成功或失败原因具体信息
total 整型 本次查询的总条数
reportDetails 报告列表 MSGID:发送时提交的msgId参数 ,AIMCODE:手机号 SMS_STATUS:0或1 1表示成功0表示失败

6.xml返回格式示例:

<?xml version="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>

7.发送响应string格式:

● 说明:

多个响应参数之前以”;”隔开,格式为:成功或失败代码;成功或失败信息;总条数#MSGID,AIMCODE,SMS_STATUS;

● 示例:

1;查询成功!;1#1,13500000000,1;2,13511111111,0;1,13500000001,1;

1.推送地址

如需接收回执请联系客户经理绑定推送地址,要求地址可访问;

2.推送参数及说明

参数名称 数据类型 说明
aimcodes string 手机号,多个手机号以’,’隔开
msgids string 短信的唯一ID,多个ID以’,’隔开
statuses string 状态,多个状态以’,’隔开。1表示回执成功;0表示回执失败;
acname string 用户名
type string 参数类型,0表示回执信息

3.推送返回响应

合作方收到回执后返回响应“ok,为成功接收回执;其他为失败 如无反应或返回其它,重发两次后不再重发(总共推送3次),重发间隔为2小时.

1.推送地址

如需接收回复请联系客户经理绑定推送地址(同回执地址),要求地址可访问;

2.推送参数及说明

参数名称 数据类型 说明
aimcodes string 上行手机号
acname string 用户名
replycode string 回复编码
content string 回复内容
type string 参数类型,1表示回复信息

3.推送返回响应

合作方收到回复后返回响应“ok,为成功接收回执;其他为失败 如无反应或返回其它,重发两次后不再重发(总共推送3次),重发间隔为2小时.



联系我们

服务热线:0371-69067686

投诉专线:0371-69067696

(点击交谈)

乐信新浪企业微博

乐信官方微信

© Copyright 2004-2017 动力思维平乐信 All Rights Reserved 河南动力思维信息技术有限公司

公司地址:郑州市金水区中州大道农业路苏荷中心616室

增值电信业务经营许可证:B2-20090494 备案号:豫B2-20100056-8

豫公网安备 41010502002235号