信通企业信息服务平台接口手册.doc

《信通企业信息服务平台接口手册.doc》由会员分享，可在线阅读，更多相关《信通企业信息服务平台接口手册.doc（19页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、一信通企业信息效劳平台接口手册产品名称一信通企业信息效劳平台接口手册版本编号文档编号发布者发布日期2021-11-28目录一信通企业信息效劳平台11.概述3编制目的3内容概述3名称解释3参考文献32.短信4 接口4消息协议4发送短信4回执接口6剩余短信条数查询6上行回复内容查询接口7上行回复内容确认接口8Webservice接口8消息协议8发送短信8回执接口10上行回复内容查询接口10上行回复内容确认接口11内容审核12修改历史日期版本作者修改内容评审号更改请求号1. 概述1.1 编制目的 该接口文档手册编写在于描述一信通企业信息效劳平台UMS以下简称UMS具体的接口协议，供第三方系统能够顺利

2、接入一信通短信网关。1.2 内容概述 本标准主要讲了第三方系统接入短信通系统的协议要求，协议三大状态与协议指令的格式与响应信息。1.3 名称解释缩略语英文全名中文全名UMSUnified Message Service一信通SMSShort Messaging Service短消息效劳APIApplication Proframming Interface应用程序编程接口MOMessage Original消息上行MTMessage Terminal消息下行SPService Provider效劳提供商CPContent Provider内容提供商1.4 参考文献2. 短信1.5 接口1.5.

3、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=1.5.2 发送短信功能描述：短信发送调用格式：

4、对 进展post返回格式: result=&description=错误描述&faillist=失败号码列表post参数说明：类别参数名称类型说明输入SpCodestring企业编号输入LoginNamestring用户名称输入Passwordstring用户密码输入MessageContentstring短信内容, 最大700个字符输入UserNumberstring手机号码(多个号码用,分隔)，最多1000个号码输入SerialNumberstring流水号，20位数字，唯一 输入ScheduleTimestring预约发送时间，格式:yyyyMMddhhmmss,如201，立即发送请填空

5、输入fstring提交时检测方式1 - 提交号码中有效的号码仍正常发出短信，无效的号码在返回参数faillist中列出不为1 或该参数不存在 - 提交号码中只要有无效的号码，那么所有的号码都不发出短信，所有的号码在返回参数faillist中列出返回值：返回值错误描述0发送短信成功1提交参数不能为空2账号无效或未开户3账号密码错误,4预约发送时间无效5IP不合法,6号码中含有无效号码或不在规定的号段,7内容中含有非法关键字,8内容长度超过上限，最大402字符9承受号码过多，最大100010黑名单用户11提交速度太快12您尚未订购普通短信业务，暂不能发送该类信息13您的普通短信业务剩余数量发送缺乏

6、，暂不能发送该类信息14流水号格式不正确15流水号重复16超出发送上限操作员帐户当日发送上限17余额缺乏18扣费不成功20系统错误21您只能发送联通的手机号码，本次发送的手机号码中包含了非联通的手机号码22您只能发送移动的手机号码，本次发送的手机号码中包含了非移动的手机号码23您只能发送电信的手机号码，本次发送的手机号码中包含了非电信的手机号码24账户状态不正常25账户权限缺乏26需要人工审核28发送内容与模板不符GET：短信内容&UserNumber=XXXXXXXXXXX&SerialNumber=&ScheduleTime=&f=11.5.3 回执接口功能描述：短信回执调用方式：ftp返

7、回格式:文本文件ftp效劳信息：参数名称说明ftp地址U端口21返回文本文件格式:文件名: arrive_000139_25288_00000000f_2一行内容：SPID=197258 MESSAGEID=910320f1 ID=2432901361 CALLMDN=1501 MDN= RESULT=0 DESC=DELIVRD ARRIVE_TIME=202Java解析这行的方法/ 解析一行记录public static Properties parse(String line) String parsePattern=(=t+)=(t*);Matcher m = Pattern pile

