EastFax电子传真软件二次开发接口使用说明说课讲解

1、Good is good, but better carries it.精益求精，善益求善。EastFax电子传真软件二次开发接口使用说明EastFax智能传真服务器二次开发接口说明之一目录TOCo1-3hzuHYPERLINKl_Toc204415109一、概述PAGEREF_Toc204415109h2HYPERLINKl_Toc204415110二、EastFax服务端发送接口说明PAGEREF_Toc204415110h2HYPERLINKl_Toc2044151112.1单个文件单个号码的发送方式PAGEREF_Toc204415111h2HYPERLINKl_Toc20441511

2、22.1.1实现原理：PAGEREF_Toc204415112h2HYPERLINKl_Toc2044151132.1.2单号码发送的文件命名规则PAGEREF_Toc204415113h3HYPERLINKl_Toc2044151142.2多个文件多个号码的群发方式PAGEREF_Toc204415114h4HYPERLINKl_Toc2044151152.2.1实现原理PAGEREF_Toc204415115h4HYPERLINKl_Toc2044151162.2.2多号码发送的文件命名规则PAGEREF_Toc204415116h5HYPERLINKl_Toc2044151172.3文件

3、目录的制定规则PAGEREF_Toc204415117h6HYPERLINKl_Toc204415118三、EastFax客户端发送接口说明PAGEREF_Toc204415118h6HYPERLINKl_Toc2044151193.1实现原理：PAGEREF_Toc204415119h7HYPERLINKl_Toc2044151203.2客户端配置文件内容：PAGEREF_Toc204415120h7HYPERLINKl_Toc2044151213.3配置文件使用说明：PAGEREF_Toc204415121h8HYPERLINKl_Toc204415122四、发送结果的处理PAGEREF_

4、Toc204415122h9HYPERLINKl_Toc204415123五、EastFax接收接口说明PAGEREF_Toc204415123h13HYPERLINKl_Toc204415124六、传真接收结果的处理PAGEREF_Toc204415124h14一、概述EastFax智能传真系统提供方便的二次开发接口，可与企业的其它业务系统（如ERP、CRM、OA、HR等）无缝集成，协同办公，提高工作效率。EastFax提供丰富的二次开发接口，本文所列接口方式为其中之一。本文所列二次开发接口分为两大类，分别是发送接口和接收接口。发送接口又分为服务端接口和客户端接口两种，两种发送接口实现原理各

5、不相同，所适合的用户需求也不相同。不论哪种发送接口方式，在传真发送完毕后，EastFax都提供结果反馈程序，可将与传真发送结果相关的所有信息反馈到用户自己的数据库中，方便用户自行查询传真的发送结果。如果使用的是客户端发送接口，传真的发送结果还可以在客户端中查询。下面分别对各接口进行详细说明。二、EastFax服务端发送接口说明使用EastFax服务端发送接口时无需安装EastFax客户端程序，EastFax服务端会带有EastFax外部打印机和结果回传器二个外挂程序，并随EastFax服务端同时运行。发送接口支持两种发送方式，分别是单个文件单个号码的发送方式和多个文件需要合并发送给多个号码的群

6、发发送方式。2.1单个文件单个号码的发送方式2.1.1实现原理第一步：其他系统（如ERP系统）将要发送的传真内容，生成单个文件，以协议好的命名规则命名，把文件统一放到指定的目录。第二步：外部打印机程序（EastFaxExtPrinter.exe）能够自动、即时地从指定的目录里得到需要发送传真的文件，且从文件名里得到相关的传真发送信息（例如对方单位名称、传真号码、传真属性等等），然后将此文件转换为传真格式并提交给EastFax智能传真服务器进行发送。第三步：结果回传程序（EastFaxResultExt.exe）可以将传真的发送结果写入数据库，以便企业查看和管理传真的收发情况。接口运行流程图如下

