CTI控件接口文档
修改历史 (3)
一、概述 (4)
二、集成方案 (4)
二、控件接口定义 (6)
属性 (6)
方法 (7)
登录TDMx交换机 (7)
退出TDMx交换机 (7)
呼叫取消 (7)
呼叫转移 (8)
通话保持 (8)
拨号 (8)
获取线路状态 (9)
取指定线路状态 (9)
会议 (9)
获取分机用户信息 (10)
设置分机服务等级 (10)
软摘机 (11)
软挂机 (11)
用户自定义功能 (11)
IVR 播放请求 (12)
IVR 电脑话务员拆线 (12)
IVR 停止播放语音提示 (12)
IVR 呼叫转移 (12)
morningCall 设置morningCall叫醒时间 (13)
morningCall 查询morningCall叫醒时间 (13)
morningCall 取消morningCall设置 (14)
Start UDP listen (14)
Stop UDP listen (15)
免打扰 (15)
事件 (15)
登录失败 (15)
登录成功 (16)
忙提示 (16)
被叫振铃 (16)
分机用户信息 (17)
通话 (17)
拨号 (17)
催挂 (18)
空闲 (18)
回铃 (19)
回叫振铃 (19)
维护忙 (20)
来电显示 (20)
去电显示 (21)
程序错误 (21)
通讯错误 (22)
指定的线路状态信息 (22)
用户自定义功能执行失败 (22)
用户自定义功能执行成功 (23)
IVR 呼叫进入 (23)
IVR 用户拨号 (23)
IVR 用户拆线 (24)
IVR 播放结束 (24)
IVR 回叫 (24)
IVR 呼叫转移成功 (25)
IVR 呼叫转移失败 (25)
中继入中继分配 (25)
中继出中继分配 (26)
中继出中继呼叫 (26)
中继接收DTMF (26)
morningCall 设置事件 (27)
morningCall 查询事件 (27)
morningCall 取消事件 (27)
UDP DataArriVal (28)
转移提示 (28)
转移更新 (29)
三、用户类型表： (30)
四、功能码表 (30)
五、Delphi中控件导入 (31)
六、MixData 域位定义 (32)
TDMX交换机CTI控件接口文档(初稿) 修改历史
修改历史
注：蓝色部分为新增部分，红色部分为修改部分
一、概述
TDMX交换机提供服务器版和单机版CTI接口，该接口采用了COM组件技术，第三方开发商利用这个组件可以方便地进行二次开发。该接口操作简单，使用方便，缩短了CTI 应用的开发周期，大大提高了CTI应用二次开发效率。每条线路的状态变化均以事件的方式通知应用层，以实现对每条线路进行监控。
该接口WINDOWS操作系统或微软的.net架构下能很好的使用，可以跟VB、VC、Delphi、PB、LINUX，UNIX（SCO，HP）等开发工具进行完美的结合。
本文档适用于将OCX控件嵌入到已有的应用平台中实现CTI各种应用的第三方开发商。
二、集成方案
对使用OCX控件进行二次开发的用户，提供下列方案供参考：
TDMx服务版OCX控件系统集成方案逻辑结构TDMx单机版OCX控件系统集成方案逻辑结构
TDMx CTI接口 IVR控制流程
二、控件接口定义
在控件中频繁使用的线路ID，其范围从0到1023，如onHook(ID)事件的ID为0表示接在第一个接口上的用户已挂机。
该控件的属性、方法及事件中的ID均是从0开始。
属性
在执行控件的login方法登录TDMx交换机之前，需要设置下面这几个属性值：
方法
登录TDMx交换机
方法名称：Login(sUserName As String, sPassword As String)
功能说明：
当设置好上面的登录参数时，调用此方法登录TDMx交换机。若登录成功，产生loginOK事件;若登录失败产生loginErr事件。loginOK和loginErr事件的说明请参见各自的描述。
参数说明：
sUserName：登录交换机的管理员用户名，由属性userName指定
sPassword：登录交换机的管理员密码,由属性password指定
返回值：无
退出TDMx交换机
方法名称：logout()
功能说明：
当关闭应用程序或需要退出TDMx交换机的登录时调用。一旦调用logout()，应用程序将无法接收交换机发送的数据。若需要接收交换机的数据，必须以管理员身份重新登录。
参数说明：无
返回值：无
呼叫取消
方法名称：cmdCallCancel(ID As Integer)
功能说明：
呼叫取消，重新进入拨号状态。
例如，当用分机107（ID=6）呼叫分机号码为108（ID=7）的用户时，执行cmdCallCancel(6)后将取消对108的呼叫，重新进入拨号状态。若双方已通话，执行cmdCallCancel(6)后将取消与108的通话，107会重新进入拨号状态。
参数说明：
ID：发起呼叫取消的线路ID号。
返回值：无
呼叫转移
方法名称：cmdCallDivert(ID As Integer)
功能说明：
呼叫转移。
要完成呼叫转移操作，需要与cmdDial方法结合使用。
例如，当分机106（ID=5）收到呼叫并摘机通话时，若需要将来电转移到分机108，需要先执行下列指令ctisrv1.cmdCallDivert(5),延时1秒钟再执行指令ctisrv1.cmdDial(5,”108”)。
参数说明：
ID：发起呼叫转移的线路ID号
返回值：无
通话保持
方法名称：cmdCallHold(ID As Integer)
功能说明：
通话保持。
例如，当分机106（ID=5）与分机108（ID=7）正在通话时，要106发起通话保持操作，106将进入拨号状态，108将听到保持音，需要执行的指令：
ctisrv1.cmdCallHold (5)
若108要招执行通话保持，106将听到保持音, 需要执行的指令:
ctisrv1. cmdCallHold (7)
参数说明：
ID：需要保持的线路ID号
返回值：无
拨号
方法名称：cmdDial(ID As Integer, phone As String)
功能说明：
摘机后进行拨号操作。
例如，当分机106（ID=5）摘机后，若要拨打分机108（ID=7），需要发送下列指令：
ctisrv1.cmdDial (5,”108”) ，通知交换机5号线路用户需要拨打108
参数说明：
ID：发起拨号的线路ID号
返回值：无
获取线路状态
方法名称：cmdGetTisStatus(ID As Integer)
功能说明：
获取线路状态。状态见附录。
当状态返回时，产生相应的事件:
outOfService 维护忙事件
idle 空闲事件
connected 通话事件
hurryHangUp 催挂事件
onCall 回铃
这些事件在线路状态变化时，如用户摘机，拨号，挂机等均会自动产生。当有来电或外拨时，也会产生来电显示或去电显示事件。见下面描述。
参数说明：
ID：需要查询状态的线路ID号
返回值：无
取指定线路状态
方法名称：cmdGetOtherIDTisStatu(byval ID As Integer, byval userType As Integer, byval dstID As Integer)
功能说明：
。用于获取指定线路的状态信息（状态，分机号，用户名）
当指定线路的信息返回时，产生otherIDTisInfoArrival事件，见该事件描述
与cmdGetTisStatu不同之处是前者只能取自已的状态，而后者可取任意线路
参数说明：
ID：发起该命令的线路号
userType:发起者的用户类型
dstID:需要获取的线路ID
返回值：无
会议
方法名称：cmdIntoConference(ID As Integer)
功能说明：
创建或加入会议。
（1）创建会议流程：
现由用户102（ID=1）发起创建一个会议,将用户103（ID=2），104（ID=3）加入到会议中,需要按以下流程操作：
a、102（ID=1）摘机（或软摘机，调用ctiSrv1.cmdOffHook(1),具体见后面描述）
b、102调用ctisrv1.cmdDial(1,”103”)方法拨打分机103 ，
c、103摘机，102与103处于通话中
d、102调用ctiSrv1.cmdCallHold(1)方法发保持操作以后，102进入拨号状态，
103听保持音
e、102再调用ctisrv1.cmdDial(1,”104”)拨打分机104
f、104摘机后，102与104处于通话中
g、102调用ctisrv1.cmdIntoConference (1)方法发起会议操作以后, 102，103，
104便处于会议中，可进行三方通话。
(2) 加入会议流程：
在上面的会议已存在的情况下，若要将用户105（ID=4）拉入会议，需按如下流程操作：（假设由102（ID=1）邀请105加入会议）
a、102调用ctiSrv1.cmdCallHold(1)发保持
b、102调用ctisrv1.cmdDial(1,”105”)拨打分机103
c、105摘机后，102与105处于通话中。
c、102调用ctisrv1.cmdIntoConference (1)方法发会议操作后，105被拉入会议。
102，103，104,105便处于会议中，现在变成了四方会议，可进行四方通话。
如此类推，可将任意多个用户加入会议中，从而轻松实现多方通话。
参数说明：
ID：会议发起者的线路ID号
返回值：无
获取分机用户信息
方法名称：cmdQueryUserInfo(ID As Integer)
功能说明：
获取分机用户基本信息。
如要查询103（ID=2）的基本信息，可调用ctiSrv1.cmdQueryUserInfo(2),执行结果会产生baseInfoArrival事件，返回值请参见该事件描述。
参数说明：
ID：需要查询线路ID号
返回值：无
设置分机服务等级
方法名称：cmdSetSrvCls(ByVal ID As Integer, ByVal setID As Integer, ByVal setSrvCls As Integer)
功能说明：
设围分机的服务级别，不同的服务级别具有不同的权限。
根据服务级别可以限制声讯台、长途（国际、国内）等拨号限制，系统支持最多32个服务等级
参数说明：
ID：设置服务级别的ID
setID:被设置服务级别的通道号
serSrvCls:要设置的服务级别(0-31)
返回值：无
软摘机
方法名称：cmdOffHook(ByVal ID As Integer)
功能说明：
软摘机。该操作相当于拿起电话手柄。
如102（ID=1）需要进行软件拨打105（ID=4），需要调用如下指令：
ctisrv1.cmdOffHook(1)
ctisrv1.cmdDial(1,”105”);
当105摘机后，102拿起话就可与105通话
参数说明：
ID：需要软摘机的线路ID号
返回值：无
软挂机
方法名称：cmdOnHook(ByVal ID As Integer)
功能说明：
软挂机。
如102（ID=1）需要进行软件拨打105（ID=4），需要调用如下指令：
ctisrv1.cmdOffHook(1)
ctisrv1.cmdDial(1,”105”);
当105摘机后，102拿起话就可与105通话
当102调用ctisrv1.cmdOnHook(1)后，便断开与105的通话。
参数说明：
ID：需要软挂机的线路ID号
返回值：无
用户自定义功能
方法名称：rCommand(ID As Integer, cmdReq() As Byte)
功能说明：
自定义接口，需要交换机支持用户自定义的功能。
参数说明：
ID：需要实现该接口功能线路号ID
返回值：无
IVR 播放请求
方法名称：cmdIVRPlayReq(ByVal ID As Integer, ByVal voiceID As String)
功能说明：
要求交换机为用户播放指定语音段，前提条件是外线必须接通电脑话务员。
参数说明：
ID：电脑话务员ID
voiceID:需要播放的语音段，目前支持最大32段语音提示，但总的播放时长不能超过1分钟。
返回值：无
IVR 电脑话务员拆线
方法名称：cmdIVRRemoveLine(ByVal ID As Integer)
功能说明：
由电脑话务员发起的拆线请求。
参数说明：
ID：电脑话务员ID
返回值：无
IVR 停止播放语音提示
方法名称：cmdIVRStopPlay(ByVal ID As Integer)
功能说明：
由电脑话务员发起的停止播放请求。
参数说明：
ID：电脑话务员ID
返回值：无
IVR 呼叫转移
方法名称：cmdIVRCallDivert(ByVal ID As Integer, ByVal phone As String)
功能说明：
由电脑话务员发起的呼叫转移。当转移成时产生IVRCallDivOK事件，转移失败时产生IVRCallDivErr
参数说明：
ID：电脑话务员ID
Phone:要转移的电话号码
返回值：无
morningCall 设置morningCall叫醒时间
方法名称：cmdSetMorningCall(ByVal ID As Integer, ByVal userType As Integer, ByVal dstID As Integer, ByVal morningCallTime As String)
功能说明：
设置指定分机的叫醒时间。该功能可以设置任意一部分机的叫醒时间.当ID与dstID相同时表示设置自己的叫醒时间
参数说明：
ID：发起设置morningCall的分机所属通道号，范围为0-1023。
userType:发起设置的ID所属的用户类型，参见附录。
dstID:被设置成morningCall的目标通道号，范围为0-1023
morningCallTime:叫醒时间，长度必须为14位，按年月日时分秒的顺序，格式为“YYYYMMDDHHMMSS”。
例如，假设前台用105分机(对应的通道号为4)登录管理软件，想将103分机（相应的通道号为2）的叫醒时间设置为2006年8月30日早上7:30，调用如下：
cmdSetMorningCall（4，1，2，“20060830073000”）
如果以管理员身份登录，参数ID可任意指定。
当设置成功后，会产生一个morningCallSetArrival事件，见该事件的描述。
若时间格式不对，将产生errorOccur事件。错误代码描述：
2301：源ID超界
2302：目标dstID超界
2303：叫醒时间含非法字符或格式不正确或长度非法!
返回值：无
morningCall 查询morningCall叫醒时间
方法名称：cmdGetMorningCall(ByVal ID As Integer, ByVal userType As Integer, ByVal dstID As Integer)
功能说明：
查询指定分机的叫醒时间。该功能可以查询任意一部分机的叫醒时间.当ID与dstID相同时表示查询自己的叫醒时间
参数说明：
ID：发起查询的分机所属通道号，范围为0-1023。
userType:发起查询的ID所属的用户类型，参见附录。
dstID:要查询的目标通道号，范围为0-1023
例如，假设前台用105分机(对应的通道号为4)登录管理软件，要查询103分机（相应的通道号为2）是否设置了morningCall，调用如下：
cmdGetMorningCall（4，1，2）
如果以管理员身份登录，参数ID可任意指定。
当查询成功后，会产生一个morningCallGetArrival事件，见该事件的描述。
该事件错误代码描述：
2301：源ID超界
2302：目标dstID超界
返回值：无
morningCall 取消morningCall设置
方法名称：cmdCancelMorningCall(ByVal ID As Integer, ByVal userType As Integer, ByVal dstID As Integer)
功能说明：
取消指定分机的叫醒设置。该功能可以取消任意一部分机的叫醒设置，.当ID与dstID 相同时表示取消自己的叫醒设置
参数说明：
ID：发起取消动作的分机所属通道号，范围为0-1023。
userType:发起取消的ID所属的用户类型，参见附录。
dstID:要取消的目标通道号，范围为0-1023
例如，假设前台用105分机(对应的通道号为4)登录管理软件，要取消103分机（相应的通道号为2）的morningCall 设置，调用如下：
cmdCancelMorningCall（4，1，2）
如果以管理员身份登录，参数ID可任意指定。
当查询成功后，会产生一个morningCallCancelArrival事件，见该事件的描述。
该事件错误代码描述：
2301：源ID超界
2302：目标dstID超界
返回值：无
Start UDP listen
方法名称:
UDPStart()
功能说明:
从指定端口启动UDP功能，当有数据到达时产生UDPDataArrival事件,收到的数据包括下列数据包：
1:用户登录数据包
2:线路状态变化包
参数：
None
Return Value:
None.
Stop UDP listen
方法名称:
UDPStart()
功能说明:
从指定端口停止UDP功能，执行该方法后将不能收到下列数据包：
1:用户登录数据包
2:线路状态变化包
参数：
None
Return Value:
None.
免打扰
方法名称：cmdSetNoDisturb(ByVal ID As Integer, ByVal setFlag As Boolean)
功能说明：
设置/取消免打扰功能。
参数说明：
ID：需要设置/取消免打扰功能的通道号，
setFlag:True---设置免打扰FALSE—取消免打扰
返回值：无
事件
登录失败
事件名称：loginErr(ByVal ID As Integer, ByVal errCode As String, ByVal errDesc As String) 功能说明：
当登录失败时产生该事件。
参数说明：
ID：暂是不用
errCode：登录失败的错误代码
errDesc：登录失败的原因
返回值：无
登录成功
事件名称：loginOK(ByVal ID As Integer)
功能说明：
当登录成功时产生该事件。
参数说明：
ID：暂是不用
返回值：无
忙提示
事件名称：busyPrompt(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal assPhone As String, ByVal assUserName As String)
功能说明：
当处于忙状态时，若收到呼叫，将产生该事件。利用该事件可以知道当自己正在通话或正在拨打电话时，不会漏掉任何一个来电。同时主叫方也会收到一个催挂事件（hurryHangUp），从事件参数中可以知道被叫的分机号及用户名。
参数说明：
ID：处于忙状态的线路ID
assID:相关线路ID
assPhone：相关号码（主叫方电话号码）
assUserName：相关用户名称(主叫方名称，若交换机中没有设置用户名，该名称为空) 返回值：无
被叫振铃
事件名称：calledRing(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String,byval mixData as integer)
功能说明：
当被叫振铃时产生该事件
参数说明：
ID：被叫方线路ID
userType:用户类型
assID:相关ID
assUserType:相关用户的用户类型
assPhone：相关号码（来电号码）
assUserName:相关用户名
mixData: 位定义见附录
返回值：无
分机用户信息
事件名称：baseInfoArrival(ByVal ID As Integer, ByVal userType As Integer, ByVal phone As String, ByVal userName As String, ByVal srvCls As Integer, ByVal srvClsName As String, ByVal maxConnectTime As Integer, ByVal funCodeDescription As String)
功能说明：
当调用cmdQueryUserInfo获取分机用户信息后产生该事件
参数说明：
ID：分机所对应的ID ，与cmdQueryUserInfo方法中的ID相同
userType：用户类型，见附录。
Phone：分机号
Username：用户名称
srvCls：分机服务级别（0-31，0为最高级别）
srvCls：服务级别名称
maxConnectTime：最大通话时间(分钟)（0:无限制）
funCodeDescription：功能码，见附录
返回值：无
通话
事件名称：connected(ByVal ID As Integer, ByVal userType As Integer, ByVal IOFlag As Integer, ByVal assID As Integer, ByVal assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String,byval mixData as integer)
功能说明：
当通话时产生该状态。一次通话建立后，双方均会产生通话事件。
参数说明：
ID：处于通话状态的分机所对应的线路ID
userType：用户类型，见附录。
IOFlag：呼入呼出标志0-呼入1-呼出
assID:相关ID
assUserType：相关用户的用户类型
assPhone：相关号码
assUserName:相关用户名
mixData: 位定义见附录
返回值：无
拨号
事件名称：
dial(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal
assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String,byval mixData as integer)
功能说明：
当用户摘机后进入拨号状态，产生该事件
参数说明：
ID：被摘机的线路ID
userType：用户类型，见附录。
assID:相关ID
assUserType：相关用户的用户类型
assPhone：相关号码
assUserName:相关用户名
mixData: 位定义见附录
返回值：无
催挂
事件名称：
hurryHangUp(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String, byval mixData as integer)
功能说明：
当摘机后久不拨号或对方忙时或拨号超时，产生该事件
参数说明：
ID：被摘机的线路ID
userType：用户类型，见附录。
assID:相关ID
assUserType：相关用户的用户类型
assPhone：相关号码
assUserName:相关用户名
mixData: 位定义见附录
返回值：无
空闲
事件名称：
idle(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String, byval mixData as integer)
电话机正常下处于空闲状态，当摘机后挂机或通话完成后挂机产生该事件。
参数说明：
ID：处于空闲状态的线路ID
userType：用户类型，见附录。
assID:相关ID
assUserType:相关用户的用户类型
assPhone：相关号码
assUserName:相关用户名
mixData: 位定义见附录
返回值：无
回铃
事件名称：
onCall(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String, byval mixData as integer)
功能说明：
当呼叫对方时，对方振铃，然后已方回铃，此时便产生回铃事件。
参数说明：
ID：处于回铃状态的线路ID
userType：用户类型，见附录。
assID:相关ID
assUserType：相关用户的用户类型
assPhone：相关号码（去电号码）
assUserName:相关用户名
mixData: 位定义见附录
返回值：无
回叫振铃
onCall(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String, byval mixData as integer)
功能说明：
当有被保持用户时，若用户挂机会发生回叫振铃
ID：处于回铃状态的线路ID
userType：用户类型，见附录。
assID:相关ID
assUserType：相关用户的用户类型
assPhone：相关号码（去电号码）
assUserName:相关用户名
mixData: 位定义见附录
返回值：无
维护忙
事件名称：
outOfService(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String, byval mixData as integer)
功能说明：
当调用cmdGetTisStatu时，如果在交换机上没有为该线路配置分机信息或该线路不存在，产生该事件。
参数说明：
ID：处于维护忙状态的线路ID
userType：用户类型，见附录。
assID:相关ID
assUserType:相关用户的用户类型
assPhone：相关号码
assUserName:相关用户名
mixData: 位定义见附录
返回值：无
来电显示
事件名称：
phoneDisplay(ByVal ID As Integer, ByVal userType As Integer, ByVal assID As Integer, ByVal assUserType As Integer, ByVal assPhone As String, ByVal assUserName As String, byval mixData as integer)
功能说明：
当有来电时产生该事件。
参数说明：
API接口文档
API接口文档 最后更新日期：2013-05-16 一、添加域名接口 (6) 1、接口调用地址 (6) 2、传入参数 (6) 3、输出数据 (6) 二、删除域名接口 (7) 1、接口调用地址 (7) 2、传入参数 (7) 3、输出数据 (7) 三、添加用户接口 (8) 1、接口调用地址 (8) 2、传入参数 (8) 3、输出数据 (8) 四、获取用户信息接口 (9) 1、接口调用地址 (9) 2、传入参数 (9) 3、输出数据 (9) 五、搜索用户接口 (10) 1、接口调用地址 (10) 2、传入参数 (10) 3、输出数据 (10) 六、修改用户接口 (11) 1、接口调用地址 (11) 2、传入参数 (11) 3、输出数据 (12) 七、删除用户接口 (13) 1、接口调用地址 (13) 2、传入参数 (13) 3、输出数据 (13) 八、获取邮箱别名接口 (14) 1、接口调用地址 (14) 2、传入参数 (14) 3、输出数据 (14) 九、获取部门列表接口 (15) 1、接口调用地址 (15) 2、传入参数 (15) 3、输出数据 (15) 十、添加部门接口 (17) 1、接口调用地址 (17)
3、输出数据 (17) 十一、修改部门接口 (18) 1、接口调用地址 (18) 2、传入参数 (18) 3、输出数据 (18) 十二、删除部门接口 (19) 1、接口调用地址 (19) 2、传入参数 (19) 3、输出数据 (19) 十三、获取部门成员接口 (20) 1、接口调用地址 (20) 2、传入参数 (20) 3、输出数据 (20) 十四、添加部门成员接口 (21) 1、接口调用地址 (21) 2、传入参数 (21) 3、输出数据 (21) 十五、删除部门成员接口 (22) 1、接口调用地址 (22) 2、传入参数 (22) 3、输出数据 (22) 十六、添加别名接口 (23) 1、接口调用地址 (23) 2、传入参数 (23) 3、输出数据 (23) 十七、修改别名接口 (24) 1、接口调用地址 (24) 2、传入参数 (24) 3、输出数据 (24) 十八、删除别名接口 (25) 1、接口调用地址 (25) 2、传入参数 (25) 3、输出数据 (25) 十九、获取POP接收邮件接口 (26) 1、接口调用地址 (26) 2、传入参数 (26) 3、输出数据 (26) 二十、添加POP接收邮件接口 (27) 1、接口调用地址 (27) 2、传入参数 (27) 3、输出数据 (27) 二十一、修改POP接收邮件接口 (28) 1、接口调用地址 (28)
开发接口文档-API文档模板
XXX项目接口文档版本控制信息 获取所有字段 获取所有字段 请求地址：/session/field/findAll 请求参数 响应
请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"ico nStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconSty le":"","id":7,"name":"XX"}]},"totals":0} 文件上传 文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：var formData = new FormData(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData,
processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功！'); $("#editHeadPortrait").val } } }); 响应例子：returnValue里包含了 fileName和filePath 字段管理-所属类型 新增所属类型 请求地址：/session/fieldType/save 请求参数 响应 请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}
软件开发文档模板
软件开发文档模板 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案 1 1.5.2 可选择的系统方案 2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资
1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点
API 接口 设计文档 模板
Dream调试工具DLL接口文档 文件状态：[√] 草稿[ ] 正式发布[ ] 正在修改当前版本： 1.0 作者：ChunFeng Li 文件密级：[ ]普通[√]秘密[ ]绝密 文档版本 版本/状态作者参与者日期说明 1.0 ChunFeng Li ChunFeng Li 2016-04-13 设备只能发现串口连接的设备，指 令只能下发单条修改 一、DLL初始化 1.描述 调用所有接口之前需要先调用初始化接口。 2.接口名（dll导出名） Dream_Init() 3.请求参数说明 参数字段必选类型限制说明 _net_point True int<65535 Udp广播端口号 _com_rate True int 38400 连接串口的默认波特率 _call_back True Void* ... 异步消息回调（详细见第五条：回调函数） 4.返回参数说明 a.返回类型Int :0成功-1重复初始化 二、获取最新设备列表 1.描述 调用该接口获取所有当前在线列表。 2.接口名（dll导出名） Dream_GetDeviceList() 3.请求参数说明
char_buf True char* 1024 存放返回数据的内存指针，空间大小有调 用方分配 buf_len True int 1024 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。 b.返回数据结构:”1000,COM3\r\n1001,COM5\r\n1002,192.168.0.118\r\n”。 [ID,Name\r\n]为一个设备，以后有跟多设备详细信息，往后接。 三、发送指令消息 1.描述 下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明 参数字段必选类型限制说明 device_id True int>1000 发送消息的设备ID例如1000 _ChannelCode True int 0-0xFF 通道编码：例如0x10 _FunctionCode True int 0-0xFF 功能编码，不同的编码对应不同的功能_FunctionNumber True int 0-0xFF 功能编号，标记当前编码对应不同的功能data_msg True char* 发送指令的data，没有数据为NULL，如 果是单个数据：12.1，如果是整组数据： 12.1,1,0,...... 按顺序逗号隔开的连续字符 time_out True int 20*N 接口调用超时时间，单位毫秒 out_buf True char* 存放返回数据的内存指针，空间大小有调 用方分配 buf_max_len True int 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。如果为0,表示超时或网络异常 b.返回的数据结构：如果是下发数据，返回的是成功和失 败；”ACK”,”NAK”,”NO_CMD”,”ERROR”,”TimeOut”,如果是读取数据，返回的是数据， 例如12.1，或数据组12.1,12.2,1,1.2..... 四、DLL初始化 1.描述 下发数据和读取数据指令都通过该接口实现。(非阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明
软件项目开发各阶段文档模板(参考)
目录 1. 范围 (1) 2. 总体要求 (1) 2.1总体功能要求 (1) 2.2软件开发平台要求 (1) 2.3软件项目的开发实施过程管理要求 (2) 2.3.1 软件项目实施过程总体要求 (2) 2.3.2 软件项目实施变更要求 (2) 2.3.3 软件项目实施里程碑控制 (3) 3. 软件开发 (4) 3.1软件的需求分析 (4) 3.1.1 需求分析 (4) 3.1.2 需求分析报告的编制者 (5) 3.1.3 需求报告评审 (5) 3.1.4 需求报告格式 (5) 3.2软件的概要设计 (5) 3.2.1 概要设计 (5) 3.2.2 编写概要设计的要求 (6) 3.2.3 概要设计报告的编写者 (6) 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 (6) 3.2.5 概要设计的评审 (6) 3.2.6 概要设计格式 (6) 3.3软件的详细设计 (7) 3.3.1 详细设计 (7) 3.3.2 特例 (7) 3.3.3 详细设计的要求 (7) 3.3.4 数据库设计 (7) 3.3.5 详细设计的评审 (7) 3.3.6 详细设计格式 (8) 3.4软件的编码 (8) 3.4.1 软件编码 (8) 3.4.2 软件编码的要求 (8) 3.4.3 编码的评审 (8) 3.4.4 编程规范及要求 (8) 3.5软件的测试 (9) 3.5.1 软件测试 (9) 3.5.2 测试计划 (9)
3.6.1 交付清单 (9) 3.7软件的鉴定验收 (10) 3.7.1 软件的鉴定验收 (10) 3.7.2 验收人员 (10) 3.7.3 验收具体内容 (10) 3.7.4 软件验收测试大纲 (11) 3.8培训 (11) 3.8.1 系统应用培训 (11) 3.8.2 系统管理的培训（可选） (11) 1. 引言 (19) 1.1编写目的 (19) 1.2项目风险 (19) 1.3文档约定 (19) 1.4预期读者和阅读建议 (20) 1.5产品范围 (20) 1.6参考文献 (20) 2. 综合描述 (21) 2.1产品的状况 (21) 2.2产品的功能 (22) 2.3用户类和特性 (22) 2.4运行环境 (22) 2.5设计和实现上的限制 (23) 2.6假设和约束(依赖) (23) 3. 外部接口需求 (24) 3.1用户界面 (24) 3.2硬件接口 (25) 3.3软件接口 (25) 3.4通讯接口 (26) 4. 系统功能需求 (26) 4.1说明和优先级 (27) 4.2激励／响应序列 (27) 4.3输入／输出数据 (28) 5. 其它非功能需求 (28) 5.1性能需求 (28) 5.2安全措施需求 (29) 5.3安全性需求 (29) 5.4软件质量属性 (29) 5.5业务规则 (29) 5.6用户文档 (30)
京东API接口整理
1、类目API 获取商家类目信息 获取类目属性 通过类目属性ID获取属性值列表 设置商家级别的类目销售属性值 添加商家商品销售属性 更新商家商品销售属性 获取类目属性列表 获取类目属性值 获取单个类目信息 查找子类目列表 查询商家已授权的品牌 数据结构 item_cat categoryAttr类目属性对象 attrFeature类目属性特殊属性 categoryAttrGroup属性分组 attrGroupFeature属性分组特殊属性 categoryAttrValue类目属性值对象 attrValueFeature类目属性特殊属性 feature特殊属性 wareaddvender_sellsku添加商家商品销售属性
wareupdatevender_sellsku更新商家商品销售属性 brandList商家品牌List集合 2、店铺API 京东店铺API，包含提供商家、商家店铺基本信息及店内分类操作查询等功能。 添加卖家自定义店内分类 更新商家自定义店内分类 删除商家自定义店内分类 获取前台展示的商家自定义店内分类 查询商家基本信息 店铺信息查询 查询退货地址列表 查询发货地址列表 3、商品API 提供网站商品信息更新、查询API,该组下所有接口均不支持自营店铺业务 1. 新增商品 修改商品 商品上架 商品下架 删除商品信息 根据商品ID查询单个商品的详细信息 批量获取商品信息 检索商品信息
获取商品上架的商品信息 获取商品下架的商品信息 根据商品Id，销售属性值Id查询图片根据商品Id，销售属性值Id增加图片根据商品Id，销售属性值Id删除图片根据商品Id，销售属性值Id设置图片根据商品Id，检索商品图片 设置商品限购区域 查询商品限购区域 添加商品关联版式 修改商品关联版式 删除商品关联版式 查询关联版式id以及名称 查询关联版式详情 设置关联版式到商品 增加SKU信息 修改SKU信息 修改SKU库存信息 修改SKU价格信息 删除SKU 信息 根据外部ID获取商品SKU 根据商品ID列表获取商品SKU信息 获取单个SKU信息 回复商品评价 查询商品评价信息列表
api接口文档
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。 API：应用程序接口（API：Application Program Interface） 应用程序接口（是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。API 同时也是一种中间件，为各种不同平台提供数据共享。 根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将API 分为四种类型： 远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。 标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。 文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。 当前应用于API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付API 类型是比较理想的选择。 API 与图形用户接口（GUI）或命令接口有着鲜明的差别：API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。 有时公司会将API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式API。
软件开发文档模板库
软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1
1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题
开发接口API模板
XXX项目接口文档 版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/session/field/findAll 请求参数 响应 响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"",
"iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传 2.1文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：var formData = new FormData(); formData.append("file", this.files[0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = JSON.parse(result); if(result.code == "10000"){
java开发接口文档模板
竭诚为您提供优质文档/双击可除java开发接口文档模板 篇一：java的接口与实例 一、定义 java接口（interface），是一系列方法的声明，是一些方法特征的集合，一个接口只有方法的特征没有方法的实现，因此这些方法可以在不同的地方被不同的类实现，而这些实现可以具有不同的行为（功能）。 接口定义的一般形式为： [访问控制符]interface{ 类型标识符final符号常量名n=常数； 返回值类型方法名([参数列表]); … } 二、接口的特点 1、java接口中的成员变量默认都是 public,static,final类型的(都可省略),必须被显示初始化,即接口中的成员变量为常量(大写,单词之间用"_"分隔) 2、java接口中的方法默认都是public,abstract类型
的(都可省略),没有方法体,不能被实例化 3、java接口中只能包含public,static,final类型的成员变量和public,abstract类型的成员方法 4、接口中没有构造方法,不能被实例化 5、一个接口不能实现(implements)另一个接口,但它可以继承多个其它的接口 6、java接口必须通过类来实现它的抽象方法 7、当类实现了某个java接口时,它必须实现接口中的所有抽象方法,否则这个类必须声明为抽象类 8、不允许创建接口的实例(实例化),但允许定义接口类型的引用变量,该引用变量引用实现了这个接口的类的实例 9、一个类只能继承一个直接的父类,但可以实现多个接口,间接的实现了多继承. 三、接口的用法 1、精简程序结构，免除重复定义 比如，有两个及上的的类拥有相同的方法，但是实现功能不一样，就可以定义一个接口，将这个方法提炼出来，在需要使用该方法的类中去实现，就免除了多个类定义系统方法的麻烦。举例：鸟类和昆虫类都具有飞行的功能，这个功能是相同的，但是其它功能是不同的，在程序实现的过程中，就可以定义一个接口，专门描述飞行。 下图是分别定义鸟类和昆虫类，其都有飞行的方法。
restfu接口文档模板
XXXX公司接口协议说明书接口协议说明书 受控状态： 发放号： 2017-07-13发布2017-07-13实施
版权说明
修订页
目录 通信协议说明书 (1) 目录 (4) 1引言 (5) 1.1Restful介绍 (5) 2中心服务器与播放控制器间通信协议 (5) 2.1概述 (5) 2.2用户管理 (5) 2.2.1登录 (5)
1引言 1.1Restful介绍 REpresentational State Transfer (REST) 是一种架构原则，其中将web 服务视为资源，可以由其URL 唯一标识。RESTful Web 服务的关键特点是明确使用HTTP 方法来表示不同的操作的调用。REST 的基本设计原则对典型CRUD 操作使用HTTP 协议方法：POST - 创建资源GET - 检索资源PUT –更新资源DELETE - 删除资源. REST 服务的主要优势在于：它们是跨平台(Java、.net、PHP 等）高度可重用的，因为它们都依赖基本HTTP 协议。它们使用基本的XML/JSON，而不是复杂的SOAP XML，使用非常方便。 2中心服务器与播放控制器间通信协议 2.1概述 云平台中心服务器与播放控制器间的通信采用restful通信协议框架，云平台作为restful服务器，播放控制器作为restful客户端。 登录 2.2用户管理 2.2.1登录 2.2.1.1请求API POST /api/v1/login 2.2.1.2请求参数描述 2.2.1.3请求参数示例 { "account": "admin", "password": "md5(admin)" }
ISO26262 开发接口协议DIA
Development Interface Agreement - DIA
1 Table of Contents 1T ABLE OF C ONTENTS (2) 2R EVISION H ISTORY (3) 3I NTRODUCTION (4) 3.1G ENERAL OVERVIEW (4) 3.2A BOUT THIS DOCUMENT (4) 3.3A BBREVIATIONS (4) 4R EFERENCES (6) 5B ACKGROUND TO DIA (7) 6R EFERENCE TO NDA (7) 7P ROCESSES (7) 8W ORK P RODUCTS (7) 9R ESPONSIBILITIES (8) 10I NTERFACES (8) 10.1M ILESTONES (9) 11C OMBINED ACTIVITIES (9) 11.1C OMBINED CONFIRMATION REVIEWS (9) 11.2P LANNING OF S AFETY A SSESSMENTS (9) 12C OMMUNICATION (9) 13R ESPONSIBILITIES AFTER SOP (9)
2 Revision History Blue text in italic is information/explanation directed to the issuer of the document.Before releasing the Work Product (document) all blue italic text must be removed. Mark unused sections of this document as “NOT APPLICABLE”, do not remove the paragraph heading. Text marked with a
软件开发设计文档模板
软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（System Specification） 一．引言 A.文档的范围和目的 B.概述 1．目标 2．约束 二．功能和数据描述 A.系统结构 1．结构关系图 2．结构关系图描述 三．子系统描述 A.子系统N的结构图规约说明 B.结构字典 C.结构连接图和说明 四．系统建模和模拟结构 A.用于模拟的系统模型
B.模拟结果 C.特殊性能 五．软件项目问题 A.软件项目可行性研究报告 B.软件项目计划 六．附录 软件项目可行性研究报告（Report for Feasibility Study） 一．引言 1．编写目的（阐明编写可行性研究报告的目的，指出读者对象） 2．项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。） 3．定义（列出文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．可行性研究的前提 1．要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软件相关的其他系统；（8）完成期限。） 2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理信息服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。） 3．条件、假定和限制（可包括：（1）建议开发软件运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬件、软件、运行环境和开发环境的条件和限制；（6）可利用的信息和资源；（7）建议开发软件投入使用的最迟时间。） 4．可行性研究方法 5．决定可行性的主要因素 三．对现有系统的分析 1．处理流程和数据流程 2．工作负荷 3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。） 4．人员（列出所需人员的专业技术类别和数量。） 5．设备 6．局限性（说明现有系统存在的问题以及为什么需要开发新的系统。） 四．所建议技术可行性分析 1．对系统的简要描述 2．处理流程和数据流程 3．与现有系统比较的优越性 4．采用建议系统可能带来的影响 （1）对设备的影响 （2）对现有软件的影响
软件开发技术设计文档模板
1. 引言 1.1 设计背景 在快节奏的大学日常生活中，社交软件已经成为大家日常必不可少的一部分，普通大学生的朋友圈和QQ空间等社交软件平台上，经常能够看到有人发送寻物启事、或是拾到他人丢失物品的拾主找寻丢失它的失主的某些消息。大学日常生活中，大部分人都会有曾经丢过东西的经历，无论大小。那如果一旦丢失了一些对我们比较重要的东西呢？譬如带有重要资料的U盘、随身携带的耳机、出入图书馆会用到的校园卡、身份证、夹着银行卡的钱包等等，无论是马虎大意还是因为焦急匆忙，那些“求扩！”、“急寻！”、“大家帮帮忙！”的字眼都着实能够让人感受到失主的焦急与无奈。 但是，由于好友人数的限制或是群人数的限制，大家往往会通过转发多个群或者请求好友扩散的方式来散播讯息。这种方法有着很大的弊端，首先是可见的人群少，只能自己的好友可见或者群内可见，这会使消息传递的比较缓慢，对于急于找到的东西造成了一定的时间浪费。其二，这还会浪费网络资源，也会把相对重要的信息顶替，对社交平台这个娱乐的环境造成一定的干扰，在如此环境下，本团队希望开发一个能够方便同学们生活的校园app，本app 暂时基于Android系统，用于帮助同学发布与接收失物的讯息。 1.2 编写目的 基于我们学校非常普遍的丢失物品现象，我们团队想要去一个平台能够帮助大家快速将信息集合起来，尽最大可能地使大家快速寻找到自己在校园内丢失的物品，并且能够将捡到的东西及时还给失主。 2. 软件支持 类型软件 浏览器 应用服务器Tomcat 8.0 开发工具Android Studio 7.0 Myeclipse 2017 Navicat for MySQL10 Java 版本JAVA 8 Database MySQL 配置管理工具 Bug 管理 框架组件Hirbernate Volley MVC 3.总体功能概述 3.1 功能总体需求 3.2应用技术 以tomcat8.0搭建服务器，Mysql作为数据库支持，Android开发的APP 界面作为交互界面，使用前后端完全分离开发的框架MVC，在controller控制器部分，使用Java语言作为后端开发语言，使用sevlet搭建控制层的数据传输流，利用Hirbernate框架实现数据库的增删该查功能，其中图片上传的部分，利用Volley框架实现，首先将图片上传到服务器端，写好该图片的目录字段存储在数据库中，实现图片的存储显示。 3.3 整体框架视图
项目接口需求及设计说明文档(模板)
客户化开发需求规格说明书 媒讯集团E A S项目 CTC与EAS接口 需求及设计说明书 文档作者： 创建日期：2013-05-10 确认日期： 当前版本：1.0 拷贝数量：1 审批签字: 客户方： 实施方：
文档控制 修改记录 日期作者版本参考版本备注
目录 1.概述 (4) 1.1读者 (4) 1.2图例 (4) 1.3目的 (4) 二、业务现状 (5) 三、概要设计 (5) 3.1接口通讯方式 (5) 3.2通讯内容定义 (5) 3.3媒讯CTC系统提供接口使用范例 (5) 3.4金蝶EAS提供接口使用范例 (5) 3.5媒讯CTC系统提供接口服务地址 (7) 3.6金蝶EAS提供接口服务地址 (7) 3.7接口需求 (7) 四、详细设计 (8) 4.1XX EAS接口 (8)
1.概述 金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。 1.1读者 本文读者对象为业务管理人员、系统设计、开发人员、测试人员。 1.2图例 本文中如未进行特殊说明，各图标代表的含义如下： 表示一个活动； 表示动态的业务数据，如系统单据； 表示流程走向； 表示条件判断、流程分支； 表示静态的业务数据，如基础资料； 表示系统外一个手工处理活动； 表示系统外手工填制的单据； 表示当前系统之外的活动； 表示当前系统之外产生的业务数据。 1.3目的 本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档，可用于指导开发、测试工作和作为验收相关依据文档。
二、业务现状 待补充 三、概要设计 3.1接口通讯方式 金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。 3.2通讯内容定义 对于记录型的大对象，在通讯时，采用String型的xml格式的参数进行传递。对于其他非记录型的对象，在通讯时，可采用非xml格式的参数进行传递，也可使用多个参数。具体格式，请参照每个接口的通讯用例说明。 3.3媒讯CTC系统提供接口使用范例 待补充。 3.4金蝶EAS提供接口使用范例 3.4.1规范说明 EAS通过webService接口与异构系统通信。EAS WebService全部是使用java编写的，其接口描述符合WSDL国际标准，其数据描述符合XSD 国际标准。 本次提供的接口除系统登录接口外，其他接口都需要调用登录接口，以便将登陆的SessionId信息放入到SOAP 的HEADER 报文中。 3.4.2使用示例 金蝶在EAS上发布WebService服务，提供wsdl文件供客户端下载，其他业务系统根据下载的wsdl文件，产生客户端。 建议使用Axis2来生成客户端代理。
JAVA的开发详细设计文档模板
案卷号 日期2009/10/7 一卡通管理程序说明 详细设计说明书 作者：唐庆龙 完成日期：2009/10/7 签收人：老师 签收日期：2009/10/10 修改情况记录： 版本号修改批准人修改人安装日期签收人
目录 1引言 (1) 1.1编写目的 (1) 1.2背景 (1) 1.3定义 (1) 1.4参考资料 (1) 2程序系统的结构 (1) 3程序1（标识符）设计说明 (2) 3.1程序描述 (2) 3.2功能 (2) 3.3性能 (2) 3.4输入项 (2) 3.5输出项 (2) 3.6算法 (3) 3.7流程逻辑 (3) 3.8接口 (3) 3.9存储分配 (3) 3.10注释设计 (3) 3.11限制条件 (3) 3.12测试计划 (3) 3.13尚未解决的问题 (4) 4程序2（标识符）设计说明 (4)
1引言 1.1编写目的 说明编写这份详细设计说明书的目的，指出预期的读者范围。 1.2背景 说明： a．待开发的软件系统的名称； b．列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。 1.3定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4参考资料 列出要用到的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2程序系统的结构 用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。
软件开发项目文档参考格式
XX系统开发开发团队： 组长： 组员： 备注：XXX软件学院
目录 XX系统开发 (1) 1 概述 (3) 1.1 开发背景 (3) 1.2 开发目标 (3) 1.3 参考资料 (3) 1.4 设计原则 (3) 2 需求分析 (3) 2.1 需求陈述 (3) 2.2 操作用例 (4) 2.3 功能分析划分 (4) 2.3.1 系统登录 (4) 2.3.2 用户管理 (4) (4) 2.5 运行环境 (4) 3 总体设计 (4) 3.1 系统建模 (4) 3.1.1 层次方框图 (4) 3.1.2 ER图（实体-联系图） (4) 3.1.3 类图设计 (5) 3.2 接口设计 (5) 3.2.1 内部接口设计 (5) 3.2.2 登录界面设计 (5) 3.2.3 用户管理界面设计 (5) 3.3 数据库结构设计 (5) 3.3.1 数据库E-R图 (5) 3.3.2 数据库逻辑设计 (5) 4 详细设计 (6) 4.1 程序流程图 (6)
4.2 伪代码编写 (6) 5 实现 (7) 5.1 编码 (7) 5.1.1 代码约定 (7) 5.1.2 代码编写原则 (7) 5.2 测试要点 (7) 5.2.1 登录测试要点 (7) 5.2.2 主界面测试要点 (7) (7) 5.3 测试结果和总结 (7)
1 概述 1.1 开发背景 【比如为什么要开发这个系统】 1.2 开发目标 【该系统需要完成的基本功能，对系统的大体描述】 1.3 参考资料 【该系统涉及的开源项目等】 1.4 设计原则 【设计该系统遵守的原则，比如支持多数据库，可移植行，可拓展性等】 2 需求分析 2.1 需求陈述 【用平常语言描述该系统的全部功能和细节】 2.2 操作用例 【描述具体的操作例子，比如登录后进行何种操作】 2.3 功能分析划分 【分析功能并划分功能块】 2.3.1 系统登录 【比如，需要实现两种登录模块，普通登录，管理员登录，并且描述可能出现的各种情况以及问题处理】 2.3.2 用户管理 【比如：实现用户显示，添加，删除，修改】
项目开发详细设计说明书(超好用模板),完整版
修订记录
目录 第一章概述 (5) 1.1.应用模块的目的 (5) 1.2.应用模块总体描述 (5) 1.3.应用模块接口描述 (5) 1.4.假设条件 (5) 第二章设计模式（Design pattern） (6) 第三章类设计 (7) 3.1.分块类图 (8) 3.1.1.<类图1> (8) 3.1.2.<类图n> (8) 3.2.整体继承关系 (8) 3.3.类描述 (9) 3.3.1.<类名1> Class Description (9) 3.3.2.<类名n> Class Description (10) 第四章交互图 (12) 4.1.<情景编号1: 情景名称> (12) 4.1.1.交互图 (12) 4.1.2.例外情况及条件 (13) 4.2.<情景编号n: 情景名称> (13) 第五章状态图 (14) 5.1.<状态图编号1:状态图名称> (14) 5.2.<状态图编号n:状态图名称> (15) 第六章时序流程图 (16) 第七章用户界面设计说明 (18) 7.1.用户界面关系 (18) 7.2.用户界面具体描述 (18) 7.2.1.<界面编号1:界面名称〉 (18)
7.2.2.<界面编号N:界面名称〉 (19) 第八章测试考虑 (20) 第九章附录 (21) 9.1.附录A 代码举例 (21) 9.2.附录B 设计问题 (21) 9.2.1.<设计问题1> (21) 9.2.2.<设计问题n> (21)
第一章概述 1.1.应用模块的目的 请明确客户建立应用模块的目的。 1.2.应用模块总体描述 描述应用模块的总体功能。 1.3.应用模块接口描述 简要描述本应用模块的公共接口，具体接口会在相应的类中进行具体描述。建议采用列表的方式。 1.4.假设条件 列出在问题领域，项目方案及其它影响系统设计的可能方面内，应当成立的假设条件。包括系统的约束条件和应遵循的标准。