CTI接口说明文档

1、目录1CTI接口说明31.1宏定义31.1.1坐席状态定义31.1.2坐席状态原始码定义31.1.3监控状态定义41.1.4电话工具条操作响应定义51.1.5消息通知定义51.1.6电话工具条操作命令定义61.2电话工具条操作响应格式定义61.3CTI消息通知格式定义71.4系统接口71.4.1呼叫中心业务系统与CTI通讯接口71.4.2CTI服务器与呼叫中心业务系统通讯接口71.5坐席电话工具条操作接口81.5.1坐席签入81.5.2坐席签出81.5.3检测CTI服务器是否已关闭91.5.4设置坐席状态（空闲/示忙）91.5.5呼叫101.5.6接听101.5.7挂机101.5.8保持111

2、.5.9找回111.5.10开始咨询121.5.11获取某组坐席状态121.5.12咨询内线121.5.13咨询外线131.5.14咨询某组131.5.15三方会议141.5.16事后忙/事后闲141.5.17开始监控151.5.18停止监控151.5.19监听151.5.20停止监听151.5.21强插161.5.22强拆161.5.23强制示闲171.5.24强制示忙171.5.25监控会议181.5.26停止监控会议181.5.27退出会议191.6消息通知接口191.6.1呼入通知191.6.2通话通知191.6.3内线被转移通知201.6.4呼出通知201.6.5强拆成功通知201.

3、6.6坐席呼坐席通知211.6.7咨询坐席状态通知211.6.8监控坐席状态通知211.6.9技能组信息221.6.10CTI服务器连接断开通知221.6.11只允许挂机通知221 CTI接口说明1.1 宏定义1.1.1 坐席状态定义序号代码值描述1STATE_FREE0空闲2STATE_BUSY1忙3STATE_CONF2会议4STATE_OFFLINE3离线5STATE_CALLIN4呼入6STATE_CALLOUT5呼出7STATE_CONSULT6咨询8STATE_OTHER7其他9STATE_CALLING8通话1.1.2 坐席状态原始码定义序号代码值描述1USER_IDLE0坐席示

4、闲2USER_USED1分配空闲坐席时设置为这个状态3USER_BUSY2坐席示忙/解决和头文件冲突问题4USER_LOGOUT3坐席登出5USER_LOGIN4坐席登入6USER_INIT5程序初始状态7USER_PICKUP_WAIT_DTMF_DIAL68USER_MAKECALL_TRUNK_FROM_LINKTRUNK7坐席已连接中继通道并开始并呼9USER_MAKECALL_TRUNK_FROM_WAITPICKUP8等待坐席摘机后中继外呼用户外呼内线时状态10USER_MAKECALL_USER_FROM_WAITPICKUP9等待主叫用户摘机后外呼内线11USER_MAKECA

5、LL_USER_FORM_LINKUSER10主叫用户正在进行外呼12USER_MAKECALL_USER_TO_LINKUSER11被叫内线用户处于呼叫状态双方通话中时状态13USER_TALK2_TRUNK12双方通话中时状态14USER_TALK2_TRUNKUSER1315USER_TALK2_USER1416USER_TALK2_TRUNK_ONLY_LISTEN15会议17USER_CONF_TALKING_IN_USER16原坐席加入会议,其中有一内线坐席也在会议中(会议中有咨询坐席和外线用户)18USER_CONF_TALKING_IN_TRUNK17原坐席加入会议,其中有一外

6、线坐席也在会议中(会议中有外线坐席和外线用户)19USER_CONF_TALKING_IN18咨询坐席加入会议后挂机咨询咨询内线20USER_TALKOTHER_FROM_USER_WAIT_PICKUP19开始转移时源坐席状态21USER_TALKOTHER_TO_USER_WAIT_PICKUP20转移时目的坐席摘机22USER_TALKOTHER_FROM_USER_OK21坐席和内线已连接正在咨询23USER_TALKOTHER_TO_USER_OK22目的坐席和源坐席已连接咨询外线24USER_TALKOTHER_FROM_TRUNK_WAIT_PICKUP23原来和外线通话的坐席状

7、态25USER_TALKOTHER_FROM_TRUNK_OK24坐席和外线已连接正在咨询26USER_HOLD25HOLD27USER_WAIT_HANGUP26等待挂机呼入时状态28USER_WAIT_PICKUP_TALK_2_TRUNK27坐席振铃，等待摘机同中继通话29USER_Error_State2830MAX_AGENT_STATES291.1.3 监控状态定义序号代码值描述1INITSYSTEM0初始化状态2LISTEN1监听3INSERT2强插4REMOVE3强拆5CONF4监控会议1.1.4 电话工具条操作响应定义序号代码响应码描述1LOGIN_RES600登陆响应2LO

