欢迎访问

深圳新锐信息科技有限公司

网站


短信接口WebService

接口地址:url/webService/smsOper?wsdl

说明:该地址是短信服务平台提供的服务地址,其中只需要修改url部分;

例如:http://sz.iveng.com/sms/webService/smsOper?wsdl

例如:http://sz.iveng.com/sms/webService/smsWebservice?wsdl(单条)

绑定服务:ISmsOperator

1.1.1.      短信下行

1.1.1.1.  自定义数据结构说明

自定义数据结构均为数据封装需要,只有数据属性和对应的get,set方法

结构名称:MtMessage

结构说明:客户端请求发送短信时的输入参数之一

属性名称

类型

推荐值

说明

smsId

String

短信标识,唯壹标识本次下发请求的短信id,建议是uuid,

建议为空,为空时,将由服务端生成短信标识返回;该值还被后面匹配每条短信的发送状态报告所使用。

phoneNumber

String[]

接收短信的手机号码,必填

下发号码,该数组大小不能超过10000,即一次不能发送超过10000个号码,每个下发号码均为合法的11位手机号码。

content

String

短信内容,必填

短信内容,不能超过500个字符。

subCode

String

扩展子码,可为空;手机端接收到的短信中,显示源号码的末几位,前提是网关要支持扩展码发送

sendTime

Date

下发时间,本次请求的所有短信的下发时间,为空时表示立即发送。

type

string

为空或为0时为国内短信,为1是为国际短信

demo

String

预留,目前为空。

结构名称:MtMessageRes

结构说明:客户端请求发送短信时,服务端的返回值

属性名称

类型

推荐值

说明

smsId

String

服务端返回

短信标识,唯壹标识本次下发请求的id,如果客户端请求参数”MtMessage”中的”smsId”不为空,则该值等于客户端的”smsId”,否则,该值由服务端自动生成返回;该值还被后面匹配每条短信的发送状态报告所使用。

subStat

String

服务端返回

请求处理结果,本次请求,服务端是否正确处理,详情请参照本文档 1.1.5 节“状态码说明”。

subStatDes

String

服务端返回

请求处理结果描述,如果subStat r:000 时,该值可不用理会,否则该值会描述具体处理失败原因,详情请参照本文档 1.1.5 节“状态码说明”。

resDetail

MtMessageResDetail[]

服务端返回

短信提交处理结果详情,该数组描述客户端请求的每个手机号码提交状态,详情请参照MtMessageResDetail说明。

结构名称:MtMessageResDetail

结构说明:短信提交处理结果详情,详细描述每个号码的处理结果。

属性名称

类型

推荐值

说明

phoneNumber

String

服务端返回

接收手机号码

stat

String

服务端返回

提交状态,本号码是否正确处理,详情请参照本文档 1.1.5 节“状态码说明”。

subStatDes

String

服务端返回

提交状态描述,如果stat r:000 时,该值可不用理会,否则该值会描述本号码具体处理失败原因,详情请参照本文档 1.1.5 节“状态码说明”。

1.1.1.2.  发送一条或者多条内容相同的短信

方法名称

sendSms

功能

发送一条或则多条内容相同的短信。

接口方法

MtMessageRessendSms(String account, String password, String smsType, MtMessage message)

输入说明

account:账号。

password:密码(用MD5加密32位,加密后字母全部为小写,例如:“123.com

加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确)。

smsType:短信类型,可为空。

Message:自定义数据对象,详情请参照自定义数据结构:MtMessage

输出说明

MtMessageRes:详情请参照自定义数据结构:MtMessageRes

1.1.1.3.  批量发送内容不同的短信

方法名称

bathSendSms

功能

批量发内容不相同的短信。

接口方法

MtMessageResbathSendSms(String account, String password, String smsType, MtMessage[] messageArray)

输入说明

account:账号。

password:密码(用MD5加密32位,加密后字母全部为小写,例如:“123.com

加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确)。

smsType:短信类型,可为空。

messageArray:自定义数据对象数组,详情请参照自定义数据结构:MtMessage

输出说明

MtMessageRes:详情请参照自定义数据结构:MtMessageRes

1.1.2.      短信状态报告

1.1.2.1.  自定义数据结构说明

所有自定义数据结构均为数据封装需要,只有数据属性和对应的get,set方法

结构名称:ReportMessageRes

结构说明:客户端发起请求,获取状态报告返回值

属性名称

类型

推荐值

说明

subStat

String

服务端返回

请求处理结果,本次请求,服务端是否正确处理,详情请参照本文档 1.1.5 节“状态码说明”。

subStatDes

String

服务端返回

处理结果描述,如果subStat r:000 时,该值可不用理会,否则该值会描述具体处理失败原因,详情请参照本文档 1.1.5 节“状态码说明”。

resDetail

ReportMessageResDetail[]

服务端返回

状态报告详情,该数组描述每条短信的发送状态,详情请参照ReportMessageResDetail说明。

结构名称:ReportMessageResDetail

结构名称:状态报告详情

属性名称

类型

推荐值

说明

smsId

String

服务端返回

短信标识,和请求下发时生成的短信标识一致

phoneNumber

String

服务端返回

接收手机号码

stat

String

服务端返回

发送状态,是否正确发送,详情请参照本文档 1.1.5 节“状态码说明”。

statDes

String

服务端返回

发送状态描述,如果stat r:000 时,该值可不用理会,否则该值会描述本号码具体失败原因,详情请参照本文档 1.1.5 节“状态码说明”。

revTime

String

服务端返回

回执时间,格式yyyy-MM-dd HH:mm:ss

1.1.2.2.  客户端主动获取状态报告

