4. 获取属性
4.1 获取SDK版本号
接口名称:getVersion()
功能:返回SDK版本号字符串,如:1.1.1.1
参数:无
返回值:无
示例:
- CallCenter.getVersion()
注意:无
4.2 获取主叫和被叫号码
接口名称:CallCenter.getCaller()
功能:返回当前通话或上次通话的主叫号码
参数:无
返回值:返回当前通话或上次通话的主叫号码
示例:
- //获取主叫号码
- CallCenter.getCaller()
注意:无
接口名称:getCalled()
功能:返回当前通话或上次通话的被叫号码
参数:无
返回值:返回当前通话或上次通话的被叫号码
示例:
- //获取被叫号码
- CallCenter.getCalled()
注意:无
4.3 是否智能外呼
接口名称:CallCenter.isAuto()
功能:获取当前通话是否为智能外呼通话
参数:无
返回值:当前是否智能外呼方式
ReturnValue | Description |
false | 非智能外呼 |
true | 智能外呼 |
示例:
- //获取当前通话是否为智能外呼
- CallCenter.isAuto()
注意:无
4.4 获取CCSWebSocket连接
接口名称:getWsurl()
功能:获取CCSWebSocket连接 getWsurl()
参数:无
返回值:连接CCS的ws地址
示例:
- CallCenter.getWsurl()
注意:无
4.5 获取企业缩写
接口名称:CallCenter.getAbbreviate()
功能:获取座席所在企业缩写
参数:无
返回值:企业简拼
示例:
- //企业座席所在企业缩写
- CallCenter.getAbbreviate()
注意:企业所写在创建企业时确定
4.6 获取座席工号
接口名称:CallCenter.getOperatorid()
功能:获取座席工号
参数:无
返回值:座席登录的工号
示例:
- CallCenter.getOperatorid()
注意:
座席工号为座席创建的数字身份标识
座席可以使用工号进行进行登录,座席登录后如果需要该数据,则可以通过该借款获取
4.7 获取座席密码
接口名称:CallCenter.getPassword()
功能:获取座席密码
参数:无
返回值:登录的密码
示例:
- //获取座席密码
- CallCenter.getPassword()
注意:无
4.8 获取媒体地址
接口名称:CallCenter. getMediaip()
功能:获取媒体地址
参数:无
返回值:注册媒体的地址
示例:
- //获取媒体的地址
- CallCenter.getMediaip()
注意:无
4.9 获取媒体端口
接口名称:CallCenter. getMediaport()
功能:获取媒体端口
参数:无
返回值:注册媒体的端口
示例:
- //获取媒体端口
- CallCenter.getMediaport()
注意:无
4.10 获取座席SIP编号
接口名称:CallCenter.getSipid()
功能:获取座席SIP编号
参数:无
返回值:座席SIP编号
示例:
- //获取座席SIP编号
- CallCenter.getSipid()
注意:无
4.11 获取SIP密码
接口名称:CallCenter.getSippwd()
功能:获取座席SIP密码
参数:无
返回值:座席SIP密码
示例:
- //获取座席SIP密码
- CallCenter.getSippwd()
注意:无
4.12 是否已经登录
接口名称:CallCenter.isLogin ()
功能:是否座席已登录
参数:无
返回值:是否座席已登录
ReturnValue | Description |
false | 未登录 |
true | 已登录 |
示例:
- //获取当前通话是否为智能外呼
- CallCenter.isLogin ()
注意:无
4.13 座席是否通话中
接口名称:CallCenter.isCalling ()
功能:获取座席是否处于通话中
参数:无
返回值:布尔值
Value | Description |
false | 非通话中 |
true | 通话中 |
示例:
- // 获取坐席是否处于通话中
- CallCenter.isCalling();
注意:通话中状态是从振铃开始的
4.14 座席是否正在外呼
接口名称:isOutbound()
功能:获取座席是否正在外呼
参数:无
返回值:布尔值
Value | Description |
false | 非外呼 |
true | 外呼 |
示例:
- // 获取坐席是否处于通话中
- CallCenter.isOutbound();
注意:无
4.15 获取坐席状态
接口名称:CallCenter.getNowStatus()
功能:获取当前坐席状态
参数:无
返回值:字符串logon/offwork/agentidle/agentbusy/after其中一种
示例:
- //获取座席状态
- CallCenter.getNowStatus()
注意:无
4.16 获取坐席事件状态
接口名称:CallCenter.getStatus()
功能:获取当前坐席状态
参数:无
返回值:座席事件状态,如:”agentbusy”
示例:
- //获取座席事件状态
- CallCenter.getStatus()
注意:座席事件状态是指座席最后一次接收服务的时间类型
4.17 获取当前状态文本
接口名称:CallCenter.getNowStatusText()
功能:获取当前电话条状态文本
参数:无
返回值:当前电话条状态文本
示例:
- //获取状态电话条状态文本
- CallCenter.getNowStatusText()
注意:无
4.18 获取最后一次忙碌类型
接口名称:CallCenter.getBusyType()
功能:获取最后一次未就绪状态码
参数:无
返回值:最后一次未就绪状态码
示例:
- // 获取最后一次未就绪状态码
- var busyTypeCode = CallCenter.getBusyType();
- // 获取最后一次未就绪状态文本
- var busyTypeText = CallCenter.getBusyTypeMap().get(busyTypeCode);
注意:无
4.19 获取未就绪状态集合
接口名称:CallCenter.getBusyTypeMap()
功能:获取未就绪状态类型集合,包括用户自定义的未就绪状态
参数:无
返回值:未就绪状态集合mapInstance ,可用key/value 遍
接口 | 返回值类型 | 返回值 |
mapInstance.containsKey(id) | Boolean | true/false ,是否存在指定未就绪状态类型 |
mapInstance.get(id) | String | 根据未就绪状态码获取状态文本 |
mapInstance.keySet() | Array | 未就绪状态状态码数组 |
mapInstance.values() | Array | 未就绪状态状态文本数组 |
mapInstance.map() | Object | 未就绪状态HashMap对象,key为状态码,value为状态文本 |
示例:
- // 获取未就绪状态集合
- var mapInstance = CallCenter. getBusyTypeMap();
- // 获取未就绪状态的状态码(含用户自定义未就绪状态码)
- var keyArray = mapInstance.keySet(); // [id,id,...]
- // 获取未就绪状态的状态文本(含用户自定义未就绪状态文本)
- var valueArray = mapInstance.values(); // [busyStr,busyStr,...]
- // 获取未就绪状态HashMap对象
- var busyMap = mapInstance.map(); // {id:busyStr,id:busyStr,...}
注意:必须在座席登录后调用
4.20 获取座席软话机类型
接口名称:CallCenter.getClientType()
功能:获取座席登录时使用的软话机类型
参数:无
返回值:当前使用的软话机类型
TypeCode | Description | remark |
1 | WebCall | |
2 | BrowserSDK | |
3 | WebSip | V3.0.1.0+版本支持 |
示例:
- //获取座席登录使用的软话机类型
- CallCenter.getClientType()
注意:无
4.21 获取通话ID
接口名称:CallCenter.getCallid()
功能:获取通话id
参数:无
返回值:当前通话的callid
示例:
- // 获取通话ID
- CallCenter.getCallid();
注意:智能在当前通话过程中获取,新的通话开始后返回值会同步更新
4.22 获取通话时间戳
接口名称:CallCenter.getTimestamp()
功能:获取当前通话时间戳
参数:无
返回值:当前通话的时间戳
示例:
- //获取通话时间戳
- CallCenter.getTimestamp()
注意:通话时间戳也是通话ID初始化时间戳
4.23 获取被操作者工号
接口名称:CallCenter.getBeOperator()
功能:获取被操作座席工号
参数:无
返回值:被操作座席工号
示例:
- //获取被操作座席工号
- CallCenter.getBeOperator()
注意:
被操作座席指班长座席进行监听、强插、拦截等操作的座席
仅班长座席进行操作后返回座席工号,非班长座席或非操作中心返回null
4.24 获取是否三方会话后再邀请咨询
接口名称:CallCenter.isLeaveConf()
功能:获取是否三方会话中被邀请方挂机
参数:无
返回值:布尔值
ReturnValue | 返回值 |
true | 三方中被邀请方挂机,可再次调用邀请接口将其它人加入三方会话(部分版本支持)。 |
false | 三方中被邀请方挂机 |
示例:
- // 三方会话被邀请方是否挂机
- CallCenter.isLeaveConf();
注意:仅三方会话时此接口有效
4.25 是否开启录屏
接口名称:CallCenter.isEnabledScreenCapture()
功能:是否开启录屏
参数:无
返回值:true或false
示例:
- CallCenter.isEnabledScreenCapture()
注意:无
4.26 是否是webRtc登录
接口名称:CallCenter.isWebRtc ()
功能:是否是webRtc登录
参数:无
返回值:true或false
示例:
- CallCenter.isWebRtc ()
注意:无
4.27 是否是webCall登录
接口名称:CallCenter.isWebCall ()
功能:是否是webCall登录
参数:无
返回值:true或false
示例:
- CallCenter.isWebCall ()
注意:无