7、：外部打印机运行状态如下图：结果回传器运行状态如下图：2.1.2单号码发送的文件命名规则默认情况下，对于单个文件单个号码的文件发送，客户业务系统必须按以下规则生成待发送的传真文件，并存放在配置文件指定的目录中（目录的详细说明见后面的2.3节）：1、传真文件的命名规则：接收单位名称#接收方传真号码#传真件属性#传真流水号.txt例：上海复园电子科技有限公司#65111322#订货单#5155212.txt2、文件的格式可以是常见的如txt、doc、xls、pdf、html、mht等；3、如有其他需求，需要反馈回数据库的信息字段，可另行协商定制开发。2.2多个文件多个号码的群发方式2.2.1实现原

8、理第一步：其他系统（如ERP系统）将要发送的传真内容，生成多个文件，统一放到指定的目录下。每个文件的文件名前面部分相同，后面加上文件序号。第二步：第一步完成后，业务系统再生成一个与文件名同名且后缀为epi格式的配置文件（20080720.epi），与前面的传真内容文件一起存放在指定的目录下。配置文件中的内容说明见下一节。第三步：外部打印机程序（EastFaxExtPrinter.exe）能够自动、即时地从指定的目录里得到需要发送传真的文件，且从epi配置文件里得到相关的传真发送信息，然后将同名且带序号的所有文件转换为传真格式并提交给EastFax智能传真服务器进行发送。第四步：结果回传程序（E

9、astFaxResultExt.exe）可以将传真的发送结果写入数据库，以便企业查看和管理传真的收发情况。接口运行流程图如下：外部打印机运行状态如下图：结果回传器运行状态如下图：2.2.2多号码发送的文件命名规则对于多个文件多个号码的群发传真方式，客户业务系统必须按以下规则生成待发送的传真文件，并存放在配置文件指定的目录中（目录的详细说明见后面的2.3节）：（1）传真文件的命名规则每个文件的文件名前面部分相同，后面加上文件序号。例如同时生成3个需要发送的文件，则可以这样命名：20080720_1.pdf，20080720_2.pdf，20080720_3.pdf。（2）配置文件的说明配置文件名

10、必须与要发送的传真文件名匹配，如20080720.epi，其中各章节说明如下：GeneralAccount=001;提交打印任务的帐号，会同步到其客户端，如果不指定就取用缺省的ExtPrinter帐号Subject=TestforExtPrinter;传真的主题Comments=Comments;传真的注释FaxFlowAccounts=;传真签审流程，如002003008SerialNO=;传真序列号，用于同步到结果数据库Priority=1;传真优先级，0低，1普通，2高，该配置生效的前提需对于账户具有“重要传真优先发送”的权限；EmailResult=;发送者的邮箱，发送结果会发送到该邮

11、箱，如果提供的话ReceiverList=65654240(复园科技小张);55666857(复园科技小王);接收者传真号码，采用客户端输入传真号码文本框中的样式，多个号码以分号分隔开来ReceiverNumber_1=88889797;第二种接收者传真号码表示方式，多个接收者用_1,_2表示，如果填写的是内部账户名，则发送给内部该用户,也支持填写EastFax地址ReceiverName_1=姓名1ReceiverCompany_1=公司1ReceiverNumber_2=99998787ReceiverName_2=姓名2ReceiverCompany_2=公司2SendLine=-1；指

12、定线路发送(默认-1为自动选择)，0表示0通道，暨表示第一个线路功能不为“无”的线路，该配置生效的前提需对应帐号具有“指定线路发送”的权限；SendTime=20090101120000；指定时间发送，格式为YYYYMMDDhhmmss，如果不填或者填写的时间早于服务器当前时间表示即时发送EastFax=Yes;该字段非常重要，只有这样填写了，才被认为是一个合法的打印提交文件。且该字段应该最后填写，因为程序一旦检测到该值为Yes即开始转换文件。2.3文件目录的制定规则在使用EastFax传真服务器的服务端发送接口后，在服务器的安装目录下将会有一个名为EastFaxEP.ini的配置文件；打开该

