电话服务器V3.docx

1、电话服务器V3电话服务器V3 功能点说明说明： 本文档描述了CTI服务器的各项功能及其相应指令的发送关系，可作为坐席开发的说明文档。所有消息均是字符左对齐，右边的多余位数以空格填充。所有消息都以“$”字符作为结束符。所有消息字符均以Unicode编码。客户端于CTI的联接使用TCP通信，服务端监听端口为9696，客户端在操作前必须先建立联接，并获得联接成功。CTI部分功能点说明登陆部分一、 签入功能描述：客户端向CTI发出登陆请求，CTI根据登陆分机号初始化通道状态返回登陆结果。发送指令：AgentLogIn = 10100; /6-15工号 16-35AgentIp 36-55分机号 56-

2、91GUID返回结果：AgentLogInRet = 15101; /6-15AgentId 16-35AgentIp 36-45登陆结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：无后置条件：无二、 签出功能描述：客户端向CTI发出签出请求，CTI根据分机号重置通道状态返回签出结果。发送指令：AgentLogOut = 10200; /6-15工号 16-35AgentIp 36-71GUID返回指令：AgentLogOutRet = 15201; /6-15AgentId 16-35AgentIp 36-45签出结果 0成功 1失败 46-75附加信息 76-111

3、GUID前置条件：坐席签入 AgentLogIn后置条件：无三、 设置队列功能描述：客户端签入成功后可设置队列，一旦设置队列以后，还需示闲系统才会将坐席进行排队等候电话。发送指令：AgentSetQueue = 10300; /6-15AgentId 16-35AgentIp 36-55QueueId 56-91GUID接收指令：AgentSetQueueRet = 15301; /6-15AgentId 16-35AgentIp 36-45设置结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入 AgentLogIn后置条件：坐席示闲 AgentSayFree四、

4、 示闲功能描述：坐席设置完队列以后，可向CTI发出示闲指令，CTI接收指令将坐席进入相应队列排队等待电话发送指令：AgentSayFree = 10500; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentSayFreeRet = 15501; /6-15AgentId 16-35AgentIp 36-45设置结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入 AgentLogIn坐席设置队列 AgentSetQueue后置条件：无五、 示忙功能描述：坐席在示闲中如有事需离开，必须先示忙，这样系统不会再为其分配呼入电话。前

5、一电话结束以后自动进入忙状态发送指令：AgentSayBusy = 10400; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentSayBusyRet = 15401; /6-15AgentId 16-35AgentIp 36-45设置结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入 AgentLogIn后置条件： 无呼叫部分六、 发起呼叫功能描述：签入成功后坐席可主动发起呼叫，系统将获取可用外线进行呼出。呼出成功后向坐席返回呼出结果发送指令：AgentMakeCall = 20100; /6-15AgentId 16-

6、35AgentIp 36-55被叫号码 56-75主叫号码 76-105附加信息 106-141GUID接收指令：AgentMakeCallRet = 25101; /6-15AgentId 16-35AgentIp 36-45呼叫结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入 AgentLogIn后置条件： 获得呼叫结果 AgentGetCallState = 25102; /6-15AgentId 16-35AgentIp 36-55被叫号码 56-65检测呼叫结果 /1正在拨号 2回铃 3没有检测到拨号音 4被叫用户忙 5听到回铃声后线路上无声 6线路上

7、没有声音 7被叫用户摘机 8被叫用户摘机七、 收到呼叫结果功能描述：坐席呼出成功后，系统检测呼叫，并向坐席返回呼叫结果发送指令：无接收指令：AgentGetCallState = 25102; /6-15AgentId 16-35AgentIp 36-55被叫号码 56-65检测呼叫结果 1正在拨号 2回铃 3没有检测到拨号音 4被叫用户忙 5听到回铃声后线路上无声 6线路上没有声音 7被叫用户摘机 8被叫用户摘机 9被叫用户摘机 10被叫在指定时间内没有摘机 11自动拨号因为某种原因失败 12被叫用户号码为空号 13基本祯同步丢失超过100ms前置条件：坐席签入 AgentLogIn坐席呼出

