统一信息平台接口规范
统一信息平台WCF接口规范接口规范统一信息平台WCFV1.0目录1概述12接受数据方式12.1WCF服务12.1.1A地址:12.1.2B绑定:12.1.3C契约:12.2WCF提供服务32.2.1IP屏蔽32.2.2单条RTX信息接收:SetRTXInfo32.2.3单条短信信息接收:SetSMSInfo42.2.4单条Email信息接收:SetEmailInfo52.2.5单条彩信信息接收:SetMMSInfo62.2.6RTX提示信息接收:SetRTXNotify72.2.7单条信息接收参数及返回值小结92.2.8多条RTX信息接收:SetRTXJSON102.2.9多条短信信息接收:SetSMSJSON112.2.10多条Email信息接收:SetEmailJSON122.2.11单条RTX信息接收:string PushToApp(string fromSys, string target, string msTitle, string msContent, string targetTime, string url, string payload, string priority);122.3错误日志记录133ASP.NET 客户端调用143.1客户端引用WCF服务143.2客户端使用WCF服务163.3多条大数据量发送174JAVA 客户端调用174.1JAVA客户端引用WCF服务17大连万达商业地产股份有限公司1 概述本接口规范主要描述统一信息平台通过.net WCF接收各系统,所要发送的RTX、手机短信、电子邮件信息。2 接受数据方式2.1 WCF服务WCF是Microsoft为构建面向服务的应用提供的分布式通信编程框架,是新的.NET Framework 的重要组成部分。使用该框架,开发人员可以构建跨平台、安全、可靠和支持事务处理的企业级互联应用解决方案。2.1.1 A地址:测试地址:ReceiveServer.svc。或者 正式地址:请在测试环境不要配置此地址。2.1.2 B绑定: 绑定协议 baseicHTTPBinding。2.1.3 C契约:wanda.MSGPlatform.WCFService.IReceiveServe。 / 单条RTX信息接收 OperationContract string SetRTXInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority); / 单条短信信息接收 OperationContract string SetSMSInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority); /单条Email信息接收 OperationContract string SetEmailInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority); /彩信接收 OperationContract string SetMMSInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority); /RTX提醒接收 OperationContract string SetRTXNotify(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority); /批量RTX信息接收 OperationContract string SetRTXJSON(string infoJson); /批量短信信息接收 OperationContract string SetSMSJSON(string infoJson); /批量Email信息接收 OperationContract string SetEmailJSON(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 参数: string fromSys:*信息来源系统代码(该代码由统一信息平台注册系统信息时生成) string target:*信息目标接收人的RTXNO string msTitle:发送信息的标题,标题可为 string msContent:*发送内容 string targetTime:目标发送时间,可以为,如果为,则默认为立即发送 格式yyyy-MM-dd HH:mm:ss string priority:发送优先级,可以为,如果为,则默认为1 返回值:信息接收成功:OK 信息接收失败: 格式 false:错误信息 false:IP地址:*已被统一信息平台系统排除,请与管理员联系! 注:*代表访问的IP地址(请参考2.2.1IP屏蔽) false:系统已经停止使用!-传入是参数fromSys(来源系统)在统一信息平台中已 经标志为停用状态false:尚未设置可访问系统的IP! -传入是参数fromSys(来源系统),在统一信息平台系统中尚未为来源系统(fromSys)配置可访问的IP地址false:IP地址不在系统许可访问范围内!-统一信息平台系统已经为来源系统(fromSys)配置了可访问的IP地址,但来源系统的访问IP,不在已经配置的范围内 false:数据库保存时出错! false:来源系统不能为空!-传入是参数fromSys为空 false:无法确认来源系统!-在系统信息表中找不到fromSys相应的代码,即系统尚未注册到统一信息管理平台中 false:目标接受者不能为空!-传入参数target不能为空 false:无法确认目标接受者!-传入参数target在人员信息表中找不到相应信息 false:发送内容不能为空!-传入参数msContent不能为空 false:RTX内容长度不能超过512个字!-传入参数msContent内容不能超过512个字 false:RTX服务配置尚未完成,请联系RTX信息管理人员!-传入是参数fromSys相应的系统还没有配置RTX服务信息2.2.3 单条短信信息接收:SetSMSInfo 参数: string fromSys:*信息来源系统代码(该代码由统一信息平台注册系统信息时生成) string target:*信息目标接收人的RTXNO或者接受人手机号 string msTitle:发送信息的标题,标题可为 string msContent:*发送内容,信息内容不能超过500个字 string targetTime:目标发送时间,可以为,如果为,则默认为立即发送 格式yyyy-MM-dd HH:mm:ss string priority:发送优先级,可以为,如果为,则默认为1 返回值:信息接收成功:OK 信息接收失败: 格式 false:错误信息 false:IP地址:*已被统一信息平台系统排除,请与管理员联系! 注:*代表访问的IP地址(请参考2.2.1IP屏蔽) false:系统已经停止使用!-传入是参数fromSys(来源系统)在统一信息平台中已 经标志为停用状态false:尚未设置可访问系统的IP! -传入是参数fromSys(来源系统),在统一信息平台系统中尚未为来源系统(fromSys)配置可访问的IP地址false:IP地址不在系统许可访问范围内!-统一信息平台系统已经为来源系统(fromSys)配置了可访问的IP地址,但来源系统的访问IP,不在已经配置的范围内 false:数据库保存时出错! false:来源系统不能为空!-传入是参数fromSys为空 false:无法确认来源系统!-在系统信息表中找不到fromSys相应的代码,即系统尚未注册到统一信息管理平台中 false:目标接受者不能为空!-传入参数target不能为空 false:无法确认目标接受者!-传入参数target在人员信息表中找不到相应信息或者不是合法的手机号码 false:发送内容不能为空!-传入参数msContent不能为空 false:短信长度不能超过494个字!-传入参数msContent内容不能超过494个字 false:短信服务配置尚未完成,请联系短信信息管理人员!-传入是参数 fromSys相应的系统还没有配置短信服务信息2.2.4 单条Email信息接收:SetEmailInfo 参数: string fromSys
收藏
- 资源描述:
-
统一信息平台WCF接口规范
接口规范
统一信息平台WCF
V1.0
目录
1 概述 1
2 接受数据方式 1
2.1 WCF服务 1
2.1.1 A地址: 1
2.1.2 B绑定: 1
2.1.3 C契约: 1
2.2 WCF提供服务 3
2.2.1 IP屏蔽 3
2.2.2 单条RTX信息接收:SetRTXInfo 3
2.2.3 单条短信信息接收:SetSMSInfo 4
2.2.4 单条Email信息接收:SetEmailInfo 5
2.2.5 单条彩信信息接收:SetMMSInfo 6
2.2.6 RTX提示信息接收:SetRTXNotify 7
2.2.7 单条信息接收参数及返回值小结 9
2.2.8 多条RTX信息接收:SetRTXJSON 10
2.2.9 多条短信信息接收:SetSMSJSON 11
2.2.10 多条Email信息接收:SetEmailJSON 12
2.2.11 单条RTX信息接收:string PushToApp(string fromSys, string target, string msTitle, string msContent, string targetTime, string url, string payload, string priority); 12
2.3 错误日志记录 13
3 ASP.NET 客户端调用 14
3.1 客户端引用WCF服务 14
3.2 客户端使用WCF服务 16
3.3 多条大数据量发送 17
4 JAVA 客户端调用 17
4.1 JAVA客户端引用WCF服务 17
大连万达商业地产股份有限公司
1 概述
本接口规范主要描述统一信息平台通过.net WCF接收各系统,所要发送的RTX、手机短信、电子邮件信息。
2 接受数据方式
2.1 WCF服务
WCF是Microsoft为构建面向服务的应用提供的分布式通信编程框架,是新的.NET Framework 的重要组成部分。使用该框架,开发人员可以构建跨平台、安全、可靠和支持事务处理的企业级互联应用解决方案。
2.1.1 A地址:
测试地址:ReceiveServer.svc。
或者 正式地址:请在测试环境不要配置此地址。
2.1.2 B绑定:
绑定协议 baseicHTTPBinding。
2.1.3 C契约:
wanda.MSGPlatform.WCFService.IReceiveServe。
// 单条RTX信息接收
[OperationContract]
string SetRTXInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority);
// 单条短信信息接收
[OperationContract]
string SetSMSInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority);
//单条Email信息接收
[OperationContract]
string SetEmailInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority);
//彩信接收
[OperationContract]
string SetMMSInfo(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority);
//RTX提醒接收
[OperationContract]
string SetRTXNotify(string fromSys, string target, string msTitle, string msContent, string targetTime, string priority);
//批量RTX信息接收
[OperationContract]
string SetRTXJSON(string infoJson);
//批量短信信息接收
[OperationContract]
string SetSMSJSON(string infoJson);
//批量Email信息接收
[OperationContract]
string SetEmailJSON(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
参数:
string fromSys:*信息来源系统代码(该代码由统一信息平台注册系统信息时生成)
string target:*信息目标接收人的RTXNO
string msTitle:发送信息的标题,标题可为""
string msContent:*发送内容
string targetTime:目标发送时间,可以为"",如果为"",则默认为立即发送
格式"yyyy-MM-dd HH:mm:ss"
string priority:发送优先级,可以为"",如果为"",则默认为1
返回值:信息接收成功:OK
信息接收失败:
格式 [false]:[错误信息]
false:IP地址:***已被统一信息平台系统排除,请与管理员联系!
注:***代表访问的IP地址(请参考2.2.1IP屏蔽)
false:系统已经停止使用!--传入是参数fromSys(来源系统)在统一信息平台中已 经标志为停用状态
false:尚未设置可访问系统的IP! --传入是参数fromSys(来源系统),在统一信息平台系统中尚未为来源系统(fromSys)配置可访问的IP地址
false:IP地址不在系统许可访问范围内!--统一信息平台系统已经为来源系统(fromSys)配置了可访问的IP地址,但来源系统的访问IP,不在已经配置的范围内
false:数据库保存时出错!
false:来源系统不能为空!--传入是参数fromSys为空
false:无法确认来源系统!--在系统信息表中找不到fromSys相应的代码,即系统尚未注册到统一信息管理平台中
false:目标接受者不能为空!--传入参数target不能为空
false:无法确认目标接受者!--传入参数target在人员信息表中找不到相应信息
false:发送内容不能为空!--传入参数msContent不能为空
false:RTX内容长度不能超过512个字!--传入参数msContent内容不能超过512个字
false:RTX服务配置尚未完成,请联系RTX信息管理人员!--传入是参数fromSys相应的系统还没有配置RTX服务信息
2.2.3 单条短信信息接收:SetSMSInfo
参数:
string fromSys:*信息来源系统代码(该代码由统一信息平台注册系统信息时生成)
string target:*信息目标接收人的RTXNO或者接受人手机号
string msTitle:发送信息的标题,标题可为""
string msContent:*发送内容,信息内容不能超过500个字
string targetTime:目标发送时间,可以为"",如果为"",则默认为立即发送
格式"yyyy-MM-dd HH:mm:ss"
string priority:发送优先级,可以为"",如果为"",则默认为1
返回值:信息接收成功:OK
信息接收失败:
格式 [false]:[错误信息]
false:IP地址:***已被统一信息平台系统排除,请与管理员联系!
注:***代表访问的IP地址(请参考2.2.1IP屏蔽)
false:系统已经停止使用!--传入是参数fromSys(来源系统)在统一信息平台中已 经标志为停用状态
false:尚未设置可访问系统的IP! --传入是参数fromSys(来源系统),在统一信息平台系统中尚未为来源系统(fromSys)配置可访问的IP地址
false:IP地址不在系统许可访问范围内!--统一信息平台系统已经为来源系统(fromSys)配置了可访问的IP地址,但来源系统的访问IP,不在已经配置的范围内
false:数据库保存时出错!
false:来源系统不能为空!--传入是参数fromSys为空
false:无法确认来源系统!--在系统信息表中找不到fromSys相应的代码,即系统尚未注册到统一信息管理平台中
false:目标接受者不能为空!--传入参数target不能为空
false:无法确认目标接受者!--传入参数target在人员信息表中找不到相应信息或者不是合法的手机号码
false:发送内容不能为空!--传入参数msContent不能为空
false:短信长度不能超过494个字!--传入参数msContent内容不能超过494个字
false:短信服务配置尚未完成,请联系短信信息管理人员!--传入是参数 fromSys相应的系统还没有配置短信服务信息
2.2.4 单条Email信息接收:SetEmailInfo
参数:
string fromSys
展开阅读全文