13、配置文件，找到其中的“DirectorynameofsourcefileSrcDir=”部分，在“=”号后面填写一个文件夹的绝对路径。当然也可以是网络路径，但需要确保安装EastFax服务端的电脑有权限访问网络上的该文件夹。例如在已有的业务系统中生成要发送传真的文件时，如果你想把所有要发送传真的文件直接存放在传真服务器主机的D盘根目录下的sendfax文件夹中，则应填写的内容为“D：sendfax”；如果你想把生成的需要传真的文件放在局域网内IP地址为192.168.1.1的主机D盘下的sendfax目录中，该D盘为默认名称，则应填写的内容为“192.168.1.186本地磁盘(d)sendf

14、ax”，或者更简单的，将该主机的D盘通过共享映射为本机的其他盘如S盘，然后填写路径“S:sendfax”。SrcDir配置项可支持指定多个文件目录，不同的文件目录使用“|”符分隔，如需要对C盘根目录下的sendfax文件夹和D盘根目录下的sendfax下的文件进行发送，可设定“SrcDir=C:sendfax|D:sendfax”。其他部分可使用默认的内容无需更改，配置完成后保存即可。外部打印机程序将读取该配置文件信息，获取存放传真文件的路径和目录并从该目录中获取要发送传真的文件，转换格式后提交给服务端发送。三、EastFax客户端发送接口说明使用EastFax客户端发送接口时需要安装East

15、Fax客户端程序，可以实现每个用户在自己电脑的业务系统（如ERP、CRM）中直接发送传真，无须打开新建传真窗口和输入传真号码，传真内容直接提交给服务器发送，极大提高工作效率。EastFax客户端发送接口的流程图如下图：3.1实现原理第一步：在业务系统（如ERP、CRM）中增加“发送传真”的按钮，用户点击“发送传真”时，业务系统将当前发送时间、收件人传真号码、传真流水号、传真优先级等信息写入EastFax客户端的配置文件EastFaxC.ini中。第二步：业务系统调用“EastFax”虚拟打印机将当时要发送的内容，EastFax虚拟打印机自动转换当前要发送的内容为传真所需的TIFF格式文件并提交

16、给客户端。第三步：EastFax客户端程序会自动从EastFaxC.ini配置文件中读取发送信息并将文件提交给服务器进行发送。传真发送后，发送结果可以反馈到客户端，也可以在服务端直接把结果回传到业务系统的数据库中。3.2客户端配置文件内容在EastFax客户端安装目录下，客户端的配置文件为EastFaxC.ini。打开配置文件，可以看到如下章节和字段：ExternalPrintPrintTime=Receiver=Subject=Priority=1SerialNo=SuccessReceiverSmsInd=NoErrorSenderSmsInd=NoNewFaxDialog=Yes提示：由

17、于各台主机的EastFax客户端可能安装在不同路径，因此要获得该配置文件的路径，可通过注册表路径:HKEY_LOCAL_MACHINESOFTWAREForwaveEastFaxPrinterApps下的字符串值，获得当前主机EastFax客户端的安装路径即可。3.3配置文件使用说明当用户在业务系统点击“发达传真”时，业务系统首先修改EastFaxC.ini配置文件中的上述对应字段，然后调用“EastFax”虚拟打印机虚拟打印当前页面即可。对于上述字段的描述如下：PrintTime=当前的打印时间，格式为：年月日时分秒，如：20070128111308，表示打印时间为2007年1月28号11时

18、13分8秒；Receiver=收件人的传真号码，也即是所要发送的传真号码。可填写多个号码群发，每个号码之间用分号分割即可。也可以实现不同号码显示不同的接收者信息，填写格式为：Receiver=02155666857(Company1/Name1);65654240(Company2/Name2);55666860*801（Company3/Name3）;01087654321,801（Company4/Name4）；Subject=传真主题，可显示在对方收到文件的页眉或页脚上；Priority=传真优先级，分三个级别0、1、2，0最低，2最高，默认级别为1；SerialNo=传真流水号，可在业

