SZDWI接口协议.doc

DWI接口协议 DreamFax WebService Interface 目 录 协议背景 协议基础 通信流程 协议描述 服务接口WSDL描述 接口定义 (2).传送传真发送任务 .传送传真发送状态 说明 DWI接口协议 (DreamFax WebService Interface) 一、协议背景 DreamFax传真服务器在应用环境中需要和其他应用（如Call Center/CRM/ERP/OA等）通信，以便接收其他应用系统提交的传真任务和将接收的传真传送给其他应用系统。这部分通过WebService的通信接口叫DWI(DreamFax WebService Interface)。以下我们约定DreamFax 简称DF,其他应用简称APS。 二、协议基础 本协议基于WSDL，利用WebService进行通信。DF、APS位于同一局域网，他们之间的通信经过DWI转接。 在本接口中，APS端直接通过调用DWI向DF发送请求，DWI将直接返回需要的数据，并提供错误信息。 三、通信流程 1、流程描述 APS根据用户名/密码调用SignIn登陆DF,如果登陆成功，获取令牌TokenID,之后，将令牌TokenID作为参数调用接收传真，发送传真，获取传真状态的服务，操作完成，调用SignOut退出登陆 2、流程图 四、协议描述 接口定义 1）、SignIn 描述：用户登陆 参数说明： 传入参数 strUserName:登陆用户名 类型string strPassword:登陆密码 类型string 返回值： 用户令牌：TokenID 登陆成功 返回 “” 登陆失败 类型string 2）、Receive 描述：根据令牌接收指定个数大于指定时间的收件 参数说明： 传入参数 tokenId:用户令牌 类型 string intSize:一次接收传真的个数 类型 int strDateCreate:接受收件的起始日期 类型 string 格式 yy-MM-dd hh:mm:ss 返回值： 收件XML格式字符串 类型 xml string 格式 DsResultData FaxReceiveList Symbol唯一主键/Symbol FaxRecvID传真接收处理表id /FaxRecvID FaxType传真类型0 企业传真 1 部门传真 2 个人传真/FaxType ReceiverUID接收者用户Id /ReceiverUID Receiver接收者的用户名/Receiver FaxServerID传真服务器id /FaxServerID UserType接收者 用户类型0 企业 1 部门 2 个人/UserType ReceiverParentID接收人部门序号/ReceiverParentID ReceiverRootID接收人企业序号/ReceiverRootID FaxStatus传真状态 0 新传真1 已阅读2 已转发3 已回复4 已回复转发/FaxStatus Priority优先级 1 缓慢 2 普通 3紧急/Priority SenderType发送者类型 0传真机 1外部传真用户 2 内部传真用户/SenderType SenderUID传真发件人用户id /SenderUID Sender传真发件人名称 /Sender FaxNumber传真发件人传真机电话号码/FaxNumber CoverSubject传真封页主题/CoverSubject CoverMessage传真封页内容/CoverMessage ReceivePages传真页数/ReceivePages FaxDtmfDTMF/FaxDtmf FaxDIDDID/FaxDID FaxCallerIDCallerID/FaxCallerID FaxRemoteID传真标示/FaxRemoteID FaxSize传真大小/FaxSize FaxQuality传真质量/FaxQuality DateModify修改时间（yy-MM-dd hh:mm:ss）/DateModify DateCreate创建时间（yy-MM-dd hh:mm:ss）/DateCreate /FaxReceiveList FaxReceiveFileList Symbol接收文件唯一主键/Symbol ReceiveFaxListID收件外键/ReceiveFaxListID FaxFile