8、GOUT_RES601登出响应3MAKECALL_RES602呼出响应4SETIDLE_RES603示闲响应5SETBUSY_RES604示忙响应6KEEP_RES605保持响应7RETURN_RES606找回响应8CONSULT_RES607咨询响应9CONFERENCE_RES608会议响应10LISTEN_RES609监听响应11STOPLISTEN_RES610停止监听响应12FORCEENTER_RES611强插响应13FORCEREMOVE_RES612强拆响应14FORCESETIDLE_RES613强制示闲响应15FORCESETBUSY_RES614强制示忙响应16HANGU

9、P_RES615挂机响应17STOPMONCONF_RES616停止监控会议响应18TRANSFER_RES617转移响应19STOPCONFERENCE_RES618退出会议响应20ENDBUSY_RES619事后忙响应21ENDIDLE_RES620事后闲响应22ANSWER_RES621接听响应1.1.5 消息通知定义序号代码通知码描述1CONSULTSTATE_NOTIFY800咨询坐席状态通知2MONITORSTATE_NOTIFY801监控状态通知3CALLALERTING_NOTIFY802呼入通知4TALKING_NOTIFY803通话通知5CALLOUT_NOTIFY804呼

10、出通知6TRANSFERSEAT_NOTIFY805内线被转移通知7FORCECUT_NOTIFY806强拆成功通知8GRPINFO_NOTIFY807技能组信息9SEATCALLSEAT_NOTIFY808坐席呼坐席10DISCONNECT_NOTIFY809CTI服务器连接断开11ONLYHANGUP_NOTIFY810只允许挂机18TRANSFER_RES617转移响应19STOPCONFERENCE_RES618退出会议响应20ENDBUSY_RES619事后忙响应21ENDIDLE_RES620事后闲响应22ANSWER_RES621接听响应1.1.6 电话工具条操作命令定义序号操作

11、命令代码描述1Login登入2Logout登出3HeartBeat检测CTI服务器是否关闭（回复“ok”表示正常）4SetIdle示闲5SetBusy示忙6MakeCall呼叫7Answer接听8Hangup挂机9Keep保持10Return找回11BeginConsult开始咨询12ConsultOutline咨询外线13ConsultInline咨询内线14ConsultGroup咨询某组15GetGrpSeatState获取某组坐席状态16Transfer转移17Conference会议18SetEndbusy事后忙19SetEndidle事后闲20BeginMonitor开始监控21S

12、topMonitor停止监控22Listen监听23StopListen停止监听24ForceEnter强插25ForceRemove强拆26ForceSetIdle强制示闲27ForceSetBusy强制示忙28MoniterConf监控会议29StopMonitorConf停止监控会议30StopConference退出会议31Intercept拦截(CTI未提供接口)1.2 电话工具条操作响应格式定义序号字段名类型长度取值备注1Actionint响应码，对应响应消息值，如1.1.4所示2AppidString公司ID3SeatNumint分机号4Retint结果（0为成功）注：以JSON

13、键值对传递,如坐席登入CTI时响应的JSON内容：Action：600，Appid：“1”，SeatNum：8001，Ret：01.3 CTI消息通知格式定义序号字段名类型长度取值备注1Actionint通知码，对应通知消息值，如1.1.5所示2AppidString公司ID3SeatNumint分机号注：以JSON键值对传递，1至3为消息通知共有的字段，其他字段根据通知类型有所不同,如呼出通知时的JSON内容：Action：804，Appid：“1”，SeatNum：8001，Caller：“8888888”，Called：，CustomId：“” 1.4 系统接口

14、1.4.1 呼叫中心业务系统与CTI通讯接口业务系统与CTI服务器是以http Post请求方式通讯，通讯格式为：http:/CTIServerIP:Port/Action?Param1=ParamValue1&Param2=ParamValue3&.参数说明：CTIServerIP：CTI服务器IP地址Port:： CTI服务器端口Action：操作命令代码，如1.1.6所示Param=ParamValue：要发送的参数数据键值对注：每次发送操作命令后如果CTI返回值为“ok”,则表示此次发送操作成功，其他信息或出错表示发送失败如坐席登录CTI服务器操作如下：http:/192.168.5.

15、246:9022/Login?Name=宾客&GrpName=售前组&AppId=31b05701-60ef-405c-87ba-af47049e3f48&JobNum=10000&Level=1&SeatNum=8001&GrpId=11.4.2 CTI服务器与呼叫中心业务系统通讯接口CTI服务器要将操作响应和通知消息传递给业务系统时是以http Post请求方式一次性发送JSON字符串进行通讯，所以呼叫中心业务系统需要对外提供一个Web服务接口或Http请求处理页。假如业务系统是用Jsp开发，提供一个HttpServlet，如：9:8080/CallCen