8、AgentMakeCall后置条件：八、 收到震铃通知（有电话呼入）功能描述：如有电话分配到坐席则收到震铃通知。示闲分配的电话、坐席发起的呼叫、转移到达的电话都会引起坐席震铃事件。发送指令：无接收指令：AgentGetRinging = 25103; /6-15AgentId 16-35AgentIp 36-45对方号码前置条件：坐席签入 AgentLogIn后置条件：接受呼叫 AgentAnswerCall九、 收到忙音通知功能描述：坐席通话成功后，如对方先挂机，系统向坐席发送忙音通知发送指令：无接收指令：AgentGetBusyTone = 25104; /6-15AgentId 16-3

9、5AgentIp前置条件：坐席签入 AgentLogIn坐席呼出或接收呼叫 AgentMakeCall AgentAnswerCall后置条件： 无一十、 应答呼叫功能描述：坐席收到震铃消息后，可发出接收呼叫的消息，以接受此呼叫发送指令：AgentAnswerCall = 20200; /6-15AgentId 16-35AgentIp 36-65附加信息 66-101GUID接收指令：AgentAnswerCallRet = 25201; /6-15AgentId 16-35AgentIp 36-45应答结果 0成功 1失败 36-65附加信息 66-101GUID前置条件：坐席签入 Age

10、ntLogIn坐席收到震铃信号 AgentGetRinging后置条件：坐席挂机 AgentClearCall 一十一、 清除呼叫功能描述：通话中的坐席可主动挂机或在收到忙音信号的情况下进行挂机操作发送指令：AgentClearCall = 20300; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentClearCallRet = 25301; /6-15AgentId 16-35AgentIp 36-45清除呼叫结果 0成功 1失败 36-65附加信息 66-101GUID前置条件：坐席签入 AgentLogIn坐席呼出或接受呼叫 AgentMake

11、Call AgentAnswerCall后置条件：一十二、 转移呼叫功能描述：坐席可将正在通话的呼叫转于给其他空闲坐席，转于成功以后本坐席将收到忙音信号，可发送清除呼叫信号以进行本机挂机处理发送指令：AgentTransferCall = 20400; /6-15AgentId 16-35AgentIp 36-45目标AgentId 46-75附加信息 76-111GUID接收指令：AgentTransferCallRet = 25401; /6-15AgentId 16-35AgentIp 36-45转移结果 0成功 1对方正忙 2本方不在通话状态 3失败 46-75附加信息 76-111G

12、UID前置条件：坐席签入 AgentLogIn坐席呼出或接受呼叫 AgentMakeCall AgentAnswerCall后置条件：坐席清除呼叫 AgentClearCall一十三、 坐席呼叫坐席功能描述：坐席签入成功后可向空闲坐席发送呼叫请求发送指令：AgentCallAgent = 20500; /6-15AgentId 16-35AgentIp 36-45目标AgentId 46-75附加信息 76-111GUID接收指令：AgentCallAgentRet = 25501; /6-15AgentId 16-35AgentIp 36-45呼叫结果 0 成功 1对方忙 2对方没有登陆 3

13、本方坐席状态不是空闲，请先挂机 46-75附加信息 76-111GUID前置条件：坐席签入 AgentLogIn后置条件：一十四、 转外线功能描述： 座席将通话中电话，单步转移到外线电话。发送指令：AgentTransferToOutLine = 20600 /6-15AgentId 16-35AgentIp 36-55呼出号码 56-75使用主叫 76-105附加信息 106-141GUID接收指令：AgentTransferToOutLineRet = 25601 /6-15AgentId 16-35AgentIp 36-45转移结果 0成功 1呼叫失败 2本方不在通话状态 3失败 46-

14、75附加信息 76-111GUID前置条件：座席通话中后置条件： 座席空闲语音部分一十五、 发送DTMF功能描述：坐席通话过程中可向对方通道发送DTMF，一般可以作为向对方总机发送分机号使用。发送指令：AgentSendDtmf = 30100; /6-15AgentId 16-35AgentIp 36-45Dtmf 46-81GUID接收指令：AgentSendDtmfRet = 35101; /6-15AgentId 16-35AgentIp 36-45发送结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入 AgentLogIn坐席在通话中后置条件：一十六、