19、务系统中生成该传真流水号并与传真对应；SuccessReceiverSmsInd=服务端发送成功之后是否需要给收件人发送短信通知对方接收传真，Yes表示需要，No表示不需要，默认为No；ErrorSenderSmsInd=服务端发送失败之后是否需要给发件人发送短信通知，Yes表示需要，No表示不需要，默认为No；NewFaxDialog=是否需要显示新建传真窗口，Yes表示需要，No表示不需要，默认为Yes；当上述字段被修改后，再通过“EastFax”虚拟打印机虚拟打印文件时，客户端程序将按照上述字段的内容自动发送传真，不再弹出新建传真的对话框。如果打印过程中发生失败，或者由于其它一些原因想取

20、消这次的信息自动填入功能，那只需要将PrintTime字段设置为空就可以了。PrintTime用于标识一次打印活动，不同的值表示不同的打印活动，在本次打印请求处理完成之后，程序会在相同的ExternalPrint章节添加一个TreatTime字段，其值就为PrintTime的值，如上例中：TreatTime=20070128111308，就表示这次的请求已经处理完成了，下次就不再次处理了。因此并不影响一般的其他普通文档（如Word,Excel等）通过打印的方式发送。对于下一次的打印，只需要设置新的PrintTime就可以了。四、发送结果的处理当通过接口方式将传真发送完成后，对于发送结果的查看有

21、两种方式：（一）如果使用的是客户端发送接口，则可以在客户端软件界面中查看发送结果。打开客户端界面，在“已发送的传真”中查看发送结果。如果采用的是服务端接口的群发方式并且为每个传真都添加了帐号，则该传真在发送完成后会自动同步到EastFax客户端软件中，也可以在客户端软件中查看传真。（二）在业务系统的数据库中查看。在服务端将传真发送完毕后会生成一个格式为efr的结果文件，记录有传真流水号、发送时间，发送结果、对方号码等等信息，并保存在服务端安装目录下的“FaxResult”文件夹中。EastFax提供相应的EastFaxResultExt结果回传程序用于读取该结果文件中的信息并将结果写入业务系统

22、的数据库中。该结果回传程序运行的规则如下：1、要实现上述的传真结果自动反馈到指定的数据库里，对应的数据库必须有按以下规则建立的表：（1）表名：FAXSTAT（2）字段名与配置文件的设置SEND_ACCOUNTVARCHAR发送者帐号SEND_BEGINVARCHAR发送时间RETRY_TIMENUMBER发送次数TOTAL_PAGENUMBER传真页数STATUSNUMBER传真结果ORD_NOVARCHAR传真流水号RECV_INDEXNUMBER接收者序号，每个流水号从1开始RECV_NUMBERVARCHAR对方传真号码RECV_NAMEVARCHAR对方姓名RECV_COMPANYVA

23、RCHAR对方公司名称SEND_CNTNUMBER同RETRY_TIMESENDED_PAGENUMBER已发送的页数各字段长度的大小可灵活设置，只要保证足够容纳回传的信息即可，可尽量设置长一些。在服务器的安装目录下面，有一个结果回传器的配置文件，名为“EastFaxRE.ini”。双击打开该配置文件，可以看到里面包含与数据库连接的相关信息如下：DatabaseUserName=PassWord=；一旦定义SNoMaxLength字段，则结果回传时对流水号超出该字段值的结果提醒用户流水号过长，回传失败。默认为50SNoMaxLength=;Validvaluecanbe3,0,2,1,plea

24、setryRecordsetType=3在UserName和PassWord后面分别填写连接数据库所需的用户名和密码，RecordsetType默认值为3，使用动态指针，由于各数据库所支持的指针类型不一样，所以可能需要尝试更改该值进行类型的匹配，可能的值分别为0、1、2、3四种。EastFax采用ODBC中数据源连接的方式连接数据库，除了在上述配置文件中保存相应的信息外，还需要在系统的ODBC中建立一个系统数据库连接。打开控制面板中的“数据源（ODBC）”项目，切换到“系统DSN”标签，在此添加一个自己所用数据库的数据源，名称为EastFaxResultExt。只有在此测试通过EastFax方