请使用短信服务平台提供的wsdl文件生成服务端

名称

getReport

功能

获取下发短信的状态报告。

接口方法

ReportMessageResgetReport(String account, String password)

输入说明

account:账号。

password:密码(用MD5加密32位,加密后字母全部为小写,例如:“123.com

加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确)。

输出说明

ReportMessageRes:详情请参照自定义数据结构:ReportMessageRes

1.1.2.3.  客户端接收状态报告,由服务端推送到客户端

如果客户端需要由服务端推送状态报告,则客户端系统需要实现webservice服务,提供url地址,该服务必须实现以下方法。

名称

getReport

功能

获取下发短信的状态报告。

接口方法

booleangetReport(String account, ReportMessageResDetail[] reportMessageArray)

输入说明

account:接收状态报告的接口账号。

reportMessageArray:状态报告信息,详情请参照自定义数据结构:ReportMessageResDetail

输出说明

boolean:是否正确接收,如果客户端正常接收到状态报告信息,必须返回true,否则服务端认为推送失败,会重复推送。

1.1.3.      短信上行

1.1.3.1.  自定义数据结构说明

所有自定义数据结构均为数据封装需要,只有数据属性和对应的get,set方法

结构名称:MoMessageRes

结构说明:客户端发起请求,获取上行短信返回值

属性名称

类型

推荐值

说明

revStat

String

服务端返回

请求处理结果,本次请求,服务端是否正确处理,详情请参照本文档 1.1.5 节“状态码说明”。

revStatDes

String

服务端返回

处理结果描述,如果revStat r:000 时,该值可不用理会,否则该值会描述具体处理失败原因,详情请参照本文档 1.1.5 节“状态码说明”。

resDetail

MoMessageResDetail[]

服务端返回

上行短信详情,该数组描述每条上行短信的详细信息,详情请参照MoMessageResDetail说明。

结构名称:MoMessageResDetail

结构说明:上行短信详情

属性名称

类型

推荐值

说明

phoneNumber

String

服务端返回

发送手机号码,发送该条上行短信的手机号。

content

String

服务端返回

上行短信内容

subCode

String

服务端返回

扩展码,可能为空。

revTime

Date

服务端返回

平台接收该条上行时间

demo

String

服务端返回

预留

1.1.3.2.  客户端主动获取上行短信

请使用短信服务平台提供的wsdl文件生成服务端

方法名称

getSms

功能

获取上行短信。

接口方法

MoMessageResgetSms(String account, String password)

输入说明

account:账号。

password:密码(用MD5加密32位,加密后字母全部为小写,例如:“123.com

加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确)。

输出说明

MoMessageRes:详情请参照自定义数据结构:MoMessageRes

1.1.3.3.  客户端接收上行短信,由服务端推送到客户端

如果客户端需要由服务端推送上行短信,则客户端系统需要实现webservice服务,提供url地址,该服务必须实现以下方法。

名称

getSms

功能

获取上行短信。

接口方法

booleangetSms(String account, MoMessageResDetail[] moMessageArray)

输入说明

account:接收上行短信的接口账号。

MoMessageResDetail:上行短信信息,详情请参照自定义数据结构:MoMessageResDetail

输出说明

boolean:是否正确接收,如果客户端正常接收到上行短信信息,必须返回true,否则服务端认为推送失败,会重复推送。

1.1.4.      账户余额

1.1.4.1.  自定义数据结构说明

所有自定义数据结构均为数据封装需要,只有数据属性和对应的get,set方法

结构名称:BalanceRes

结构说明:客户端发起请求,获取账户余额

属性名称

类型

推荐值

说明

revStat

String

服务端返回

请求处理结果,本次请求,服务端是否正确处理,详情请参照本文档 1.1.5 节“状态码说明”。

revStatDes

String

服务端返回

处理结果描述,如果revStat r:000 时,该值表示请求账户的余额信息,否则该值会描述具体处理失败原因,详情请参照本文档 1.1.5 节“状态码说明”。

demo

String

服务端返回

预留。

1.1.4.2.  客户端主动获取账户余额

方法名称

getBalance

功能

获取上行短信。

接口方法

BalanceResgetBalance(String account, String password)

输入说明

account:账号。

password:密码(用MD5加密32位,加密后字母全部为小写,例如:“123.com

加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确)。

输出说明

BalanceRes:详情请参照自定义数据结构:BalanceRes

1.1.5.      状态码说明

状态码

类型

描述

r:000

平台处理返回值

成功(只要该状态码表示成功,其他均为失败)

r:001

平台处理返回值

手机号码是黑名单号码

r:002

平台处理返回值

手机号码不正确,非法手机号

r:003

平台处理返回值

账户没有本接口权限,没有为该用户设置webservice权限

r:004

平台处理返回值

短信发送失败(由于营运商网关给出了失败的状态报告,所以短信的发送状态为发送失败)

r:999

平台处理返回值

未知错误

p:001

输入参数错误

短信内容为空

p:002

输入参数错误

手机号码数组为空

p:003

输入参数错误

帐号或者密码不正确

p:004

输入参数错误

帐号余额不足

p:005

输入参数错误

超出每日限制发送量

p:006

输入参数错误

一次提交号码数量超过1000

p:007

输入参数错误

业务类型不正确

p:008

输入参数错误

ip鉴权失败(需要ip鉴权时有效)

p:009

输入参数错误

短信内容含有敏感词

p:010

输入参数错误

签名不正确

p:011

输入参数错误

输入参数格式不正确,必须是文档中规定的xml格式。


 
<
线

商盟客服 >
您好,欢迎莅临我们的网站,欢迎咨询...

  • 黄经理: 点击这里给我发消息