15、开始接收DTMF功能描述：坐席向CTI发送准备接收DTMF消息，CTI将于坐席相联的通道的dtmf缓存清空，以便接收新的dtmf字符。此应用一般用于IVR虚拟坐席。对应通道收到结束符后向坐席发送收到的dtmf字符发送指令：AgentBeginGetDtmf = 30200; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentBeginGetDtmfRet = 35201; /6-15AgentId 16-35AgentIp 36-45发送结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入坐席进入通话状态中后置条件：坐席收到d

16、tmf接收消息一十七、 收到DTMF字符功能描述：坐席签入后可接收对方通道发送的dtmf字符。此功能一般应用于IVR虚拟坐席。在开始接收前应先向CTI发送AgentBeginGetDtmf以便CTI对此通道的DTMF缓存进行清空处理发送指令：无接收指令：AgentGetDtmfStr = 35202; /6-15AgentId 16-35AgentIp 36-45获得的DtmfStr前置条件：坐席签入坐席进入通话中坐席发送开始接收dtmf消息 AgentBeginGetDtmf后置条件：一十八、 放音功能描述：坐席可向对应通道播放语音文件，如不在通话中向本通道播放语音文件发送指令：AgentP

17、layFile = 30300; /6-15AgentId 16-35AgentIp 36-45开始位置 46-81GUID 82- 语音文件相对位置接收指令：AgentPlayFileRet = 35301; /6-15AgentId 16-35AgentIp 36-45 0成功 1失败 46-75附加信息 76-111GUID前置条件：可使用AgentGetWavLen获取文件长度，再决定播放开始位置后置条件：停止放音 AgentStopPlayFile一十九、 停止放音功能描述：坐席在放音过程中可主动停止放音，如放音已自动结束，CTI放回停止放音失败发送指令：AgentStopPlayF

18、ile = 30400; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentStopPlayFileRet = 35401; /6-15AgentId 16-35AgentIp 36-45 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席正在放音中后置条件：二十、 录音功能描述：坐席通话成功后可向CTI发送开始录音指令，CTI根据收到的录音路径和录音文件名进行录音操作。发送指令：AgentRecordFile = 30500; /6-15AgentId 16-35AgentIp 36-71GUID 72- 语音文件相对位置接收指令：

19、AgentRecordFileRet = 35501; /6-15AgentId 16-35AgentIp 36-45 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入坐席开始通话后置条件：停止录音 AgentStopRecordFile二十一、 停止录音功能描述：坐席成功开始录音后可主动停止录音，如通话结束则录音自动停止此时返回停止录音失败。发送指令：AgentStopRecordFile = 30600; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentStopRecordFileRet = 35601; /6-15Age

20、ntId 16-35AgentIp 36-45 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入坐席开始通话坐席开始录音后置条件：二十二、 获取录音长度功能描述：坐席放音前可向CTI发送获取录音长度消息，CTI向坐席返回相应录音文件的字节长度发送指令：AgentGetWavLen = 30700; /6-15AgentId 16-35AgentIp 36-71GUID 72- 语音文件相对路径接收指令：AgentGetWavLenRet = 35701; /6-15AgentId 16-35AgentIp 36-45 0失败 0其他值返回的实际长度 46-75附加信息

21、 76-111GUID前置条件：坐席签入后置条件：二十三、 暂停放音功能描述：坐席放音过程中可请求暂停放音发送指令：AgentPausePlay = 30800; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentPausePlayRet = 35801; /6-15AgentId 16-35AgentIp 36-45 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入坐席开始放音后置条件：继续放音二十四、 继续放音功能描述：坐席暂停放音后可调用此功能进行继续放音，语音将从暂停位置开始向后放音。发送指令：AgentResumePl

22、ay = 30900; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentResumePlayRet = 35901; /6-15AgentId 16-35AgentIp 36-45 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入坐席开始放音坐席暂停放音后置条件： 停止放音质检部分二十五、 监听功能描述：坐席签入后，可作为质检坐席，可对其他坐席进行监听。在对第二个坐席进行监听前必须先停止监听发送指令：AgentMonitor = 40100; /6-15AgentId 16-35AgentIp 36-45BeListenedA