16、ter/CTIAgent/CTISrvCommand.svt。通过此Servlet里将JSON字条串读取出即可。如坐席登入CTI时响应的JSON内容：Action：600，Appid：“1”，SeatNum：8001，Ret：01.5 坐席电话工具条操作接口1.5.1 坐席签入注意：同一个坐席一次仅能签入一个技能组，如果一个坐席有多个技能组则每个技能组签入一次请求：Action: Login参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2JobNumint是工号3Namestring是姓名4SeatNumint是分机号5GrpIdint是技能组ID6GrpNamestr

17、ing是技能组名称7Levelint是大于0级别响应：序号字段名类型长度取值备注1Actionint600600：签入响应码 LOGOUT_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：登录成功1：数据库错误2：物理地址绑定错误3：分机错误4：坐席信息错误5：坐席认证错误6：CTI服务器错误7：已登录8：其他错误1.5.2 坐席签出请求：Action: Logout参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2JobNumint是工号3GrpIdint是要签出的技能组ID，如果为空则表示签出所有技能组响应：序号字段名类型长度

18、取值备注1Actionint601601：签出响应码 LOGOUT_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：签出成功1.5.3 检测CTI服务器是否已关闭请求：Action: HeartBeat说明：检测CTI服务器是否关闭，CTI回复“ok”则表示正常1.5.4 设置坐席状态（空闲/示忙） 请求：Action: SetIdle 示闲Action: SetBusy 示忙参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号响应：序号字段名类型长度取值备注1Actionint603 、604603：示

19、闲响应 SETIDLE_RES604：示忙响应 SETBUSY_RES2AppidString公司ID3SeatNumint分机号4Retint结果：0：示闲/示忙成功1.5.5 呼叫请求：Action: MakeCall 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3Calledstring是被叫Callerstring否主叫号码Flagint是1、21：呼外线 2：呼内线CustomIdstring否外呼任务记录ID或客户IDRelayGrpNostring否中继组标识编码响应：序号字段名类型长度取值备注1Actionint60260

20、2：呼出响应 MAKECALL_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：呼出成功1.5.6 接听 请求：Action: Answer 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号响应：序号字段名类型长度取值备注1Actionint621621：接听响应 ANSWER_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：接听成功1.5.7 挂机 请求：Action: Hangup 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2S

21、eatNumint是分机号响应：序号字段名类型长度取值备注1Actionint615615：挂机响应 HANGUP_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：挂机成功1.5.8 保持 请求：Action: Keep参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号响应：序号字段名类型长度取值备注1Actionint605605：保持响应 KEEP_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：保持成功1.5.9 找回 请求：Action: Return

22、参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号响应：序号字段名类型长度取值备注1Actionint606606：找回响应 RETURN_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：找回成功1.5.10 开始咨询 请求：Action: BeginConsult 说明：做咨询操作时要先发送“BeginConsult”命令给CTI服务器，然后CTI服务器才主动发送“GRPINFO_NOTIFY” 技能组信息通知，CTI回复“ok”则表示发送成功1.5.11 获取某组坐席状态 请求：Action: Ge

23、tGrpSeatState 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3GroupIdint是获取指定组坐席状态的技能组ID说明：要咨询某技能下指定的空闲坐席时，要先发送“GetGrpSeatState”命令给CTI服务器，然后CTI服务器才主动发送“CONSULTSTATE_NOTIFY”咨询坐席状态通知，CTI回复“ok”则表示发送成功1.5.12 咨询内线 请求：Action: ConsultInline 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3CalledString

24、是被叫坐席分机号响应：序号字段名类型长度取值备注1Actionint607607：咨询响应 CONSULT_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：咨询成功1.5.13 咨询外线 请求：Action: ConsultOutline 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3CalledString是被叫外线号码CallerString否主叫号码RelayGrpNoString否中继组标识编码响应：序号字段名类型长度取值备注1Actionint607607：咨询响应 CONSULT_RE

25、S2Appidstring公司ID3SeatNumint分机号4Retint结果：0：咨询成功1.5.14 咨询某组 请求：Action: ConsultGroup 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3GroupIdint是咨询指定技能组ID响应：序号字段名类型长度取值备注1Actionint607607：咨询响应 CONSULT_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：咨询成功1.5.15 三方会议 请求：Action: Conference 参数：序号字段名类型长度必填取值备

26、注1AppIdstring是公司ID2SeatNumint是分机号响应：序号字段名类型长度取值备注1Actionint608608：会议响应 CONFERENCE_RES2Appidstring公司ID3SeatNumint分机号4Retint结果：0：会议成功1.5.16 事后忙/事后闲 请求：Action: SetEndbusy 事后忙Action: SetEndidle 事后闲参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号响应：序号字段名类型长度取值备注1Actionint619 、 620619：事后忙响应 ENDBUSY_RES6

