263EM企业OA推送消息接口规范.doc

263EM 企业企业 OA 推送消息接口规范推送消息接口规范 版本版本 1 0 文档编号 PDD11000103 001 版权所有 1998 2020 263 网络通信 公司网址 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 2020i 版权申明版权申明 本文档包含了来自 263 网络通信股份有限公司的机密技术和商业信息 这些信息作为 263 网络通信股份有限公司专用 接受本文档即视为表示同意对其内容保密 并且未经 263 网络通信股份有限公司书面许可 不得复制 泄露或散布本文档的全部或部分内容 本文档及其描述的内容及产品的著作权和版权受有关法律保护 对本文档内容的任何 形式的非法复制 泄露或散布 将导致承担相应的法律责任 263 网络通信股份有限公司保留在不另行通知的情况下修改本文档的权利 并保留对 本文档内容的全部解释权 263 网络通信 标识是 263 网络通信股份有限公司的注册商标 This document contains confidential technical and commercial information from Net263 Ltd and is intended for the use of Customers or Net263 s partners only for the purposes of related projects to Net263 No part of it may be reproduced or transmitted in any form or means without the written permission of Net263 This document and the product it describes are protected by copyright according to the applicable laws The information in this document is subject to change without notice and describes only the product defined in the introduction of this documentation Net263 will if necessary explain issues which may not be covered by the document Net263 logo is a registered trademark of Net263 Ltd 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 2020ii 修订历史修订历史 日期日期版本版本说明说明作者作者 2011 8 261 0创建文档薛炜 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 2020iii 目录目录 1 概述概述 1 1 1范围 1 2 定义定义 1 2 1术语 1 3 总体设计总体设计 1 3 1功能描述 1 3 2总体结构 2 4 流程设计流程设计 2 4 1文本消息推送流程 2 4 2链接消息推送流程 3 5 接口设计接口设计 4 5 1企业 OA 与 IMS 的接口 4 5 1 1接口描述 4 5 1 2接口定义 4 附录附录 A 参数及其说明参数及其说明 6 附录附录 B 错误代码定义错误代码定义 7 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 20201 1 概述概述 1 1 范围范围 本接口规范描述了企业企业 OA 系统系统与 263EM 系统系统之间的推送消息 webservice 接口 2 定义定义 2 1 术语术语 术语术语定义定义 263EM263 Enterprise Messenger 即时消息客户端 IMSInstant Messaging Server 即时消息服务器 3 总体设计总体设计 3 1 功能描述功能描述 企业 OA 系统按照本接口可以实现给本域用户本域用户推送消息到 263em 系统 并在 263em 客 户端显示 本接口可以支持推送以下两种类型的消息 文本消息和链接消息 文本消息文本消息 这种消息推送到 263em 客户端以后 客户端显示出来 不支持跳转 如下图 图 客户显示推送的文本消息 链接消息链接消息 这种消息推送到 263em 客户端以后 客户端显示出来 用户如果点击了链接 可以跳 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 20202 转到链接对应的企业 OA 系统 注 如果企业的 OA 系统实现了单点登录 那么这里 可以跳转到登陆成功以后的页面 统一认证接口的详细信息参考 263EM 企业应用统 一认证接口规范 如下图 图 客户显示推送的链接消息 3 2 总体结构总体结构 企企业业O OA A系系统统I IMMS S2 26 63 3e emm客客户户端端弹弹出出推推送送消消息息 推送消息 推送接口 页面跳转 仅链接消息支持 图 总体结构 4 流程设计流程设计 4 1 文本消息推送流程文本消息推送流程 企业 OA 系统推送文本消息的流程如下图 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 20203 263EM IMS 企业OA 2 1 图 推送文本消息流程 1 企业 OA 系统调用 webservice 接口 将消息发送给 IMS 2 IMS 将消息发送给 263em 客户端 3 263em 客户端收到后 弹出消息 4 2 链接消息推送流程链接消息推送流程 企业 OA 系统推送链接消息的流程如下图 263EM IMS 企业OA 2 1 3 图 推送链接消息流程 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 20204 1 企业 OA 系统调用 webservice 接口 将消息发送给 IMS 2 IMS 将消息发送给 263em 客户端 3 263em 客户端收到后 弹出消息 4 用户点击弹出消息的链接 263em 客户端打开浏览器跳转到企业的 OA 系统 5 接口设计接口设计 5 1 企业企业 OA 与与 IMS 的接口的接口 5 1 1接口描述接口描述 IMS 提供 soap 服务 企业应用按照接口定义发送 soap 请求 根据返回值确定认证是 否成功 0 成功 非零 失败 5 1 2接口定义接口定义 接口使用 soap 通信协议进行通信 以下 wsdl 文件可通过访问 8080 emos services PushService wsdl 获得 1 WSDL 描述文件描述文件 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 20205 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 20206 请使用以上 wsdl 参数生成客户端 然后将发送的数据填写完成后以 UTF 8 编码后递交给 webservice 服务器即可 附录附录 A 参数及其说明参数及其说明 字段名称字段名称属性属性说明说明 md5md5 认证信息 md5 在管理平台中输入或获取密码然后使 用 MD5 方式加密后的字符串 域名 domain 推送消息的域名 消息内容data消息内容 主题 title 显示消息的主题 发送人邮箱sender 消息发送人的邮箱 发送人姓名username发送人姓名 企业 OA 系 统名称 oaname企业 oa 的名称 离线支持offline知否支持保存离线 默认不保存离线 true 如果接收人不在线 消息存离线 false 如果接收人不在线 消息不存离线 OA 系统的链 接地址 oaurl点击消息后跳转对应的 OA 系统的链接地 址 收信人列表userlist消息收件人列表 每个邮箱以 分隔 注 本系统只支持给本域用户推送消息 所以收件人所在的域必须和 域名 字段 相同 消息类型msgType0 不可跳转消息 1 可跳转消息 默认 为不可跳转消息 部分字段在 263em 客户端对应的显示如下图 263EM 企业 OA 系统推送消息接口规范 263 网络通信 1998 20207 附录附录