25、能正确连接数据库。以SQLServer数据库为例，首先点击“系统DSN”中的“添加”按钮，弹出如下窗口：输入数据源名称EastFaxResultExt和数据库的服务器名称，下一步，选择数据库的认证方式，输入对应的用户名和密码，认证方式、用户名和密码都正确才可进入下一步。更改默认数据库为FAXSTAT表所在的数据库。一般语言等其他选项无需更改，点击完成进入下一步，在此可点击“测试数据源”按钮测试之前配置是否通过连接，测试成功时连接如下图：点击“确定”按钮回到系统DSN界面，可看到名为EastFaxResultExt的数据源已被建立。（3）用户可以按照自己的需求在FAXSTAT表中添加其他列，当用

26、户生成传真文件和流水号时，可事先将传真流水号写入表的ORD_NO列中，并将接收者序号填入表的RECV_INDEX列中，同时在其他自定义的列中输入其他信息以便后续的查询。（4）对于发送传真的结果信息，当有其他需求时，可另行协商定制开发结果字段。（5）对于一般支持ODBC连接的数据库，通过上述方式均可实现传真结果的回传，对于某些特殊的或不支持ODBC连接的数据库，可另行协商定制开发结果回传程序。2、对于传真结果的处理，在FAXSTAT表的“STATUS”列中对应的传真结果如下：0:管理员删除1:成功3:服务端取消4:客户端取消11:传真文件错误12:传真号码错误13:用户帐号错误14:用户没有权限

27、21:Modem不支持传真操作22:初始化Modem错误23:没有拨号音24:拨号错误25:没有回铃音26:长时间静音27:协商传真通讯参数错误28:错误的传真标识29:对方占线30:无人接听或是空号31:用户取消32:超时错误99:未知错误100：外部打印机转换失败3、若在结果连续提交三次仍不能成功提交到数据库后，EastFaxResultExt结果回传程序将在FaxResult文件夹下的ErrorRE文件夹中再建立一级子文件夹，并以当前的日期命名。回传不成功的efr结果文件将被转移至该文件夹中保存。4、当有回传不成功的情况出现时，在服务器安装目录中的log文件将有记录信息。Log文件名为E

28、astFaxRE*.log，“*”号代表0、1、2三个数字，EastFaxRE0.log为最新的log，根据该log文件大体可判断回传不成功的原因。5、用户可在自己的系统中开发查询程序，读取上述的FAXSTAT表并显示发送结果。五、EastFax接收接口说明EastFax提供外部接口程序EastFaxPostRecv.exe，专门用于处理服务端接收下来的传真文件，并按照指定的格式将文件存放到指定的路径下。当购买了此模块的授权，使用该接口程序非常简单，只需将该文件拷贝到服务端安装目录下即可，该程序会随服务端程序运行而自动运行。拷贝好文件后，还需要进行几点设置，打开服务端安装目录下的EastFax

29、S.ini配置文件，在General章节中增加以下内容：GeneralPostRecvDir=/设置用于存放转换后的文件的绝对路径，缺省为【程序目录】PostRecv，例如可以设置为D盘根目录下的Recv文件夹D:Recv，网络路径也可以，如192.168.1.10PostRecv。路径中支持转义字，转义字见后面的说明。比如根据来电号码分类存放文件，可以设置路径为D:RecvCallerID,这样不同来电号码发送过来的传真都可以归类到以该来电号码命名的文件夹。PostRecvFile=/最终文件的文件名格式，以转义字表示，转义字见后面的说明，缺省为FaxExt_FileName。RecvExtName=/设置接收进来的传真内容的格式，可以是bmp,jpg,gif,tiff,PDF，png等。JpgQuality=20/只对生成JPG文件时有用，取值范围是0100，默认为20，数值越大转换后的图片质量越好，但文件所占空间也越大。PostRecvDir和PostRecvFile都支持转义字，可通过转义字定义不同的名称。下面列出的中的内容就表示转义字（下面举例时，以20080407_213216