《统一信息平台接口规范.docx》由会员分享,可在线阅读,更多相关《统一信息平台接口规范.docx(22页珍藏版)》请在第一文库网上搜索。
1、接口规范统一信息平台WCFV1.0目录1 概述12 接受雌方式12.1 WCF 服务12.1.1 A 地址:12.1.2 B 绑定: 12.1.3 C 契约: 12.2 WCF塘共服务32.2.1 IP 屏蔽32.2.2 单条 RTX 信息接收:SetRTXInfo32.2.3 单条短信信息接收:SetSMSInfo42.2.4 单条 Email 信息接收:SetEmaiIInfo52.2.5 单条彩信信息接收:SetMMSInfo62.2.6 RTX 提示信息接收:SetRTXNotify72.2.7 单条信息接收参数及返回值小结92.2.8 多条 RTX 信息接收:SetRTXJSON10
2、2.2.9 多条短信信息接收:SetSMSJSON112.2.10 多条 Email 信息接收:SetEmaiIJSON112.2.11 单条 RTX 信息接收:string PushToApp(string fromSys, string target, string msTitle, string msContent, string targetTime, string url, string pay load, string priority) ;112.3 镯吴日志记录133 ASP.NET客户端调用133.1 客户端引用WCF服务133.2 客户端使用WCF服务153.3 多条大数据
3、量发送164 JAVA客户端调用174.1 JAVA客户端引用WCF服务171 概述本接口规范主要描述统一信息平台通过net WCF接收各系统,所要发送的RTXx 手机短信、电子邮件信息。2 接受数据方式2.1 WCF服务WCF是MicroSOft为构建面向服务的应用提供的分布式通信编程框架,是新的.NET Framework的重要组成部分。使用该框架,开发人员可以构建跨平台、安全、可靠和 支持事务处理的企业级互联应用解决方案。2.1.1 A 地址:测试地址:ReCeiVeSerVer.svc或者正式地址:请在测试环境不要配置此地址。2.1.2 B 绑定:绑定协议 baseicHTTPBind
4、ingo2.1.3 C 契约:wanda. MSGPlatform. WCFService. IReceiveServee/单条RTX信息接收Operati onContractstring SetRTXInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority);/单条短信信息接收OperationContractstring SetSMSInfo(string fromSys, string target, string msTitle, s
5、tring msContent, string targetTime, string priority);单条EmaiI信息接收OperationContractstring SetEmaiIInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority);彩信接收OperationContractstring SetMMSInfo(string fromSys, string target, string msTitle, string msCon
6、tent, string targetTime, string priority); RTX提醒接收OperationContractstring SetRTXNotify(string fromSys, string target, string msTitle, string msContent, string targetTimel string priority);批量RTX信息接收OpcrationContractstring SetRTXJSONCstring infojson);/批量短信信息接收OperationContractstring SetSMSJSON(string
7、infojson);批量Email信息接收OperationContractstring SetEmaiIJSON(string infojson);2.2 WCF提供服务注*为必输项2.2.1 IP 屏蔽WCF服务会根据请求系统为正式或测试环境,排除相应的IP地址;排除后 的IP不能访问服务。测试环境屏蔽:10. 199. 80. *, 10.199. 81. *, 10.199. 82. *, 10. 199. 83. *, 10. 199. 84. *正式环境屏蔽:10. 199. 200. *, 10. 199. 201. *2.2.2 单条 RTX 信息接收:SetRTXInfo参数
8、:string fromSys: *信息来源系统代码(该代码由统一信息平台注册系统信息时生成)string target: *信息目标接收人的RTXNostring msTitle:发送信息的标题,标题可为string msContent: *发送内容string targetTime:目标发送时间,可以为如果为则默认为立即发送格式yyyy-MM-dd HH:mm:ss”string priority:发送优先级,可以为如果为,则默认为1返回值:信息接收成功:OK信息接收失败:格式错误信息false:IP地址:*已被统一信息平台系统排除,请与管理员联系!注:*代表访问的IP地址(请参考2. 2
9、. IIP屏蔽)false:系统已经停止使用!一传入是参数fromSys(来源系统)在统一信息平台中已 经标志为停用状态false:尚未设置可访问系统的IP! 一传入是参数fromSys(来源系统),在统一信 息平台系统中尚未为来源系统(fromSys)配置可访问的【P地址false: IP地址不在系统许可访问范围内!一统一信息平台系统已经为来源系统 (fromSys)配置了可访问的IP地址,但来源系统的访问IP,不在已经配置的范围 内false:数据库保存时出错!false:来源系统不能为空!一传入是参数fromSys为空false:无法确认来源系统!一在系统信息表中找不到fromSys相应
10、的代码,即系统 尚未注册到统一信息管理平台中false:目标接受者不能为空!一传入参数target不能为空false:无法确认目标接受者!一传入参数target在人员信息表中找不到相应信息false:发送内容不能为空!传入参数InSCOntent不能为空false:RTX内容长度不能超过512个字!一传入参数msContent内容不能超过 512个字false:RTX服务配置尚未完成,请联系RTX信息管理人员!一传入是参数fromSys相 应的系统还没有配置RTX服务信息2.2.3 单条短信信息接收:SetSMSInfo参数:string fromSys: *信息来源系统代码(该代码由统一信息
11、平台注册系统信息时生成)string target: *信息目标接收人的RTXNO或者接受人手机号string msTitle:发送信息的标题,标题可为string msContent: *发送内容,信息内容不能超过500个字string targetTime:目标发送时间,可以为如果为则默认为立即发送格式yyyy-MM-dd HH:mm:ss*string priority:发送优先级,可以为,如果为“,则默认为】返回值:信息接收成功:OK信息接收失败:格式falseJ错误信息false:IP地址:*已被统一信息平台系统排除,请与管理员联系!注:*代表访问的IP地址(请参考2. 2. UP屏
12、蔽)false:系统已经停止使用! 一传入是参数fromSys(来源系统)在统一信息平台中已 经标志为停用状态false:尚未设置可访问系统的IP! 一传入是参数fromSys(来源系统),在统信 息平台系统中尚未为来源系统(fromSys)配置可访问的IP地址false: IP地址不在系统许可访问范围内!一统一信息平台系统己经为来源系统 (fromSys)配置了可访问的IP地址,但来源系统的访问IP,不在已经配置的范围内false:数据库保存时出错!false:来源系统不能为空! -传入是参数fromSys为空false:无法确认来源系统!一在系统信息表中找不到fromSys相应的代码,即系
13、统 尚未注册到统一信息管理平台中false:目标接受者不能为空!一传入参数target不能为空false:无法确认目标接受者!传入参数target在人员信息表中找不到相应信息或 者不是合法的手机号码false:发送内容不能为空!一传入参数msContent不能为空false:短信长度不能超过494个字!一传入参数msContent内容不能超过494个字false:短信服务配置尚未完成,请联系短信信息管理人员!一传入是参数fromSys 相应的系统还没有配置短信服务信息2.2.4 单条 Email 信息接收:SetEmailInfo参数:string fromSys: *信息来源系统代码(该代码
14、由统一信息平台注册系统信息时生成)string target: *信息目标接收人的RTXNO或者接收人EmaiI地址string msTitle: *发送信息的标题,标题不能为string msContent: *发送内容string targetTime:目标发送时间,可以为,如果为则默认为立即发送格式yyyy-MM-dd HH:mm:ss*string priority:发送优先级,可以为,如果为“,则默认为】返回值:信息接收成功:OK信息接收失败:格式falseM错误信息false:IP地址:*已被统一信息平台系统排除,请与管理员联系!false:系统已经停止使用!一传入是参数fromS
15、ys (来源系统)在统一信息平台中已 经标志为停用状态false:尚未设置可访问系统的IP! 传入是参数fromSys(来源系统),在统一信 息平台系统中尚未为来源系统(fromSys)配置可访问的IP地址false: IP地址不在系统许可访问范围内!一统一信息平台系统已经为来源系统 (fromSys)配置了可访问的IP地址,但来源系统的访问IP,不在已经配置的范围内false:数据库保存时出错!false:来源系统不能为空!-传入是参数fromSys为空false:无法确认来源系统!一在系统信息表中找不到fromSys相应的代码,即系统 尚未注册到统一信息管理平台中false:目标接受者不能为空!一传入参数target不能为空false:无法确认目标接受者!一传入参数target在人员信息表中找不到相应信息或 者不是合法的电子邮箱地址false:发送标题不能为空!一传入参数msTi tie不能为空false:发送内容不能为空! -传入参数ms