8、(parsePattern).matcher(line);Properties result = new Properties();while (m.find() String key = m.group(1).trim();String value = m.group(2).trim();result.put(key.toUpperCase(), value);return result;如果要获取取承受短信的号码那么使用：String mdn= (String)result.get(MDN);即可其他字段类似方式1.5.4 剩余短信条数查询功能描述：剩余短信条数查询接口调用格式： 对进展p

9、ost返回格式: result=&description=错误描述&faillist=失败号码列表post参数说明：类别参数名称类型说明输入SpCodestring企业编号输入LoginNamestring用户名称输入Passwordstring用户密码返回值:返回值错误描述0发送短信成功1提交参数不能为空2账号无效,3账号密码错误,5IP不合法,20系统错误1.5.5 上行回复内容查询接口功能描述：短信上行回复查询调用格式：对 进展postpost参数说明：类别参数名称类型说明输入SpCodestring企业编号输入LoginNamestring用户名称输入Passwordstring用户密

10、码返回值错误描述0成功1提交参数不能为空2账号无效,3账号密码错误,20系统错误reply的属性值类别参数名称类型说明输出mdnstring手机号码输出callmdn接入号输出contentstring回复内容输出reply_timestring回复时间，格式yyyy-MM-dd HH:mm:ss输出idstring回复id编号1.5.6 上行回复内容确认接口功能描述：短信上行回复查询调用格式：对 进展postpost参数说明：类别参数名称类型说明输入SpCodestring企业编号输入LoginNamestring用户名称输入Passwordstring用户密码输入idstring上次查询返

11、回的最后一条回复的id号返回值错误描述0成功1提交参数不能为空2账号无效,3账号密码错误,20系统错误1.6 Webservice接口1.6.1 消息协议接口地址：sms_hb/services/Smswsdl1.6.2 发送短信功能描述：短信发送调用格式： 利用webservice客户端进展 请求返回格式: SmsResponseSmsRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码输入In3string短信内容, 最大402个字符输入In4string手机号码(多个号码用,分隔)，最多1000个号码输

12、入In5string流水号，20位数字，唯一 输入In6string预约发送时间，格式:yyyyMMddhhmmss,如201， 立即发送请填空输入In7string提交时检测方式1 - 提交号码中有效的号码仍正常发出短信，无效的号码在返回参数faillist中列出不为1 或该参数不存在 - 提交号码中只要有无效的号码，那么所有的号码都不发出短信，所有的号码在返回参数faillist中列出输入In8string保存SmsResponse返回值:返回值错误描述0发送短信成功1提交参数不能为空2账号无效或未开户3账号密码错误,4预约发送时间无效5IP不合法,6号码中含有无效号码或不在规定的号段,7

13、内容中含有非法关键字,8内容长度超过上限，最大402字符9承受号码过多，最大100010黑名单用户11提交速度太快12您尚未订购普通短信业务，暂不能发送该类信息13您的普通短信业务剩余数量发送缺乏，暂不能发送该类信息14流水号格式不正确15流水号重复16超出发送上限17余额缺乏18扣费不成功20系统错误21您只能发送联通的手机号码，本次发送的手机号码中包含了非联通的手机号码22您只能发送移动的手机号码，本次发送的手机号码中包含了非移动的手机号码23您只能发送电信的手机号码，本次发送的手机号码中包含了非电信的手机号码24账户状态不正常25账户权限缺乏26需要人工审核28发送内容与模板不符实际返回

14、内容为“result=0&description=发送成功1.6.3 回执接口功能描述：短信回执调用方式：利用webservice客户端进展 请求返回格式: ReportResponseReportRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码ReportResponse返回值:类别参数名称类型说明输入outstring回执结果，每条回执按分号隔开，每个字段按逗号隔开，每条回执共包含3个字段，第1个字段为流水号，第2个字段为被发送的手机号码，第3个字段为回执结果，0表示成功，其他值表示失败实际返回内容为

15、“000000001,0; 000000001,0;000000001,0;1.6.4 上行回复内容查询接口功能描述：上行回复内容查询调用方式：利用webservice客户端进展 请求返回格式: ReplyResponseReplyRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码ReplyResponse返回值:类别参数名称类型说明输出resultstring返回码输出confirm_timestring回复时间，格式yyyy-MM-dd HH:mm:ss输出replysreply数组多个relpy对象组

16、成输出IdString最后一条回复信息的ID返回值错误描述0成功1提交参数不能为空2账号无效,3账号密码错误,20系统错误reply的属性值类别参数名称类型说明输出callMdnstring接入号输出mdnstring用户手机号输出messagestring回复内容输出reply_timestring回复时间，格式yyyy-MM-dd HH:mm:ss输出idstring回复id编号1.6.5 上行回复内容确认接口功能描述：上行回复内容查询调用方式：利用webservice客户端进展 请求返回格式: ReplyConfirmResponseReplyConfirmRequest请求参数说明：类

17、别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码输入In3string上行回复内容查询接口返回的时间，格式：yyyy-MM-dd HH:mm:ss输入In4string最后一条回复信息的idReplyConfirmResponse返回值:类别参数名称类型说明输出resultstring返回码返回值错误描述0成功1提交参数不能为空2账号无效,3账号密码错误,4时间格式不正确,格式为：yyyy-MM-dd HH:mm:ss20系统错误1.6.6 内容审核功能描述：短信发送调用格式： 利用webservice客户端进展 请求返回格式: AuditingResponseAuditingRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码输入In3string短信内容, 最大402个字符AuditingResponse返回值:返回值错误描述0短信内容审核通过1提交参数不能为空2账号无效,3账号密码错误,4内容中含有非法关键字，关键字按逗号隔开5需要人工审核20系统错误实际返回内容为“result=0&description=短信内容审核通过第 19 页