一信通短信接口文档

1、一信通企业信息服务平台接口手册产品名称一信通企业信息服务平台接口手册版本编号2.1.2文档编号发布者发布日期2012-5-10目录一信通企业信息服务平台11.概述31.1编制目的31.2内容概述31.3名称解释31.4参考文献32.短信42.1http接口4消息协议4发送短信4回执接口5剩余短信条数查询6回复内容接口72.2Webservice接口7消息协议7发送短信8回执接口9上行回复内容查询接口10上行回复内容确认接口10内容审核11修改历史日期版本作者修改内容评审号更改请求号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. 短信

3、22.1 http接口2.1.1 消息协议接口地址： :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&am

4、p;description=发送成功&faillist=”2.1.2 发送短信功能描述：短信发送调用格式： 对 :8899/sms/Api/Send.do进行post返回格式: result=&description=错误描述&faillist=失败号码列表post参数说明：类别参数名称类型说明输入SpCodestring企业编号输入LoginNamestring用户名称输入Passwordstring用户密码输入MessageContentstring短信内容, 最大700个字符输入UserNumberstring手机号码(多个号码用”,”分隔)，最多1000个号码输

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

6、容中含有非法关键字、审核不通过、人工审核等8内容长度超过上限，最大402字符9接受号码过多，最大100010黑名单用户11提交速度太快12您尚未订购普通短信业务，暂不能发送该类信息13您的普通短信业务剩余数量发送不足，暂不能发送该类信息14流水号格式不正确15流水号重复16超出发送上限17余额不足18扣费不成功20系统错误21您只能发送联通的手机号码，本次发送的手机号码中包含了非联通的手机号码22您只能发送移动的手机号码，本次发送的手机号码中包含了非移动的手机号码23您只能发送电信的手机号码，本次发送的手机号码中包含了非电信的手机号码实际返回内容为“result=0&descripti

7、on=发送成功”2.1.3 回执接口功能描述：短信回执调用方式：ftp返回格式:文本文件ftp服务信息：参数名称说明ftp地址端口21返回文本文件格式:文件名: arrive_000139_25288_0000000000000000000f_201107071556一行内容：SPID=197258 MESSAGEID=910320f1 ID=2432901361 DESC=DELIVRD Java解析这行的方法/ 解析一行记录public static Properties parse(String line) String parsePattern="(=t+)=(t*)&quo

8、t;Matcher m = Ppile(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");即可其他字段类似方式2.1.4 剩余短

9、信条数查询功能描述：剩余短信条数查询接口调用格式： 对:8899/sms/Api/SearchNumber.do进行post返回格式: result=&description=错误描述&faillist=失败号码列表post参数说明：类别参数名称类型说明输入SpCodestring企业编号输入LoginNamestring用户名称输入Passwordstring用户密码返回值:返回值错误描述0发送短信成功1提交参数不能为空2账号无效,3账号密码错误,5IP不合法,20系统错误2.1.5 回复内容接口功能描述：将上行回复的内容通过http协议进行post到企业方调用格式： url

10、由企业方提供，然后对该url进行post,post的格式为xml,格式如下： <packet><reply><msg>回复内容测试</msg><replytime>2012-01-01 00:00:00</replytime></reply></packet>返回格式: 返回格式为xml,格式如下：<returncode>0</returncode>post参数说明：类别参数名称类型说明输入mdnstring手机号码输入callmdn接入号输入msgstring回复内容输入r

11、eplytimestring回复时间返回值:返回值错误描述0接收成功2.2 Webservice接口2.2.1 消息协议接口地址：:8899/sms_hb/services/Sms?wsdl2.2.2 发送短信功能描述：短信发送调用格式： 利用webservice客户端进行http请求返回格式: SmsResponseSmsRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码输入In3string短信内容, 最大402个字符输入In4string手机号码(多个号码用”,”分隔)，最多1000个号码输入In5s

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

13、号段,7内容中含有非法关键字、审核不通过、人工审核等8内容长度超过上限，最大402字符9接受号码过多，最大100010黑名单用户11提交速度太快12您尚未订购普通短信业务，暂不能发送该类信息13您的普通短信业务剩余数量发送不足，暂不能发送该类信息14流水号格式不正确15流水号重复16超出发送上限17余额不足18扣费不成功20系统错误21您只能发送联通的手机号码，本次发送的手机号码中包含了非联通的手机号码22您只能发送移动的手机号码，本次发送的手机号码中包含了非移动的手机号码23您只能发送电信的手机号码，本次发送的手机号码中包含了非电信的手机号码实际返回内容为“result=0&desc

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

15、复内容查询接口功能描述：上行回复内容查询调用方式：利用webservice客户端进行http请求返回格式: ReplyResponseReplyRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码ReplyResponse返回值: 类别参数名称类型说明输出resultstring返回码输出confirm_timestring回复时间，格式yyyy-MM-dd HH:mm:ss输出replysreply数组多个relpy对象组成返回值错误描述0成功1提交参数不能为空2账号无效,3账号密码错误,20系统错误rep

16、ly的属性值类别参数名称类型说明输出callMdnstring接入号输出mdnstring用户手机号输出messagestring回复内容输出reply_timestring回复时间，格式yyyy-MM-dd HH:mm:ss2.2.5 上行回复内容确认接口功能描述：上行回复内容查询调用方式：利用webservice客户端进行http请求返回格式: ReplyConfirmResponseReplyConfirmRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码输入In3string上行回复内容查询接口返回的时间，格式：yyyy-MM-dd HH:mm:ssReplyConfirmResponse返回值: 类别参数名称类型说明输出resultstring返回码返回值错误描述0成功1提交参数不能为空2账号无效,3账号密码错误,4时间格式不正确,格式为：yyyy-MM-dd HH:mm:ss20系统错误2.2.6 内容审核功能描述：短信发送调用格式： 利用webservice客户端进行htt