动力思维web版乐信SDK接口文档

beta 1.0

 

 

 

 

 

 

 

 

 

动力思维

All Rights Reserved


 

目录

目录................................................................................................................................. 2

1. 说明............................................................................................................................. 3

1.1. 提交方式与编码................................................................................................. 3

1.2. 请求地址............................................................................................................ 3

1.3. 提交业务限制..................................................................................................... 3

1.4. 短信回执、账单................................................................................................. 3

2. 主体协议...................................................................................................................... 3

2.1. 发送短信............................................................................................................ 3

2.1.1. 发送地址.................................................................................................. 3

2.1.2. 发送参数.................................................................................................. 4

2.1.3. 响应Json格式................................................................................... 4

2.1.4. 响应xml格式..................................................................................... 5

2.1.5. 响应string格式................................................................................. 6

2.2. 查询余额............................................................................................................ 9

2.2.1. 请求地址.................................................................................................. 9

2.2.2. 发送参数.................................................................................................. 9

2.2.3. 响应Json格式.................................................................................. 10

2.2.4. 响应xml格式................................................................................... 10

2.2.5. 响应string格式................................................................................ 10

2.3. 回复短信查询................................................................................................... 11

2.3.1. 请求地址................................................................................................ 11

2.3.2. 发送参数................................................................................................ 11

2.3.3. 响应Json格式.................................................................................. 11

2.3.4. 响应xml格式................................................................................... 11

2.3.5. 响应string格式................................................................................ 12

2.4. 回执推送.......................................................................................................... 12

2.4.1. 推送地址................................................................................................ 13

2.4.2. 推送参数及说明...................................................................................... 13

2.4.3. 推送返回响应......................................................................................... 13

2.5. 回复推送.......................................................................................................... 13

2.5.1. 推送地址................................................................................................ 13

2.5.2. 推送参数及说明...................................................................................... 13

2.5.3. 推送返回响应......................................................................................... 13

 

1.   说明

1.1.    提交方式与编码

http请求都应以POST形式提交,编码为UTF-8

1.2.    请求地址

请求地址(host):  http://sdk.lx198.com/sdk/

不同的协议拥有不同的提交地址 方式是在以上地址后面增加相应的地址

1.3.    提交业务限制

单个短信数据包提交最多支持5000个号码,相同内容请拼接号码提交

1分钟内提交短信数据包数量不能大于100

如有个性化短信需求请使用发送个性短信协议

超出以上规定的, SDK功能将被停用

1.4.    短信回执、账单

请登录http://www.lx198.com 查询

2.   主体协议

2.1.     发送短信

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

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

          2bizId必须为唯一的

2.1.1.    发送地址

http://host/send

2.1.2.    发送参数

字段名称

是否可空

说明

accName

用户名(乐信登录账号)

accPwd

密码(乐信登录密码32MD5加密后转大写123456加密完以后为:E10ADC3949BA59ABBE56E057F20F883E)

aimcodes

手机号码(多个手机号码之间用英文半角“,”隔开,单次最多支持5000个号码)

content