27、20：事后闲响应 ENDIDLE_RES2AppidString公司ID3SeatNumint分机号4Retint结果：0：成功1.5.17 开始监控请求：Action: BeginMonitor 说明：做监控操作时要先发送“BeginMonitor”命令给CTI服务器，然后CTI服务器才主动发送“MONITORSTATE_NOTIFY”监控坐席状态通知，CTI回复“ok”则表示发送成功1.5.18 停止监控请求：Action: StopMonitor 说明：关闭监控窗口后要发送“StopMonitor”命令给CTI服务器，然后CTI服务器才停止发送“GRPINFO_NOTIFY” 技能组信息

28、通知，CTI回复“ok”则表示发送成功1.5.19 监听请求：Action: Listen 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3AgentDestint是被监听分机响应：序号字段名类型长度取值备注1Actionint609609：监听响应 2Appidstring公司ID3SeatNumint分机号4Retint结果：0：成功1.5.20 停止监听请求：Action: StopListen 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3AgentDestint是被监听分机响

29、应：序号字段名类型长度取值备注1Actionint610610：停止监听响应 2Appidstring公司ID3SeatNumint分机号4Retint结果：0：成功1.5.21 强插请求：Action: ForceEnter 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3AgentDestint是被监听分机响应：序号字段名类型长度取值备注1Actionint611611：强插响应 2Appidstring公司ID3SeatNumint分机号4Retint结果：0：成功1.5.22 强拆请求：Action: ForceRemove 参数：

30、序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3AgentDestint是被监听分机响应：序号字段名类型长度取值备注1Actionint612612：强拆响应 2Appidstring公司ID3SeatNumint分机号4Retint结果：0：成功1.5.23 强制示闲请求：Action: ForceSetIdle 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3AgentDestint是被监听分机响应：序号字段名类型长度取值备注1Actionint613613：强制示闲响应 2Appidst

31、ring公司ID3SeatNumint分机号4Retint结果：0：成功1.5.24 强制示忙请求：Action: ForceSetBusy 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3AgentDestint是被监听分机响应：序号字段名类型长度取值备注1Actionint614614：强制示忙响应 2Appidstring公司ID3SeatNumint分机号4Retint结果：0：成功1.5.25 监控会议请求：Action: MoniterConf 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNu

32、mint是分机号3AgentDestint是被监听分机响应：序号字段名类型长度取值备注1Actionint608608：会议响应 2Appidstring公司ID3SeatNumint分机号4Retint结果：0：成功1.5.26 停止监控会议请求：Action: StopMonitorConf 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3AgentDestint是被监听分机响应：序号字段名类型长度取值备注1Actionint616616：停止监控会议响应 2Appidstring公司ID3SeatNumint分机号4Retint结果：

33、0：成功1.5.27 退出会议请求：Action: StopConference 参数：序号字段名类型长度必填取值备注1AppIdstring是公司ID2SeatNumint是分机号3AgentDestint是被监听分机响应：序号字段名类型长度取值备注1Actionint618618：退出会议响应 2Appidstring公司ID3SeatNumint分机号4Retint结果：0：成功1.6 消息通知接口1.6.1 呼入通知Action: CALLALERTING_NOTIFYJSON内容：序号字段名类型长度取值备注1Actionint802802：呼入通知 2Appidstring公司ID3

34、SeatNumint分机号4CallIdstring呼叫ID5Callerstring主叫6Calledstring被叫7CustomIdstring客户ID(外呼任务清单ID)8GrpIdint队列ID（技能组ID）1.6.2 通话通知Action: TALKING_NOTIFYJSON内容：序号字段名类型长度取值备注1Actionint803803：通话通知 2Appidstring公司ID3SeatNumint分机号4CallIdstring呼叫ID5Callerstring主叫6Calledstring被叫7CustomIdstring客户ID(外呼任务清单ID)8GrpIdint队列

35、ID（技能组ID）1.6.3 内线被转移通知Action: TRANSFERSEAT_NOTIFYJSON内容：序号字段名类型长度取值备注1Actionint805805：内线被转移通知 2Appidstring公司ID3SeatNumint分机号4CallIdstring呼叫ID5Callerstring主叫6Calledstring被叫7CustomIdstring客户ID(外呼任务清单ID)8GrpIdint队列ID（技能组ID）1.6.4 呼出通知Action: CALLOUT_NOTIFYJSON内容：序号字段名类型长度取值备注1Actionint804804：呼出通知 2Appidstring公司ID3SeatNumint分机号4CallIdstring呼叫ID5Callerstring主叫6Calledstring被叫7CustomIdstring客户