2023年7月31日发(作者：)
一信通企业信息服务平台
接口手册
产品名称
版本编号
文档编号
发布者
发布日期
一信通企业信息服务平台接口手册
2012-5-10
目录
一信通企业信息服务平台 ........................................................................................ 错误!未定义书签。
1.
概述 .................................................................................................................. 错误!未定义书签。
2.
编制目的 .................................................................................................. 错误!未定义书签。
内容概述 .................................................................................................. 错误!未定义书签。
名称解释 .................................................................................................. 错误!未定义书签。
参考文献 .................................................................................................. 错误!未定义书签。
短信 .................................................................................................................. 错误!未定义书签。
HTTP接口 ................................................................................................... 错误!未定义书签。
消息协议 ..............................................................................................
错误!未定义书签。
发送短信 ..............................................................................................
错误!未定义书签。
回执接口 ..............................................................................................
错误!未定义书签。
剩余短信条数查询 ..............................................................................
错误!未定义书签。
回复内容接口 ......................................................................................
错误!未定义书签。
WEBSERVICE接口 ........................................................................................ 错误!未定义书签。
消息协议 ..............................................................................................
错误!未定义书签。
发送短信 ..............................................................................................
错误!未定义书签。
回执接口 ..............................................................................................
错误!未定义书签。
上行回复内容查询接口 ......................................................................
错误!未定义书签。
上行回复内容确认接口 ......................................................................
错误!未定义书签。
内容审核 ..............................................................................................
错误!未定义书签。
修改历史
日期
版本
作者
修改内容
评审号
更改请求号
1. 概述
1.1 编制目的
该接口文档手册编写在于描述易派企业信息服务平台UMS（以下简称UMS）具体的接口协议，供第三方系统能够顺利接入一信通短信网关。
1.2 内容概述
本规范主要讲了第三方系统接入短信通系统的协议要求，协议三大状态和协议指令的格式和响应信息。
1.3 名称解释
缩略语
UMS
SMS
API
MO
MT
SP
CP
英文全名
Unified Message Service
Short Messaging Service
Application Proframming Interface
Message Original
Message Terminal
Service Provider
Content Provider
中文全名
一信通
短消息服务
应用程序编程接口
消息上行
消息下行
服务提供商
内容提供商
1.4 参考文献
2. 短信
2.1 http接口
2.1.1 消息协议
接口地址： 通过接口提交参数时, 参数内容必须为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 发送短信
功能描述：短信发送
调用格式： 对 进行post
返回格式: result=&description=错误描述&faillist=失败号码列表
post参数说明：
类别
输入
输入
输入
输入
输入
输入
输入
输入
参数名称
SpCode
LoginName
Password
MessageContent
UserNumber
SerialNumber
ScheduleTime
类型
string
string
string
string
string
string
string
string
企业编号
用户名称
用户密码
说明
短信内容, 最大700个字符
手机号码(多个号码用”,”分隔)，最多1000个号码
流水号，20位数字，唯一
预约发送时间，格式:yyyyMMddhhmmss,如‘010101’，立即发送请填空
提交时检测方式
1 --- 提交号码中有效的号码仍正常发出短信，无效的号码在返回参数faillist中列出
不为1 或该参数不存在 --- 提交号码中只要有无效的号码，那么所有的号码都不发出短信，所f 有的号码在返回参数faillist中列出
返回值：
返回值
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
20
21
22
23
发送短信成功
提交参数不能为空
账号无效,
账号密码错误,
预约发送时间无效
IP不合法,
号码中含有无效号码或不在规定的号段,
内容中含有非法关键字、审核不通过、人工审核等
内容长度超过上限，最大402字符
接受号码过多，最大1000
黑名单用户
提交速度太快
您尚未订购[普通短信业务]，暂不能发送该类信息
您的[普通短信业务]剩余数量发送不足，暂不能发送该类信息
流水号格式不正确
流水号重复
超出发送上限
余额不足
扣费不成功
系统错误
您只能发送联通的手机号码，本次发送的手机号码中包含了非联通的手机号码
您只能发送移动的手机号码，本次发送的手机号码中包含了非移动的手机号码
您只能发送电信的手机号码，本次发送的手机号码中包含了非电信的手机号码
错误描述
实际返回内容为“result=0&description=发送成功”
2.1.3 回执接口
功能描述：短信回执
调用方式：ftp
返回格式:文本文件
ftp服务信息： 参数名称
ftp地址
端口
21
说明
返回文本文件格式:
文件名: arrive_000139_25288_0000000f_1556
一行内容：
SPID=197258 MESSAGEID=910320f1 ID=61 CALLMDN=01 MDN= RESULT=0 DESC=DELIVRD
ARRIVE_TIME=20
Java解析这行的方法
atcher(line);
}
Properties result = new Properties();
while ()) {
}
return result;
String key = (1).trim();
String value = (2).trim();
(), value);
如果要获取取接受短信的号码则使用：String mdn= (String)("MDN");即可
其他字段类似方式
2.1.4 剩余短信条数查询
功能描述：剩余短信条数查询接口
调用格式： 对进行post
返回格式: result=&description=错误描述&faillist=失败号码列表
post参数说明：
类别
输入
输入
输入
返回值:
返回值
0
1
2
3
发送短信成功
提交参数不能为空
账号无效,
账号密码错误,
错误描述
参数名称
SpCode
LoginName
Password
类型
string
string
string
企业编号
用户名称
用户密码
说明 5
20
IP不合法,
系统错误
2.1.5 回复内容接口
功能描述：将上行回复的内容通过http协议进行post到企业方
调用格式： url由企业方提供，然后对该url进行post,post的格式为xml,格式如下：
返回格式: 返回格式为xml,格式如下：
post参数说明：
类别
输入
输入
输入
输入
返回值:
返回值
0
接收成功
错误描述
参数名称
mdn
callmdn
msg
replytime
类型
string
string
string
手机号码
接入号
回复内容
回复时间
说明
2.2 Webservice接口
2.2.1 消息协议
2.2.2 接口地址：发送短信
功能描述：短信发送
调用格式： 利用webservice客户端进行http请求
返回格式:
SmsResponse SmsRequest请求参数说明：
类别
输入
输入
输入
输入
输入
输入
输入
输入
参数名称
In0
In1
In2
In3
In4
In5
In6
类型
string
string
string
string
string
string
string
string
企业编号
用户名称
用户密码
说明
短信内容, 最大402个字符
手机号码(多个号码用”,”分隔)，最多1000个号码
流水号，20位数字，唯一
预约发送时间，格式:yyyyMMddhhmmss,如‘010101’， 立即发送请填空
提交时检测方式
1 --- 提交号码中有效的号码仍正常发出短信，无效的号码在返回参数faillist中列出
不为1 或该参数不存在 --- 提交号码中只要有无效的号码，那么所有的号码都不发出短信，所有的号码在返回参数faillist中列出
保留
In7
输入
In8 string
SmsResponse返回值:
返回值
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
发送短信成功
提交参数不能为空
账号无效,
账号密码错误,
预约发送时间无效
IP不合法,
号码中含有无效号码或不在规定的号段,
内容中含有非法关键字、审核不通过、人工审核等
内容长度超过上限，最大402字符
接受号码过多，最大1000
黑名单用户
提交速度太快
您尚未订购[普通短信业务]，暂不能发送该类信息
您的[普通短信业务]剩余数量发送不足，暂不能发送该类信息
流水号格式不正确
流水号重复
超出发送上限
余额不足
扣费不成功
错误描述 20
21
22
23
系统错误
您只能发送联通的手机号码，本次发送的手机号码中包含了非联通的手机号码
您只能发送移动的手机号码，本次发送的手机号码中包含了非移动的手机号码
您只能发送电信的手机号码，本次发送的手机号码中包含了非电信的手机号码
实际返回内容为“result=0&description=发送成功”
2.2.3 回执接口
功能描述：短信回执
调用方式：利用webservice客户端进行http请求
返回格式: ReportResponse
ReportRequest请求参数说明：
类别
输入
输入
输入
ReportResponse返回值:
参数名称
In0
In1
In2
类型
string
string
string
企业编号
用户名称
用户密码
说明
类别
输入
参数名称
out
类型
string
说明
回执结果，每条回执按分号隔开，每个字段按逗号隔开，每条回执共包含3个字段，第1个字段为流水号，第2个字段为被发送的手机号码，第3个字段为回执结果，0表示成功，其他值表示失败
实际返回内容为“00000001,,0;
00000001,,0;00000001,,0;”
2.2.4 上行回复内容查询接口
功能描述：上行回复内容查询
调用方式：利用webservice客户端进行http请求
返回格式: ReplyResponse
ReplyRequest请求参数说明：
类别 参数名称 类型 说明 输入
输入
输入
In0
In1
In2
string
string
string
企业编号
用户名称
用户密码
ReplyResponse返回值:
类别
输出
输出
输出
返回值
0
1
2
3
20
reply的属性值
类别
输出
输出
输出
输出
参数名称
result
confirm_time
replys
类型
string
string
reply数组
返回码
说明
回复时间，格式yyyy-MM-dd HH:mm:ss
多个relpy对象组成
错误描述
成功
提交参数不能为空
账号无效,
账号密码错误,
系统错误
参数名称
callMdn
mdn
message
reply_time
类型
string
string
string
string
接入号
用户手机号
回复内容
说明
回复时间，格式yyyy-MM-dd HH:mm:ss
2.2.5 上行回复内容确认接口
功能描述：上行回复内容查询
调用方式：利用webservice客户端进行http请求
返回格式: ReplyConfirmResponse
ReplyConfirmRequest请求参数说明：
类别
输入
输入
输入
输入
ReplyConfirmResponse返回值:
参数名称
In0
In1
In2
In3
类型
string
string
string
string
企业编号
用户名称
用户密码
说明
上行回复内容查询接口返回的时间，格式：yyyy-MM-dd HH:mm:ss
类别
输出
参数名称
result
类型
string
返回码
说明
返回值
0
1
2
3
4
20
成功
提交参数不能为空
账号无效,
账号密码错误,
错误描述
时间格式不正确,格式为：yyyy-MM-dd HH:mm:ss
系统错误
2.2.6 内容审核
功能描述：短信发送
调用格式： 利用webservice客户端进行http请求
返回格式:
AuditingResponse
AuditingRequest请求参数说明：
类别
输入
输入
输入
输入
AuditingResponse返回值:
参数名称
In0
In1
In2
In3
类型
string
string
string
string
企业编号
用户名称
用户密码
说明
短信内容, 最大402个字符
返回值
0
1
2
3
4
5
20
短信内容审核通过
提交参数不能为空
账号无效,
账号密码错误,
内容中含有非法关键字，关键字按逗号隔开
需要人工审核
系统错误
错误描述
实际返回内容为“result=0&description=短信内容审核通过”
2023年7月31日发(作者：)
一信通企业信息服务平台
接口手册
产品名称
版本编号
文档编号
发布者
发布日期
一信通企业信息服务平台接口手册
2012-5-10
目录
一信通企业信息服务平台 ........................................................................................ 错误!未定义书签。
1.
概述 .................................................................................................................. 错误!未定义书签。
2.
编制目的 .................................................................................................. 错误!未定义书签。
内容概述 .................................................................................................. 错误!未定义书签。
名称解释 .................................................................................................. 错误!未定义书签。
参考文献 .................................................................................................. 错误!未定义书签。
短信 .................................................................................................................. 错误!未定义书签。
HTTP接口 ................................................................................................... 错误!未定义书签。
消息协议 ..............................................................................................
错误!未定义书签。
发送短信 ..............................................................................................
错误!未定义书签。
回执接口 ..............................................................................................
错误!未定义书签。
剩余短信条数查询 ..............................................................................
错误!未定义书签。
回复内容接口 ......................................................................................
错误!未定义书签。
WEBSERVICE接口 ........................................................................................ 错误!未定义书签。
消息协议 ..............................................................................................
错误!未定义书签。
发送短信 ..............................................................................................
错误!未定义书签。
回执接口 ..............................................................................................
错误!未定义书签。
上行回复内容查询接口 ......................................................................
错误!未定义书签。
上行回复内容确认接口 ......................................................................
错误!未定义书签。
内容审核 ..............................................................................................
错误!未定义书签。
修改历史
日期
版本
作者
修改内容
评审号
更改请求号
1. 概述
1.1 编制目的
该接口文档手册编写在于描述易派企业信息服务平台UMS（以下简称UMS）具体的接口协议，供第三方系统能够顺利接入一信通短信网关。
1.2 内容概述
本规范主要讲了第三方系统接入短信通系统的协议要求，协议三大状态和协议指令的格式和响应信息。
1.3 名称解释
缩略语
UMS
SMS
API
MO
MT
SP
CP
英文全名
Unified Message Service
Short Messaging Service
Application Proframming Interface
Message Original
Message Terminal
Service Provider
Content Provider
中文全名
一信通
短消息服务
应用程序编程接口
消息上行
消息下行
服务提供商
内容提供商
1.4 参考文献
2. 短信
2.1 http接口
2.1.1 消息协议
接口地址： 通过接口提交参数时, 参数内容必须为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 发送短信
功能描述：短信发送
调用格式： 对 进行post
返回格式: result=&description=错误描述&faillist=失败号码列表
post参数说明：
类别
输入
输入
输入
输入
输入
输入
输入
输入
参数名称
SpCode
LoginName
Password
MessageContent
UserNumber
SerialNumber
ScheduleTime
类型
string
string
string
string
string
string
string
string
企业编号
用户名称
用户密码
说明
短信内容, 最大700个字符
手机号码(多个号码用”,”分隔)，最多1000个号码
流水号，20位数字，唯一
预约发送时间，格式:yyyyMMddhhmmss,如‘010101’，立即发送请填空
提交时检测方式
1 --- 提交号码中有效的号码仍正常发出短信，无效的号码在返回参数faillist中列出
不为1 或该参数不存在 --- 提交号码中只要有无效的号码，那么所有的号码都不发出短信，所f 有的号码在返回参数faillist中列出
返回值：
返回值
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
20
21
22
23
发送短信成功
提交参数不能为空
账号无效,
账号密码错误,
预约发送时间无效
IP不合法,
号码中含有无效号码或不在规定的号段,
内容中含有非法关键字、审核不通过、人工审核等
内容长度超过上限，最大402字符
接受号码过多，最大1000
黑名单用户
提交速度太快
您尚未订购[普通短信业务]，暂不能发送该类信息
您的[普通短信业务]剩余数量发送不足，暂不能发送该类信息
流水号格式不正确
流水号重复
超出发送上限
余额不足
扣费不成功
系统错误
您只能发送联通的手机号码，本次发送的手机号码中包含了非联通的手机号码
您只能发送移动的手机号码，本次发送的手机号码中包含了非移动的手机号码
您只能发送电信的手机号码，本次发送的手机号码中包含了非电信的手机号码
错误描述
实际返回内容为“result=0&description=发送成功”
2.1.3 回执接口
功能描述：短信回执
调用方式：ftp
返回格式:文本文件
ftp服务信息： 参数名称
ftp地址
端口
21
说明
返回文本文件格式:
文件名: arrive_000139_25288_0000000f_1556
一行内容：
SPID=197258 MESSAGEID=910320f1 ID=61 CALLMDN=01 MDN= RESULT=0 DESC=DELIVRD
ARRIVE_TIME=20
Java解析这行的方法
atcher(line);
}
Properties result = new Properties();
while ()) {
}
return result;
String key = (1).trim();
String value = (2).trim();
(), value);
如果要获取取接受短信的号码则使用：String mdn= (String)("MDN");即可
其他字段类似方式
2.1.4 剩余短信条数查询
功能描述：剩余短信条数查询接口
调用格式： 对进行post
返回格式: result=&description=错误描述&faillist=失败号码列表
post参数说明：
类别
输入
输入
输入
返回值:
返回值
0
1
2
3
发送短信成功
提交参数不能为空
账号无效,
账号密码错误,
错误描述
参数名称
SpCode
LoginName
Password
类型
string
string
string
企业编号
用户名称
用户密码
说明 5
20
IP不合法,
系统错误
2.1.5 回复内容接口
功能描述：将上行回复的内容通过http协议进行post到企业方
调用格式： url由企业方提供，然后对该url进行post,post的格式为xml,格式如下：
返回格式: 返回格式为xml,格式如下：
post参数说明：
类别
输入
输入
输入
输入
返回值:
返回值
0
接收成功
错误描述
参数名称
mdn
callmdn
msg
replytime
类型
string
string
string
手机号码
接入号
回复内容
回复时间
说明
2.2 Webservice接口
2.2.1 消息协议
2.2.2 接口地址：发送短信
功能描述：短信发送
调用格式： 利用webservice客户端进行http请求
返回格式:
SmsResponse SmsRequest请求参数说明：
类别
输入
输入
输入
输入
输入
输入
输入
输入
参数名称
In0
In1
In2
In3
In4
In5
In6
类型
string
string
string
string
string
string
string
string
企业编号
用户名称
用户密码
说明
短信内容, 最大402个字符
手机号码(多个号码用”,”分隔)，最多1000个号码
流水号，20位数字，唯一
预约发送时间，格式:yyyyMMddhhmmss,如‘010101’， 立即发送请填空
提交时检测方式
1 --- 提交号码中有效的号码仍正常发出短信，无效的号码在返回参数faillist中列出
不为1 或该参数不存在 --- 提交号码中只要有无效的号码，那么所有的号码都不发出短信，所有的号码在返回参数faillist中列出
保留
In7
输入
In8 string
SmsResponse返回值:
返回值
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
发送短信成功
提交参数不能为空
账号无效,
账号密码错误,
预约发送时间无效
IP不合法,
号码中含有无效号码或不在规定的号段,
内容中含有非法关键字、审核不通过、人工审核等
内容长度超过上限，最大402字符
接受号码过多，最大1000
黑名单用户
提交速度太快
您尚未订购[普通短信业务]，暂不能发送该类信息
您的[普通短信业务]剩余数量发送不足，暂不能发送该类信息
流水号格式不正确
流水号重复
超出发送上限
余额不足
扣费不成功
错误描述 20
21
22
23
系统错误
您只能发送联通的手机号码，本次发送的手机号码中包含了非联通的手机号码
您只能发送移动的手机号码，本次发送的手机号码中包含了非移动的手机号码
您只能发送电信的手机号码，本次发送的手机号码中包含了非电信的手机号码
实际返回内容为“result=0&description=发送成功”
2.2.3 回执接口
功能描述：短信回执
调用方式：利用webservice客户端进行http请求
返回格式: ReportResponse
ReportRequest请求参数说明：
类别
输入
输入
输入
ReportResponse返回值:
参数名称
In0
In1
In2
类型
string
string
string
企业编号
用户名称
用户密码
说明
类别
输入
参数名称
out
类型
string
说明
回执结果，每条回执按分号隔开，每个字段按逗号隔开，每条回执共包含3个字段，第1个字段为流水号，第2个字段为被发送的手机号码，第3个字段为回执结果，0表示成功，其他值表示失败
实际返回内容为“00000001,,0;
00000001,,0;00000001,,0;”
2.2.4 上行回复内容查询接口
功能描述：上行回复内容查询
调用方式：利用webservice客户端进行http请求
返回格式: ReplyResponse
ReplyRequest请求参数说明：
类别 参数名称 类型 说明 输入
输入
输入
In0
In1
In2
string
string
string
企业编号
用户名称
用户密码
ReplyResponse返回值:
类别
输出
输出
输出
返回值
0
1
2
3
20
reply的属性值
类别
输出
输出
输出
输出
参数名称
result
confirm_time
replys
类型
string
string
reply数组
返回码
说明
回复时间，格式yyyy-MM-dd HH:mm:ss
多个relpy对象组成
错误描述
成功
提交参数不能为空
账号无效,
账号密码错误,
系统错误
参数名称
callMdn
mdn
message
reply_time
类型
string
string
string
string
接入号
用户手机号
回复内容
说明
回复时间，格式yyyy-MM-dd HH:mm:ss
2.2.5 上行回复内容确认接口
功能描述：上行回复内容查询
调用方式：利用webservice客户端进行http请求
返回格式: ReplyConfirmResponse
ReplyConfirmRequest请求参数说明：
类别
输入
输入
输入
输入
ReplyConfirmResponse返回值:
参数名称
In0
In1
In2
In3
类型
string
string
string
string
企业编号
用户名称
用户密码
说明
上行回复内容查询接口返回的时间，格式：yyyy-MM-dd HH:mm:ss
类别
输出
参数名称
result
类型
string
返回码
说明
返回值
0
1
2
3
4
20
成功
提交参数不能为空
账号无效,
账号密码错误,
错误描述
时间格式不正确,格式为：yyyy-MM-dd HH:mm:ss
系统错误
2.2.6 内容审核
功能描述：短信发送
调用格式： 利用webservice客户端进行http请求
返回格式:
AuditingResponse
AuditingRequest请求参数说明：
类别
输入
输入
输入
输入
AuditingResponse返回值:
参数名称
In0
In1
In2
In3
类型
string
string
string
string
企业编号
用户名称
用户密码
说明
短信内容, 最大402个字符
返回值
0
1
2
3
4
5
20
短信内容审核通过
提交参数不能为空
账号无效,
账号密码错误,
内容中含有非法关键字，关键字按逗号隔开
需要人工审核
系统错误
错误描述
实际返回内容为“result=0&description=短信内容审核通过”
发布评论