23、gentId 46-81GUID接收指令：AgentMonitorRet = 45101; /6-15AgentId 16-35AgentIp 36-45监听结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入被监听坐席通话中后置条件：停止监听 AgentStopMonitor二十六、 停止监听功能描述：监听坐席更换被监听坐席前必须先停止监听前一个坐席发送指令：AgentStopMonitor = 40200; /6-15AgentId 16-35AgentIp 36-71GUID接收指令：AgentStopMonitorRet = 45201; /6-15Agen

24、tId 16-35AgentIp 36-45停止结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入开始监听后置条件：二十七、 获取坐席通道状态功能描述：质检坐席可获取其他坐席的当前通道状态，如被获取坐席没有签入则返回空字符串发送指令：AgentGetState = 40300; /6-15AgentId 16-35AgentIp 36-71GUID 72- AgentId数组 例： 8012,8013,8014接收指令：AgentGetStateRet = 45301; /6-15AgentId 16-35AgentIp 36-45设置结果0成功 1失败 46-8

25、1GUID 82- 返回状态数组 例：空闲,通话,振铃前置条件：坐席签入后置条件： 二十六 b、设为监控坐席 功能描述： 可获取CTI发来的坐席状态变化等信息 发送指令：AgentSetMonitor = “40310”; /6-15AgentId 16-35AgentIp 36-71GUID 接收指令：AgentSetMonitorRet = 45311;/6-15AgentId 16-35AgentIP 36-45设置结果 0成功 1失败 46-75附加信息 76-111GUID二十六 c、请求获取坐席状态信息 功能描述： 坐席和请求获得其他坐席的状态等信息 发送指令：AgentQuery

26、AgentInfo = “40320”; /6-15AgentId 16-35AgentIp 36-45TargetAgentId 46-81GUID 接收指令：AgentQueryAgentInfoRet = 45322 /6-15AgentId 16-35AgentIP 36-45设置结果 0成功 1失败 46-75附加信息 76-111GUID 二十六 d、坐席状态改变通知 功能描述： CTI向监控设备发回坐席状态改变通知 发送指令：AgentStateChangeEvent = “45321”; /6-15AgentId 16-35AgentIp 36-45目标坐席 46-55分机号

27、56-75状态 76-95对方号码二十八、 强制挂机功能描述：质检坐席强制其他坐席挂机发送指令：AgentForceHangUp = 40400; /6-15AgentId 16-35AgentIp 36-45被挂机工号 46-81GUID接收指令：AgentForceHangUpRet = 45401; /6-15AgentId 16-35AgentIP 36-45挂机结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入后置条件：二十九、 强制签出功能描述：质检坐席可强制其他坐席签出发送指令：AgentForceLogOut = 40500; /6-15Agent

28、Id 16-35AgentIp 36-45被强制签出工号 46-81GUID接收指令：AgentForceLogOutRet = 45501; /6-15AgentId 16-35AgentIp 36-45签出结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入后置条件：三十、 发送消息功能描述：坐席可以向其他坐席发送即时消息。发送指令：AgentSendMsg = 40600; /6-15AgentId 16-35AgentIp 36-45目标坐席 46-81GUID 82- 发送消息内容接收指令：AgentSendMsgRet = 45601; /6-15Age

29、ntId 16-35AgentIp 36-45发送结果 0成功 1失败 46-75附加信息 76-111GUID前置条件：坐席签入后置条件：三十一、 收到消息功能描述：如有其他坐席向本坐席发送即时消息，坐席将收到此消息发送指令：接收指令：AgentGetMsg = 45602; /6-15AgentId 16-35AgentIp 36-45发送源 46 - 收到消息内容前置条件：坐席签入后置条件：系统部分三十二、 CTI服务器发生异常功能描述：CTI服务器如发生异常，坐席将收到此消息发送指令：接收指令：public const string CtiSystemError = 55200; /6-15AgentId 16-35AgentIp 36-65ErrMsg;前置条件：坐席签入后置条件：三十三、 进入队列功能描述：虚拟座席可将通话中的电话压入某一队列中发送指令EnQueue = 50200; /6-15AgentId 16-35AgentIp 36-55QueueId 56-91GUID接收指令EnQueueRet = 55201; /6-15AgentId 16-35AgentIp 36-45设置结果 0成功 1失败 46-75附加信息 76-111GUID前置条件座席拥有通话中的电话后置条件交换机部分功能点说明1、 分机呼叫功能描述：系统