一信通短信接口文档.docx
《一信通短信接口文档.docx》由会员分享，可在线阅读，更多相关《一信通短信接口文档.docx（14页珍藏版）》请在冰豆网上搜索。
一信通短信接口文档
一信通企业信息服务平台
接口手册
产品名称
一信通企业信息服务平台接口手册
版本编号
2.1.2
文档编号
发布者
发布日期
2012-5-10
修改历史
日期
版本
作者
修改容
评审号
更改请求号
1.概述
1.1编制目的
该接口文档手册编写在于描述易派企业信息服务平台UMS（以下简称UMS）具体的接口协议，供第三方系统能够顺利接入一信通短信网关。
1.2容概述
本规主要讲了第三方系统接入短信通系统的协议要求，协议三大状态和协议指令的格式和响应信息。
1.3名称解释
缩略语
英文全名
中文全名
UMS
UnifiedMessageService
一信通
SMS
ShortMessagingService
短消息服务
API
ApplicationProframmingInterface
应用程序编程接口
MO
MessageOriginal
消息上行
MT
MessageTerminal
消息下行
SP
ServiceProvider
服务提供商
CP
ContentProvider
容提供商
1.4参考文献
2.短信
2
2.1http接口
2.1.1消息协议
接口地址：
guangdong.ums86.:
8899/sms/Api/
通过接口提交参数时,参数容必须为GB2312编码,且经过url编码后的容。
例如:
“您好”的url编码为“%C4%FA%BA%C3”
接口返回的容是一些键值对的字符串集合，形式为:
“k1=v1&k2=v2&k3=v3…”
返回容中的键值显示为url编码形式,经过url解码后的键值是GB2312编码的字符串。
例如:
返回容“result=0&description=%B7%A2%CB%CD%B3%C9%B9%A6&faillist=”表示的实际容为“result=0&description=发送成功&faillist=”
2.1.2发送短信
功能描述：
短信发送
调用格式：
对guangdong.ums86.:
8899/sms/Api/Send.do进行post
返回格式:
result=&description=错误描述&faillist=失败列表
post参数说明：
类别
参数名称
类型
说明
输入
SpCode
string
企业编号
输入
LoginName
string
用户名称
输入
Password
string
用户密码
输入
MessageContent
string
短信容,最大700个字符
输入
UserNumber
string
手机（多个用”,”分隔），最多1000个
输入
SerialNumber
string
流水号，20位数字，唯一
输入
ScheduleTime
string
预约发送时间，格式:
yyyyMMddhhmmss,如‘101’，立即发送请填空
输入
f
string
提交时检测方式
1---提交中有效的仍正常发出短信，无效的在返回参数faillist中列出
不为1或该参数不存在---提交中只要有无效的，那么所有的都不发出短信，所有的在返回参数faillist中列出
返回值：
返回值
错误描述
0
发送短信成功
1
提交参数不能为空
2
账号无效,
3
账号密码错误,
4
预约发送时间无效
5
IP不合法,
6
中含有无效或不在规定的号段,
7
容中含有非法关键字、审核不通过、人工审核等
8
容长度超过上限，最大402字符
9
接受过多，最大1000
10
黑用户
11
提交速度太快
12
您尚未订购[普通短信业务]，暂不能发送该类信息
13
您的[普通短信业务]剩余数量发送不足，暂不能发送该类信息
14
流水号格式不正确
15
流水号重复
16
超出发送上限
17
余额不足
18
扣费不成功
20
系统错误
21
您只能发送联通的手机，本次发送的手机中包含了非联通的手机
22
您只能发送移动的手机，本次发送的手机中包含了非移动的手机
23
您只能发送电信的手机，本次发送的手机中包含了非电信的手机
实际返回容为“result=0&description=发送成功”
2.1.3回执接口
功能描述：
短信回执
调用方式：
ftp
返回格式:
文本文件
ftp服务信息：
参数名称
说明
ftp地址
guangdong.ums86.
端口
21
返回文本文件格式:
文件名:
arrive_000139_25288_00f_6
一行容：
SPID=197258MESSAGEID=910320f1ID=2432901361CALLMDN=2501MDN=RESULT=0DESC=DELIVRDARRIVE_TIME=402
Java解析这行的方法
//解析一行记录
publicstaticPropertiesparse（Stringline）{
StringparsePattern="（[^=\t]+）=（[^\t]*）";
Matcherm=Ppile（parsePattern）.matcher（line）;
Propertiesresult=newProperties（）;
while（m.find（））{
Stringkey=m.group
（1）.trim（）;
Stringvalue=m.group
（2）.trim（）;
result.put（key.toUpperCase（）,value）;
}
returnresult;
}
如果要获取取接受短信的则使用：
Stringmdn=（String）result.get（"MDN"）;即可
其他字段类似方式
2.1.4剩余短信条数查询
功能描述：
剩余短信条数查询接口
调用格式：
对guangdong.ums86.:
8899/sms/Api/SearchNumber.do进行post
返回格式:
result=&description=错误描述&faillist=失败列表
post参数说明：
类别
参数名称
类型
说明
输入
SpCode
string
企业编号
输入
LoginName
string
用户名称
输入
Password
string
用户密码
返回值:
返回值
错误描述
0
发送短信成功
1
提交参数不能为空
2
账号无效,
3
账号密码错误,
5
IP不合法,
20
系统错误
2.1.5回复容接口
功能描述：
将上行回复的容通过http协议进行post到企业方
调用格式：
url由企业方提供，然后对该url进行post,post的格式为xml,格式如下：
111
回复容测试
2012-01-0100:
00:
00
返回格式:
返回格式为xml,格式如下：
0
post参数说明：
类别
参数名称
类型
说明
输入
mdn
string
手机
输入
callmdn
接入号
输入
msg
string
回复容
输入
replytime
string
回复时间
返回值:
返回值
错误描述
0
接收成功
2.2Webservice接口
2.2.1消息协议
接口地址：
guangdong.ums86.:
8899/sms_hb/services/Sms?
wsdl
2.2.2发送短信
功能描述：
短信发送
调用格式：
利用webservice客户端进行http请求
返回格式:
SmsResponse
SmsRequest请求参数说明：
类别
参数名称
类型
说明
输入
In0
string
企业编号
输入
In1
string
用户名称
输入
In2
string
用户密码
输入
In3
string
短信容,最大402个字符
输入
In4
string
手机（多个用”,”分隔），最多1000个
输入
In5
string
流水号，20位数字，唯一
输入
In6
string
预约发送时间，格式:
yyyyMMddhhmmss,如‘101’，立即发送请填空
输入
In7
string
提交时检测方式
1---提交中有效的仍正常发出短信，无效的在返回参数faillist中列出
不为1或该参数不存在---提交中只要有无效的，那么所有的都不发出短信，所有的在返回参数faillist中列出
输入
In8
string
保留
SmsResponse返回值:
返回值
错误描述
0
发送短信成功
1
提交参数不能为空
2
账号无效,
3
账号密码错误,
4
预约发送时间无效
5
IP不合法,
6
中含有无效或不在规定的号段,
7
容中含有非法关键字、审核不通过、人工审核等
8
容长度超过上限，最大402字符
9
接受过多，最大1000
10
黑用户
11
提交速度太快
12
您尚未订购[普通短信业务]，暂不能发送该类信息
13
您的[普通短信业务]剩余数量发送不足，暂不能发送该类信息
14
流水号格式不正确
15
流水号重复
16
超出发送上限
17
余额不足
18
扣费不成功
20
系统错误
21
您只能发送联通的手机，本次发送的手机中包含了非联通的手机
22
您只能发送移动的手机，本次发送的手机中包含了非移动的手机
23
您只能发送电信的手机，本次发送的手机中包含了非电信的手机
实际返回容为“result=0&description=发送成功”
2.2.3回执接口
功能描述：
短信回执
调用方式：
利用webservice客户端进行http请求
返回格式:
ReportResponse
ReportRequest请求参数说明：
类别
参数名称
类型
说明
输入
In0
string
企业编号
输入
In1
string
用户名称
输入
In2
string
用户密码
ReportResponse返回值:
类别
参数名称
类型
说明
输入
out
string
回执结果，每条回执按分号隔开，每个字段按逗号隔开，每条回执共包含3个字段，第1个字段为流水号，第2个字段为被发送的手机，第3个字段为回执结果，0表示成功，其他值表示失败
实际返回容为“001,,0;001,,0;001,,0;”
2.2.4上行回复容查询接口
功能描述：
上行回复容查询
调用方式：
利用webservice客户端进行http请求
返回格式:
ReplyResponse
ReplyRequest请求参数说明：
类别
参数名称
类型
说明
输入
In0
string
企业编号
输入
In1
string
用户名称
输入
In2
string
用户密码
ReplyResponse返回值:
类别
参数名称
类型
说明
输出
result
string
返回码
输出
confirm_time
string
回复时间，格式yyyy-MM-ddHH:
mm:
ss
输出
replys
reply数组
多个relpy对象组成
返回值
错误描述
0
成功
1
提交参数不能为空
2
账号无效,
3
账号密码错误,
20
系统错误
reply的属性值
类别
参数名称
类型
说明
输出
callMdn
string
接入号
输出
mdn
string
用户手机号
输出
message
string
回复容
输出
reply_time
string
回复时间，格式yyyy-MM-ddHH:
mm:
ss
2.2.5上行回复容确认接口
功能描述：
上行回复容查询
调用方式：
利用webservice客户端进行http请求
返回格式:
ReplyConfirmResponse
ReplyConfirmRequest请求参数说明：
类别
参数名称
类型
说明
输入
In0
string
企业编号
输入
In1
string
用户名称
输入
In2
string
用户密码
输入
In3
string
上行回复容查询接口返回的时间，格式：
yyyy-MM-ddHH:
mm:
ss
ReplyConfirmResponse返回值:
类别
参数名称
类型
说明
输出
result
string
返回码
返回值
错误描述
0
成功
1
提交参数不能为空
2
账号无效,
3
账号密码错误,
4
时间格式不正确,格式为：
yyyy-MM-ddHH:
mm:
ss
20
系统错误
2.2.6容审核
功能描述：
短信发送
调用格式：
利用webservice客户端进行http请求
返回格式:
AuditingResponse
AuditingRequest请求参数说明：
类别
参数名称
类型
说明
输入
In0
string
企业编号
输入
In1
string
用户名称
输入
In2
string
用户密码
输入
In3
string
短信容,最大402个字符
AuditingResponse返回值:
返回值
错误描述
0
短信容审核通过
1
提交参数不能为空
2
账号无效,
3
账号密码错误,
4
容中含有非法关键字，关键字按逗号隔开
5
需要人工审核
20
系统错误
实际返回容为“result=0&description=短信容审核通过”
升级会员 