一信通短信接口文档(共11页)

1、上海帜讯信息技术有限公司Page 2012.02一信通企业(qy)信息服务平台接口(ji ku)手册产品名称一信通企业信息服务平台接口手册版本编号2.1.2文档编号发布者发布日期2012-5-10目录(ml) TOC o 1-3 h z u HYPERLINK l _Toc330475311 一信通企业(qy)信息服务平台 PAGEREF _Toc330475311 h 1 HYPERLINK l _Toc330475312 1.概述(i sh) PAGEREF _Toc330475312 h 3 HYPERLINK l _Toc330475313 1.1编制目的 PAGEREF _Toc33

2、0475313 h 3 HYPERLINK l _Toc330475314 1.2内容概述 PAGEREF _Toc330475314 h 3 HYPERLINK l _Toc330475315 1.3名称解释 PAGEREF _Toc330475315 h 3 HYPERLINK l _Toc330475316 1.4参考文献 PAGEREF _Toc330475316 h 3 HYPERLINK l _Toc330475317 2.短信 PAGEREF _Toc330475317 h 4 HYPERLINK l _Toc330475319 2.1http接口 PAGEREF _Toc330

3、475319 h 4 HYPERLINK l _Toc330475320 2.1.1消息协议 PAGEREF _Toc330475320 h 4 HYPERLINK l _Toc330475321 2.1.2发送短信 PAGEREF _Toc330475321 h 4 HYPERLINK l _Toc330475322 2.1.3回执接口 PAGEREF _Toc330475322 h 5 HYPERLINK l _Toc330475323 2.1.4剩余短信条数查询 PAGEREF _Toc330475323 h 6 HYPERLINK l _Toc330475324 2.1.5回复内容接口

4、 PAGEREF _Toc330475324 h 7 HYPERLINK l _Toc330475325 2.2Webservice接口 PAGEREF _Toc330475325 h 7 HYPERLINK l _Toc330475326 2.2.1消息协议 PAGEREF _Toc330475326 h 7 HYPERLINK l _Toc330475327 2.2.2发送短信 PAGEREF _Toc330475327 h 8 HYPERLINK l _Toc330475328 2.2.3回执接口 PAGEREF _Toc330475328 h 9 HYPERLINK l _Toc330

5、475329 2.2.4上行回复内容查询接口 PAGEREF _Toc330475329 h 10 HYPERLINK l _Toc330475330 2.2.5上行回复内容确认接口 PAGEREF _Toc330475330 h 10 HYPERLINK l _Toc330475331 2.2.6内容审核 PAGEREF _Toc330475331 h 11修改历史日期版本作者修改内容评审号更改请求号概述(i sh)编制(binzh)目的 该接口文档手册编写(binxi)在于描述易派企业信息服务平台UMS（以下简称UMS）具体的接口协议，供第三方系统能够顺利接入一信通短信网关。内容概述 本规

6、范主要讲了第三方系统接入短信通系统的协议要求，协议三大状态和协议指令的格式和响应信息。名称解释缩略语英文全名中文全名UMSUnified Message Service一信通SMSShort Messaging Service短消息服务APIApplication Proframming Interface应用程序编程接口MOMessage Original消息上行MTMessage Terminal消息下行SPService Provider服务提供商CPContent Provider内容提供商参考文献短信http接口(ji ku)消息(xio xi)协议接口(ji ku)地址： HYPE

7、RLINK :8899/sms/Api/ :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=发送成功&faillis

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

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

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

11、n)成功”回执(huzh)接口功能描述：短信回执调用方式：ftp返回格式:文本文件ftp服务信息：参数名称说明ftp地址端口21返回(fnhu)文本文件格式:文件名: arrive_000139_25288_0000000000000000000f_201107071556一行(yxng)内容：SPID=197258 MESSAGEID=910320f1 ID=2432901361 CALLMDN=106550270102501 MDNRESULT=0 DESC=DELIVRD ARRIVE_TIME=20110707155402Java解析(ji x)这行的方法/

12、解析一行记录public static Properties parse(String line) String parsePattern=(=t+)=(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;如果要获取

13、取接受短信的号码则使用：String mdn= (String)result.get(MDN);即可其他字段类似方式剩余短信条数查询功能描述：剩余短信条数查询接口调用格式： 对 HYPERLINK :8899/sms/Api/SearchNumber.do进行post :8899/sms/Api/SearchNumber.do进行post返回格式: result=&description=错误描述&faillist=失败号码列表post参数说明：类别参数名称类型说明输入SpCodestring企业编号输入LoginNamestring用户名称输入Passwordstring用户密码返回值:返回

14、值错误描述0发送短信成功1提交参数不能为空2账号无效,3账号密码错误,5IP不合法,20系统错误回复(huf)内容接口功能(gngnng)描述：将上行回复的内容通过(tnggu)http协议进行post到企业方调用格式： url由企业方提供，然后对该url进行post,post的格式为xml,格式如下： 1861633031810690067111111回复内容测试2012-01-01 00:00:00返回格式: 返回格式为xml,格式如下：0post参数说明：类别参数名称类型说明输入mdnstring手机号码输入callmdn接入号输入msgstring回复内容输入replytimestri

15、ng回复时间返回值:返回值错误描述0接收成功Webservice接口消息协议接口地址： HYPERLINK :8899/sms_hb/services/Sms?wsdl :8899/sms_hb/services/Sms?wsdl发送(f sn)短信功能(gngnng)描述：短信发送(f sn)调用格式： 利用webservice客户端进行http请求返回格式: SmsResponseSmsRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码输入In3string短信内容, 最大402个字符输入In4stri

16、ng手机号码(多个号码用”,”分隔)，最多1000个号码输入In5string流水号，20位数字，唯一 输入In6string预约发送时间，格式:yyyyMMddhhmmss,如20090901010101， 立即发送请填空输入In7string提交时检测方式1 提交号码中有效的号码仍正常发出短信，无效的号码在返回参数faillist中列出不为1 或该参数不存在 提交号码中只要有无效的号码，那么所有的号码都不发出短信，所有的号码在返回参数faillist中列出输入In8string保留SmsResponse返回值: 返回值错误描述0发送短信成功1提交参数不能为空2账号无效,3账号密码错误,4预

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

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

19、为回执结果，0表示成功，其他值表示失败实际返回内容为“000000000000000000010; 000000000000000000010;000000000000000000010;”上行回复内容查询接口功能描述：上行回复内容查询调用方式：利用webservice客户端进行http请求返回格式: ReplyResponseReplyRequest请求参数说明：类别参数名称类型说明输入In0string企业编号输入In1string用户名称输入In2string用户密码ReplyResponse返回值: 类别参数名称类型说明输出resultstring返回码输出confirm_timestring回复时间，格式yyyy-MM-dd HH:mm:ss输出replysreply数组多个relpy对象组成返回值错误描述0成功1提交参数不能为空2账号无效,3账号密码错误,20系统错误reply的属性(shxng)值类别参数名称类型说明输出callMdnstring接入号输出mdnstring用户手机号输出messagestring回复内容输出reply_timestring回复时间，格式yyyy-MM-dd HH:mm:ss上行回复