内容(内容长度请参照乐信(http://www.lx198.com)发送短信页面提示)注意:在内容的最后需要加上在乐信(http://www.lx198.com)设置并通过审核的签名。如:公司定于125日召开今年的企业年会,请务必安排好时间。【动力思维】

schTime

定时时间(格式为: 如为空则为即时短信,如需定时时间格式为“yyyy-mm-dd hh24:mi:ss”。如果是GET提交,需要 转码 )

bizId

业务ID(为了方便您的使用,请将当前时间格式化为“yyyymmddhh24miss”格式作为业务ID提交)

dataType

返回的数据(类型支持:json/xml/string 三种形式 默认string)

msgId

提交短信包的唯一id(15位以内数字),推送短信回执时,会推送此值,用此值和手机号码来匹配短信的状态,如需要接受回执则必须提交此参数,单次提交只需要提交一个即可

接口测试实例,可以在浏览器中直接输入测试(建议使用POST方式)

http://sdk.lx198.com/sdk/send?accName=***&accPwd=***&aimcodes=***&content=内容【签名】&dataType=string

2.1.3.    响应Json格式

字段名称

类型

说明

replyCode

整型

执行结果 1 成功 0失败

replyMsg

Text

成功或失败原因具体信息

succeedNum

整型

成功条数(当次提交成功的手机号码个数)

failedNum

整型

失败条数(当次提交失败的手机号码个数)

chargCount

整型

计费条数(当次提交计费的短信条数)

deduction

整型

计费金额(当次提交的计费金额,单位:)

balance

整型

余额(当次提交后的账户余额:单位:)

示例:

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

2.1.4.    响应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>

2.1.5.    响应string格式

l  说明:

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

l  示例:

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

2.2.    查询余额

2.2.1.    请求地址

http://host/qryBalance

2.2.2.    发送参数

字段名称

是否可空

说明

accName

用户名(乐信登录账号)

accPwd

密码(乐信登录密码32MD5加密后转大写123456加密完以后为:E10ADC3949BA59ABBE56E057F20F883E)

2.2.3.    响应Json格式

字段名称

类型

说明

replyCode

整型

执行结果 1 成功 0失败

replyMsg

Text

成功或失败原因具体信息

balance

整型

余额,单位厘

示例:

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

2.2.4.    响应xml格式

字段名称

类型

说明

replyCode

整型

执行结果 1 成功 0失败

replyMsg

文本

成功或失败原因具体信息

balance

整型

余额,单位厘

示例:

<?xml version="1.0" encoding="UTF-8"?>

<QueryBalanceReply>

  <replyCode>1</replyCode>

  <replyMsg>查询成功</replyMsg>

  <balance>4750</balance>

</QueryBalanceReply>

2.2.5.    响应string格式

l  说明:

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

l  示例:

 1;查询成功;4750

2.3.    回复短信查询

2.3.1.    请求地址

http://host/receiveSms

2.3.2.    发送参数

字段名称

是否可空

说明

accName

用户名(乐信登录账号)

accPwd

密码(乐信登录密码32MD5加密后转大写123456加密完以后为:E10ADC3949BA59ABBE56E057F20F883E)

dataType

返回的数据(类型支持:json/xml/string 三种形式 默认string)

2.3.3.    响应Json格式

字段名称

类型

说明

replyCode

整型

执行结果1 成功0失败

replyMsg

Text

成功或失败原因具体信息

示例:

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

2.3.4.    响应xml格式

字段名称

类型

说明

replyCode

整型

执行结果 1 成功 0失败

replyMsg

文本

成功或失败原因具体信息

示例:

<?xml version="1.0" encoding="UTF-8"?>

<ReceiveSmsReply>

  <replyCode>1</replyCode>

  <replyMsg>接受短信成功!</replyMsg>

  <hasNext>0</hasNext>

  <receiveCount>0</receiveCount>

  <replyInfos/>

</ReceiveSmsReply>

2.3.5.    响应string格式

l  说明:

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

l  示例:

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

2.4.    回执推送

2.4.1.    推送地址

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

2.4.2.    推送参数及说明

参数名称

类型

说明

aimcodes

字符串

手机号,多个手机号以’,’隔开

msgids

字符串

短信的唯一ID(15位以内数字),多个ID’,’隔开

statuses

字符串

状态,多个状态以’,’隔开。

1表示回执成功;0表示回执失败;

acname

字符串

用户名

type

字符串

参数类型,0表示回执信息

 

2.4.3.    推送返回响应

合作方收到回执后返回响应“ok,为成功接收回执;其他为失败

如无反应或返回其它,重发两次后不再重发(总共推送3),重发间隔为2小时.

 

2.5.    回复推送

2.5.1.    推送地址

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

2.5.2.    推送参数及说明

参数名称

类型

说明

aimcode

字符串

上行手机号

acname

字符串

用户名

replycode

字符串

回复编码

content

字符串

回复内容

type

字符串

参数类型,1表示回复信息

 

2.5.3.    推送返回响应

合作方收到回复后返回响应“ok,为成功接收回执;其他为失败

如无反应或返回其它,重发两次后不再重发(总共推送3),重发间隔为2小时