-
Enums
- Enumeration: CdtPhoneState
- Enumeration: MsgCatalog
- Enumeration: MsgTypes
- Enumeration: PhoneCallState
- Enumeration: AdmObjTypes
- Enumeration: AdmOpTypes
- Enumeration: CallLogCatalog
- Enumeration: CdtFunction
- Enumeration: CdtOpTypes
- Enumeration: ExtPageName
- Enumeration: ExtPageType
- Enumeration: HotkeyType
- Enumeration: HuntCallMode
- Enumeration: ListMode
- Enumeration: LoginEvtTypes
- Enumeration: ObjectType
- Enumeration: Operation
- Enumeration: PeerNumberType
- Enumeration: RoleRightId
- Interfaces
-
ufpdsapi
- Table of contents
- Type Aliases
- Variables
-
Functions
- admLoginLogsQuery
- admOpLogsQuery
- cdGroupRingLoad
- cdGroupRingSave
- cdtLoginLogsQuery
- cdtOpLogsQuery
- clusterStatusPoll
- cstaSwitchStatusPoll
- downloadCdrGeneral
- getServerAddress
- hotKeyPageFavoriteLoad
- hotKeyPageFavoriteSave
- hotKeysExport
- hotKeysImport
- keepalive
- login
- loginByToken
- logout
- mapHotKeyMarkAdd
- mapHotKeyMarkRemove
- mapHotKeyMarksLoad
- mapZoneMarkAdd
- mapZoneMarkRemove
- mapZoneMarkUpdate
- mapZoneMarksLoad
- objLoad
- objectAdd
- objectList
- objectOperation
- objectPollState
- objectUpdate
- queryCdUsers
- queryCdr
- queryCdrGeneral
- queryCdrSummary
- queryUserCdGroups
- setServerAddress
- sqlQuery
- systemStateSummaryPoll
- userSetPassword
- Modules
ccu.CdtPhoneState
调度话机调度状态定义
• Conference
多方会议
• GroupIn
组来话
• Hunt
组寻线
• Intrude
强插
• Monitor
监听
• PhoneMonitor
通话监控
ccu.MsgCatalog
协议消息分类
• Event
事件消息
• Request
请求消息
• Response
响应消息
ccu.MsgTypes
协议消息类型ID
- CmdAnswerCall
- CmdCdGroupOffHourForwardSet
- CmdCdtPhoneAlt
- CmdCdtPhoneHook
- CmdCdtPhoneSelect
- CmdDialDTMF
- CmdDialNumber
- CmdFuncBtnClick
- CmdGetCCUVer
- CmdHotKeyClick
- CmdHotKeyMapClose
- CmdHotKeyMapOpen
- CmdInstantMeetKeepCalling
- CmdInstantMeetPartyBye
- CmdInstantMeetPartyInvite
- CmdInstantMeetPartyListen
- CmdInstantMeetPartyRmv
- CmdInstantMeetPartySpeak
- CmdInstantMeetingLoad
- CmdKeepAlive
- CmdLoadActiveHotKeyPage
- CmdLoadCdtDevice
- CmdLoadCommonFunc
- CmdLoadExtPages
- CmdLoadFuncPage
- CmdLoadMainHotKeyPages
- CmdResumeCall
- CmdSearchHotKeys
- CmdSetCdGroupForwarding
- CmdSetForwarding
- CmdSetHuntGroupForward
- EvtCdGroupForwarding
- EvtCdGroupNameUpdate
- EvtCdGroupOffHourForwardUpdate
- EvtCdtPhoneSelected
- EvtCdtPhoneState
- EvtExtPageUpdate
- EvtFuncKeyState
- EvtHeldCalls
- EvtHotKeyDel
- EvtHotKeyPageDel
- EvtHotKeyPageUpdate
- EvtHotKeyState
- EvtHotKeyUpdate
- EvtHuntGroupForwardUpdate
- EvtIncomingCalls
- EvtInstantMeetPartyCallState
- EvtMainHotKeyPagesUpdate
- EvtShutDown
- EvtUpdateCdtDevice
- EvtUpdateCommonFunc
- EvtUpdateFuncPage
- EvtUserNameUpdate
- RespApiObjID
- RespError
- RespOK
• CmdAnswerCall
• CmdCdGroupOffHourForwardSet
• CmdCdtPhoneAlt
• CmdCdtPhoneHook
• CmdCdtPhoneSelect
• CmdDialDTMF
• CmdDialNumber
• CmdFuncBtnClick
• CmdGetCCUVer
• CmdHotKeyClick
• CmdHotKeyMapClose
• CmdHotKeyMapOpen
• CmdInstantMeetKeepCalling
• CmdInstantMeetPartyBye
• CmdInstantMeetPartyInvite
• CmdInstantMeetPartyListen
• CmdInstantMeetPartyRmv
• CmdInstantMeetPartySpeak
• CmdInstantMeetingLoad
• CmdKeepAlive
• CmdLoadActiveHotKeyPage
• CmdLoadCdtDevice
• CmdLoadCommonFunc
• CmdLoadExtPages
• CmdLoadFuncPage
• CmdLoadMainHotKeyPages
• CmdResumeCall
• CmdSearchHotKeys
• CmdSetCdGroupForwarding
• CmdSetForwarding
• CmdSetHuntGroupForward
• EvtCdGroupForwarding
登录工作组离席转移设置
• EvtCdGroupNameUpdate
工作组名称更新事件
• EvtCdGroupOffHourForwardUpdate
工作组值班电话更新事件
• EvtCdtPhoneSelected
当前键权话机选择事件
• EvtCdtPhoneState
调度话机状态事件
• EvtExtPageUpdate
扩展页配置更新事件
• EvtFuncKeyState
功能键状态事件
• EvtHeldCalls
工作组保持通话队列事件
• EvtHotKeyDel
热键删除事件
• EvtHotKeyPageDel
热键页删除事件
• EvtHotKeyPageUpdate
热键页更新事件
• EvtHotKeyState
热键状态事件
• EvtHotKeyUpdate
热键配置更新事件
• EvtHuntGroupForwardUpdate
寻线组转移设置更新事件
• EvtIncomingCalls
工作组来话队列事件
• EvtInstantMeetPartyCallState
即时会议成员呼叫状态更新事件
• EvtMainHotKeyPagesUpdate
一级热键页配置更新事件
• EvtShutDown
服务器关闭调度台连接事件
• EvtUpdateCdtDevice
调度话机配置更新事件
• EvtUpdateCommonFunc
常用功能键更新事件
• EvtUpdateFuncPage
功能页更新事件
• EvtUserNameUpdate
调度用户名称更新事件
• RespApiObjID
• RespError
• RespOK
ccu.PhoneCallState
话机通话状态
• Alert
振铃中
• Connected
通话中
• Failed
失败
• Idle
空闲
• Offline
离线
• Proceeding
正在呼叫中
mtypes.AdmObjTypes
后台管理操作对象分类值定义
• CdGroup
调度工作组
• CdtDevice
调度台终端设备
• HotKey
热键
• HotKeyPage
热键页
• Role
用户角色
• User
用户账号
mtypes.AdmOpTypes
后台管理操作类型值定义
• Create
新增
• Disable
禁用
• Enable
启用
• Remove
删除
• Update
修改
mtypes.CallLogCatalog
通话记录分类值定义
• Conference
会议呼叫
• Emergency
紧急
• Hunt
组寻线呼叫
• Normal
普通
• VIP
非常重要
• WGIncom
组来话
mtypes.CdtFunction
调度台操作功能键值定义
- AtdTransfer
- CdGroupForward
- Conference
- Consult
- DialPad
- ExternalApp
- ForceInvite
- HoldOn
- HuntBurst
- HuntGroupForward
- HuntLoop
- Intrude
- Monitor
- MuteRing
- PTT
- Pickup
- PickupDesignated
- ReDial
- Reset
- Tear
- TransferSingleStep
- UCForward
- UILock
• AtdTransfer
咨询转移
• CdGroupForward
工作组离席转移
• Conference
多方会议
• Consult
咨询
• DialPad
拨号盘
• ExternalApp
外部应用
• ForceInvite
强呼
• HoldOn
通话保持
• HuntBurst
群振
• HuntGroupForward
寻线组号码转移
• HuntLoop
轮呼
• Intrude
强插
• Monitor
监听
• MuteRing
闭铃
• PTT
对讲频道占用(push to talk)
• Pickup
组代接
• PickupDesignated
代接
• ReDial
重拨
• Reset
终端复位
• Tear
强拆
• TransferSingleStep
通话转接
• UCForward
无条件转移
• UILock
界面锁定
mtypes.CdtOpTypes
调度台操作类型值定义
- AltCall
- AnswerGroupInCom
- AtdTransfer
- CdtPhoneHook
- CdtPhoneSelect
- DialNumber
- ForceInvite
- FuncKeyClick
- GroupResumeCall
- HotKeyClick
- Intrude
- Monitor
- MuteRing
- Pickup
- SetCdGroupForwarding
- SetUCTransfer
- Tear
- Transfer
• AltCall
调度话机通话切换按键
• AnswerGroupInCom
接听组来话
• AtdTransfer
咨询通话切换
• CdtPhoneHook
调度话机(摘/挂机)按键操作
• CdtPhoneSelect
调度话机键权选择
• DialNumber
拨号
• ForceInvite
强呼
• FuncKeyClick
功能键选择
• GroupResumeCall
恢复组保持通话
• HotKeyClick
热键操作
• Intrude
强插
• Monitor
监听
• MuteRing
组来话闭铃
• Pickup
代接
• SetCdGroupForwarding
设置组离位转移
• SetUCTransfer
设置无条件转移
• Tear
强拆
• Transfer
通话盲转
mtypes.ExtPageName
扩展功能页名称列表
• CDR
• Conference
• Config
• FavoritePage
• FuncPage
• GeneralQuery
• MAP
• SMS
• TBC
• VConference
mtypes.ExtPageType
扩展功能页类型值定义
• CDR
通话记录
• Conference
语音会议系统
• Config
系统配置
• FavoritePage
个性页
• FuncPage
功能键页
• GeneralQuery
综合查询页
• MAP
图形化调度
• SMS
短信通知
• TBC
预案语音广播
• VConference
视频会议系统
mtypes.HotkeyType
热键类型定义
• camera
摄像头
• cdGroup
工作组
• cdOperator
调度员用户，呼叫其登录调度台绑定话机
• direct
直拨号码(注册到CSTA交换机,支持强插、强拆)
• huntGroup
铃组(多号码轮呼,群振)
• inner
内部号码(注册到调度服务器,支持强插、强拆)
• meetGroup
会议组
• speedDial
速拨号码(外线,支持一键拨号)
• subPage
热键子页
mtypes.HuntCallMode
寻线组号码呼叫模式
• Burst
群振铃
• RoundRobin
轮转呼叫
• Sequence
顺序呼叫
mtypes.ListMode
名单模式
• Blacklist
黑名单
• Whitelist
白名单
mtypes.LoginEvtTypes
用户登录事件值定义
• Login
登录
• LoginFail
登录失败
• Logout
登出
• SessionDown
会话异常中断
mtypes.ObjectType
管理对象类型定义
• CdGroup
调度工作组
• CdtDevice
调度台终端设备
• HotKey
热键
• HotKeyPage
热键页
• Role
用户角色
• User
用户账号
mtypes.Operation
管理对象操作定义
• Del
删除
• Disable
禁用
• Enable
启用
• Reset
重置
mtypes.PeerNumberType
通话对方号码类型
• Internal
内线
• International
国际长途电话
• Local
市话
• Toll
国内长途电话
mtypes.RoleRightId
用户角色权限定义
- CdGroups_add
- CdGroups_belongConfig
- CdGroups_del
- CdGroups_login
- CdGroups_query
- CdGroups_update
- CdtDevices_add
- CdtDevices_del
- CdtDevices_query
- CdtDevices_update
- ConferenceSystem_admin
- ConferenceSystem_log_query
- ConferenceSystem_rec_query
- ConferenceSystem_service
- GeneralQuery
- GeneralQuery_EContacts
- GeneralQuery_Normal
- GeneralQuery_OA
- HotKeyPages_add
- HotKeyPages_del
- HotKeyPages_favorite
- HotKeyPages_query
- HotKeyPages_update
- HotKeys_add
- HotKeys_del
- HotKeys_query
- HotKeys_update
- MAP_admin
- MAP_dispatch
- Radio_admin
- Radio_dispatch
- RecordSystem_admin
- RecordSystem_recordDownload
- RecordSystem_recordPlayback
- RecordSystem_recordQuery
- Roles_admin
- Roles_query
- SMS_admin
- SMS_bcTask_add
- SMS_bcTask_del
- SMS_bcTask_query
- SysConfig_query
- SysConfig_update
- TBCSystem_admin
- TBCSystem_log_query
- TBCSystem_reassign
- TBCSystem_service
- TBCSystem_template
- Users_add
- Users_del
- Users_query
- Users_update
- VConferenceSystem_admin
- VConferenceSystem_log_query
- VConferenceSystem_rec_query
- VConferenceSystem_service
• CdGroups_add
• CdGroups_belongConfig
• CdGroups_del
• CdGroups_login
• CdGroups_query
• CdGroups_update
• CdtDevices_add
• CdtDevices_del
• CdtDevices_query
• CdtDevices_update
• ConferenceSystem_admin
• ConferenceSystem_log_query
• ConferenceSystem_rec_query
• ConferenceSystem_service
• GeneralQuery
• GeneralQuery_EContacts
• GeneralQuery_Normal
• GeneralQuery_OA
• HotKeyPages_add
• HotKeyPages_del
• HotKeyPages_favorite
• HotKeyPages_query
• HotKeyPages_update
• HotKeys_add
• HotKeys_del
• HotKeys_query
• HotKeys_update
• MAP_admin
• MAP_dispatch
• Radio_admin
• Radio_dispatch
• RecordSystem_admin
• RecordSystem_recordDownload
• RecordSystem_recordPlayback
• RecordSystem_recordQuery
• Roles_admin
• Roles_query
• SMS_admin
• SMS_bcTask_add
• SMS_bcTask_del
• SMS_bcTask_query
• SysConfig_query
• SysConfig_update
• TBCSystem_admin
• TBCSystem_log_query
• TBCSystem_reassign
• TBCSystem_service
• TBCSystem_template
• Users_add
• Users_del
• Users_query
• Users_update
• VConferenceSystem_admin
• VConferenceSystem_log_query
• VConferenceSystem_rec_query
• VConferenceSystem_service
mtypes.CameraProfile
摄像头配置
• audio: boolean
是否支持语音喊话
• intercom: boolean
是否支持语音对讲
• ptz: boolean
是否支持云台控制
mtypes.HotKeyNumberItem
热键号码项
• hasVideo: boolean
是否视频终端
• Optional hkey: number
• Optional nName: string
号码名称
• number: string
电话号码
• outGoPrefix: string
呼出前缀
• priority: number
优先级别
- admLoginLogsQuery
- admOpLogsQuery
- cdGroupRingLoad
- cdGroupRingSave
- cdtLoginLogsQuery
- cdtOpLogsQuery
- clusterStatusPoll
- cstaSwitchStatusPoll
- downloadCdrGeneral
- getServerAddress
- hotKeyPageFavoriteLoad
- hotKeyPageFavoriteSave
- hotKeysExport
- hotKeysImport
- keepalive
- login
- loginByToken
- logout
- mapHotKeyMarkAdd
- mapHotKeyMarkRemove
- mapHotKeyMarksLoad
- mapZoneMarkAdd
- mapZoneMarkRemove
- mapZoneMarkUpdate
- mapZoneMarksLoad
- objLoad
- objectAdd
- objectList
- objectOperation
- objectPollState
- objectUpdate
- queryCdUsers
- queryCdr
- queryCdrGeneral
- queryCdrSummary
- queryUserCdGroups
- setServerAddress
- sqlQuery
- systemStateSummaryPoll
- userSetPassword
Ƭ Session: Object
终端登录会话状态数据结构
| Name | Type | Description |
|---|---|---|
administrator |
boolean |
登录用户是否管理员 |
auth_id |
string |
登录认证成功后返回的会话ID |
errMsg |
string |
服务器最近返回错误信息 |
inProgress |
boolean |
是否正在登录 |
lastRequestIndex |
number |
最近发送请求序号 |
pwd |
string |
用户登录密码 |
rights |
{ [key: string]: boolean; } |
登录用户操作权限集合 |
userId |
string |
用户状态 |
userName |
string |
用户名称 |
• Const sess: Session
共享会话信息对象
▸ admLoginLogsQuery(offset, rows, startTime, endTime, filter): Promise<{ items: AdmLoginLog[] ; total: number }>
后台管理登录日志查询
| Name | Type | Description |
|---|---|---|
offset |
number |
结果偏移量 |
rows |
number |
结果限制行数 |
startTime |
undefined | string
|
开始时间 |
endTime |
undefined | string
|
结束时间 |
filter |
undefined | string
|
查询过滤条件SQL表达式 |
Promise<{ items: AdmLoginLog[] ; total: number }>
满足查询条件记录总数及指定偏移量、限定行数的日志记录列表
▸ admOpLogsQuery(offset, rows, startTime, endTime, filter): Promise<{ items: AdmOpLog[] ; total: number }>
后台维护管理日志查询
| Name | Type | Description |
|---|---|---|
offset |
number |
结果偏移量 |
rows |
number |
结果限制行数 |
startTime |
undefined | string
|
开始时间 |
endTime |
undefined | string
|
结束时间 |
filter |
undefined | string
|
查询过滤条件SQL表达式 |
Promise<{ items: AdmOpLog[] ; total: number }>
满足查询条件记录总数及指定偏移量、限定行数的日志记录列表
▸ cdGroupRingLoad(cdGroup): Promise<CdGroupRing>
加载工作组振铃组配置
| Name | Type | Description |
|---|---|---|
cdGroup |
number |
工作组ID |
Promise<CdGroupRing>
振铃顺序用户账号及名称列表CdGroupRing
▸ cdGroupRingSave(cdGroup, users): Promise<void>
保存工作组振铃组配置
| Name | Type | Description |
|---|---|---|
cdGroup |
number |
工作组ID |
users |
string[] |
振铃顺序用户账号列表 |
Promise<void>
▸ cdtLoginLogsQuery(offset, rows, startTime, endTime, filter): Promise<{ items: CdtLoginLog[] ; total: number }>
调度台登录日志查询
| Name | Type | Description |
|---|---|---|
offset |
number |
结果偏移量 |
rows |
number |
结果限制行数 |
startTime |
undefined | string
|
开始时间 |
endTime |
undefined | string
|
结束时间 |
filter |
undefined | string
|
查询过滤条件SQL表达式 |
Promise<{ items: CdtLoginLog[] ; total: number }>
满足查询条件记录总数及指定偏移量、限定行数的日志记录列表
▸ cdtOpLogsQuery(offset, rows, startTime, endTime, filter): Promise<{ items: CdtOpLog[] ; total: number }>
调度台操作日志查询
| Name | Type | Description |
|---|---|---|
offset |
number |
结果偏移量 |
rows |
number |
结果限制行数 |
startTime |
undefined | string
|
开始时间 |
endTime |
undefined | string
|
结束时间 |
filter |
undefined | string
|
查询过滤条件SQL表达式 |
Promise<{ items: CdtOpLog[] ; total: number }>
满足查询条件记录总数及指定偏移量、限定行数的日志记录列表
▸ clusterStatusPoll(): Promise<ClusterStatus>
轮询双机热备集群状态
Promise<ClusterStatus>
状态数据结构ClusterStatus
▸ cstaSwitchStatusPoll(): Promise<CSTALinkStatus>
轮询CSTA交换机状态
Promise<CSTALinkStatus>
mtypes.CSTASwitchStatus
▸ downloadCdrGeneral(startTime, endTime, filter?): Promise<string>
后台下载通话记录csv文件格式
| Name | Type | Description |
|---|---|---|
startTime |
string |
开始时间 |
endTime |
string |
结束时间 |
filter? |
string |
查询过滤条件SQL表达式 |
Promise<string>
文件URL数据对象
▸ getServerAddress(): Object
Object
服务器地址 {hostAddr,ssl}
| Name | Type |
|---|---|
hostAddr |
string |
ssl |
boolean |
▸ hotKeyPageFavoriteLoad(): Promise<HotKeyPageConfig>
加载登录用户个性化热键页
Promise<HotKeyPageConfig>
▸ hotKeyPageFavoriteSave(config): Promise<void>
保存登录用户个性化热键页
| Name | Type | Description |
|---|---|---|
config |
HotKeyPageConfig |
热键页配置数据结构HotKeyPageConfig |
Promise<void>
▸ hotKeysExport(ids?): void
导出热键配置数据到csv格式文件
| Name | Type | Description |
|---|---|---|
ids? |
number[] |
热键ID列表,可选参数,不带参数将导出所有热键 |
void
▸ hotKeysImport(file): Promise<any>
导入热键配置csv格式文件
| Name | Type | Description |
|---|---|---|
file |
any |
文件对象 |
Promise<any>
成功导入热键数量
▸ keepalive(): Promise<void>
会话心跳保持
Promise<void>
无
▸ login(acc, password, onSessionDown?): Promise<undefined | Session>
登录服务器后台
| Name | Type | Description |
|---|---|---|
acc |
string |
登录账号 |
password |
string |
登录密码 |
onSessionDown? |
(e: { result: string ; resultComment: string }) => void
|
会话中断回调事件函数 |
Promise<undefined | Session>
会话数据结构
▸ loginByToken(token, onSessionDown?): Promise<undefined | Session>
通过单点认证平台登录调度服务器后台
| Name | Type | Description |
|---|---|---|
token |
string |
单点认证平台返回的令牌 |
onSessionDown? |
(e: { result: string ; resultComment: string }) => void
|
会话中断回调事件函数 |
Promise<undefined | Session>
会话数据结构
▸ logout(): void
登出系统
void
无
▸ mapHotKeyMarkAdd(mark): Promise<void>
添加图形化调度热键标注点
| Name | Type | Description |
|---|---|---|
mark |
MapHotKeyMark |
热键标注点数据MapHotKeyMark |
Promise<void>
▸ mapHotKeyMarkRemove(id): Promise<void>
删除图形化调度热键标注点
| Name | Type | Description |
|---|---|---|
id |
number |
热键ID |
Promise<void>
▸ mapHotKeyMarksLoad(): Promise<MapHotKeyMarkSet>
加载图形化调度热键标注映射表
Promise<MapHotKeyMarkSet>
热键标注映射表MapHotKeyMarkSet
▸ mapZoneMarkAdd(mark): Promise<void>
添加图形化调度区域标注
| Name | Type | Description |
|---|---|---|
mark |
MapZoneMark |
区域标注数据MapZoneMark |
Promise<void>
▸ mapZoneMarkRemove(name): Promise<void>
删除图形化调度区域标注
| Name | Type | Description |
|---|---|---|
name |
string |
区域名称 |
Promise<void>
▸ mapZoneMarkUpdate(mark): Promise<void>
更新图形化调度区域标注
| Name | Type | Description |
|---|---|---|
mark |
MapZoneMark |
区域标注数据MapZoneMark |
Promise<void>
▸ mapZoneMarksLoad(): Promise<MapZoneMarkSet>
加载图形化调度区域标注映射表
Promise<MapZoneMarkSet>
区域标注映射表MapZoneMarkSet
▸ objLoad(id, ot): Promise<any>
加载管理对象配置
| Name | Type | Description |
|---|---|---|
id |
string | number
|
对象ID |
ot |
ObjectType |
对象类型 |
Promise<any>
对象配置数据
▸ objectAdd(ot, cfg): Promise<any>
新增管理对象
| Name | Type | Description |
|---|---|---|
ot |
ObjectType |
对象类型 |
cfg |
any |
对象配置数据 |
Promise<any>
新增对象ID
▸ objectList(ot, offset, rows, filter?): Promise<any>
配置数据对象列表查询
| Name | Type | Description |
|---|---|---|
ot |
ObjectType |
对象类型 |
offset |
number |
结果起始偏移 |
rows |
number |
结果行数 |
filter? |
string |
查询过滤条件字符串(sql表达式) |
Promise<any>
▸ objectOperation(ids, ot, op): Promise<void>
管理对象批量操作
| Name | Type | Description |
|---|---|---|
ids |
(string | number)[] |
管理对象ID列表 |
ot |
ObjectType |
对象类型 |
op |
Operation |
操作类型 |
Promise<void>
▸ objectPollState(ot, ids): Promise<any>
轮询管理对象状态
| Name | Type | Description |
|---|---|---|
ot |
ObjectType |
管理对象类型 |
ids |
(string | number)[] |
管理对象ID列表 |
Promise<any>
对象ID到对象实时状态的映射表
▸ objectUpdate(ids, ot, cfg): Promise<void>
批量更新管理对象配置
| Name | Type | Description |
|---|---|---|
ids |
(string | number)[] |
管理对象ID列表 |
ot |
ObjectType |
管理对象类型 |
cfg |
any |
管理对象配置数据 |
Promise<void>
▸ queryCdUsers(): Promise<any>
查询列表已启用调度功能用户
Promise<any>
调度用户列表
▸ queryCdr(startTime, endTime, offset, rows, catalog, outgo, cdtDevice, cdGroup, userSelf, connected, peerName, peerNumber): Promise<{ items: CdrRow[] ; total: number }>
调度台通话记录查询
| Name | Type | Description |
|---|---|---|
startTime |
string |
起始时间 |
endTime |
string |
结束时间 |
offset |
number |
结果起始偏移量 |
rows |
number |
查询返回记录行数 |
catalog |
undefined | CallLogCatalog
|
通话类别 |
outgo |
undefined | boolean
|
是否呼出 |
cdtDevice |
undefined | string
|
终端设备ID或名称、索引模糊查询过滤字符串 |
cdGroup |
undefined | number
|
工作组名称、索引模糊查询过滤字符串 |
userSelf |
undefined | boolean
|
是否只返回当前用户通话记录 |
connected |
undefined | boolean
|
是否只范围已接通通话记录 |
peerName |
string |
通话对方名称或索引模糊查询过滤字符串 |
peerNumber |
string |
通话对方号码模糊查询过滤字符串 |
Promise<{ items: CdrRow[] ; total: number }>
满足查询条件通话记录总数量,及指定偏移量及行数的通话记录列表
▸ queryCdrGeneral(startTime, endTime, offset, rows, filter?): Promise<{ items: CdrRowGeneral[] ; total: number }>
管理后台查询通话记录
| Name | Type | Description |
|---|---|---|
startTime |
string |
开始时间 |
endTime |
string |
结束时间 |
offset |
number |
返回结果偏移量 |
rows |
number |
返回结果最大行数 |
filter? |
string |
查询过滤条件,SQL表达式 |
Promise<{ items: CdrRowGeneral[] ; total: number }>
满足条件的通话记录总数,及指定偏移及行数的通话记录列表
▸ queryCdrSummary(startTime, endTime, cdtDevice, cdGroup, userSelf, peerName, peerNumber): Promise<CdrSummary>
调度台通话记录统计数据查询
| Name | Type | Description |
|---|---|---|
startTime |
string |
起始时间 |
endTime |
string |
结束时间 |
cdtDevice |
undefined | string
|
终端设备ID或名称、索引模糊查询过滤字符串 |
cdGroup |
undefined | number
|
工作组名称、索引模糊查询过滤字符串 |
userSelf |
undefined | boolean
|
是否只返回当前用户通话记录 |
peerName |
string |
通话对方名称或索引模糊查询过滤字符串 |
peerNumber |
string |
通话对方号码模糊查询过滤字符串 |
Promise<CdrSummary>
统计数据 CdrSummary
▸ queryUserCdGroups(userId): Promise<any>
查询列表特定用户可登录工作组
| Name | Type | Description |
|---|---|---|
userId |
string |
用户登录ID |
Promise<any>
工作组列表
▸ setServerAddress(hostAddr, ssl): void
初始化服务器URL地址
| Name | Type | Description |
|---|---|---|
hostAddr |
string |
服务器IP地址:端口,例如192.168.1.88:3000 |
ssl |
boolean |
是否采用SSL加密协议 |
void
▸ sqlQuery(stmt): Promise<any>
通用系统数据库查询
| Name | Type | Description |
|---|---|---|
stmt |
string |
sql查询语句 |
Promise<any>
查询结果记录数组
▸ systemStateSummaryPoll(): Promise<SystemStateSummary>
系统运行状态轮询
Promise<SystemStateSummary>
系统运行状态,数据结构参考SystemStateSummary
▸ userSetPassword(oldPass, newPass): Promise<void>
设置当前用户登录密码
| Name | Type | Description |
|---|---|---|
oldPass |
string |
原密码 |
newPass |
string |
新密码 |
Promise<void>
- CdGroupForwardState
- CdtDeviceConfig
- CdtPhoneStates
- CommonFuncLayout
- DirectKeyState
- ExtPageLayout
- FuncKey
- FuncKeyLayout
- FuncPageLayout
- HotKeyConfig
- HotPageLayout
- InstantMeetingParty
- InstantMeetingState
- MainHotPageItem
- MainHotPages
- Message
- QueuedCall
- answerCall
- cdtPhoneAlt
- cdtPhoneHook
- cdtPhoneSelect
- dialDTMF
- dialNumber
- funcBtnClick
- getVersion
- hotKeyClick
- hotKeyMapClose
- hotKeyMapOpen
- instantMeetKeepCalling
- instantMeetLoad
- instantMeetPartyBye
- instantMeetPartyInvite
- instantMeetPartyListen
- instantMeetPartyRemove
- instantMeetPartySpeak
- loadActiveHotKeyPage
- loadCdtDevice
- loadCommonFunc
- loadExtPages
- loadFuncPage
- loadMainHotKeyPages
- resumeCall
- searchHotKeys
- setCdGroupForwarding
- setForwarding
- setHuntGroupForward
- setOffHourForwarding
Ƭ CdGroupForwardState: Object
工作组离位转移设置状态
| Name | Type | Description |
|---|---|---|
enabled |
boolean |
是否启用前转 |
forward |
string |
绑定话机前转电话号码,未定义表示未设置转移 |
users |
{ [userId: string]: { enabled: boolean ; name: string }; } |
组归属用户转移启用映射表 |
Ƭ CdtDeviceConfig: Object
调度终端设备配置
| Name | Type | Description |
|---|---|---|
leftPhones |
{ name: string ; number: string }[] |
左话机配置,支持多个列表 |
name |
string |
设备名称 |
rightPhones |
{ name: string ; number: string }[] |
右话机配置,支持多个列表 |
webPhone? |
{ number: string ; password: string ; useAudio: boolean } |
网页软电话配置 |
webPhone.number |
string |
电话号码 |
webPhone.password |
string |
登录注册密码 |
webPhone.useAudio |
boolean |
是否启用视频 |
Ƭ CdtPhoneStates: Object
调度话机复合状态数据结构
| Name | Type | Description |
|---|---|---|
alertMuted |
boolean |
是否组来话闭铃 |
burst? |
boolean |
组寻线时是否群振铃(否则是轮呼) |
callState? |
PhoneCallState |
通话状态 |
forwarding? |
{ [forwardType: string]: string; } |
来话呼叫转移设置 |
helds |
{ callID: string ; nameAndNumber: string }[] |
保持中通话列表 |
hotlineName |
string |
来话热线名称 |
isCaller? |
boolean |
是否主叫 |
onHold? |
boolean |
是否被保持 |
peerHotKeys |
{ [key: string]: { callState: PhoneCallState ; number?: string ; onHold?: boolean }; } |
通话对方热键映射表 |
peers |
{ name: string ; number: string }[] |
通话对方号码及名称列表 |
state |
CdtPhoneState |
调度状态 |
Ƭ CommonFuncLayout: FuncKeyLayout
常用功能布局
Ƭ DirectKeyState: Object
直拨类型热键监控状态
| Name | Type | Description |
|---|---|---|
callState |
PhoneCallState |
通话状态 |
isCaller? |
boolean |
是否主叫 |
onHold? |
boolean |
是否被保持 |
peerNames? |
string[] |
对方名称号码 |
Ƭ ExtPageLayout: Object
扩展页布局数据结构
| Name | Type | Description |
|---|---|---|
pages |
{ Type: ExtPageType ; name: string }[] |
扩展页列表 |
visibleSize |
number |
TAB页可见扩展页数量 |
Ƭ FuncKey: Object
功能键配置项
| Name | Type | Description |
|---|---|---|
funcID |
number |
功能键ID |
name |
string |
功能键名称 |
Ƭ FuncKeyLayout: Object
功能键页面布局
| Name | Type | Description |
|---|---|---|
fontSize |
number |
文字尺寸 |
keys |
((FuncKey | null)[] | null)[] |
功能键ID二维数组,按行x列布局,某行列未配置功能键时,取值null,整行未配置功能键时,行取值null |
Ƭ FuncPageLayout: FuncKeyLayout
功能页布局
Ƭ HotKeyConfig: Object
热键配置数据结构
| Name | Type | Description |
|---|---|---|
color? |
string |
字体颜色 |
fontBold |
boolean |
是否粗体 |
fontItalic |
boolean |
是否斜体 |
fontSize |
number |
字体大小 |
fontUnderline |
boolean |
是否加下划线 |
hasVideo |
boolean |
是否视频终端 |
id? |
number |
热键ID |
name |
string |
热键名称 |
namesOfNumber? |
(string | undefined)[] |
号码名称列表 |
numbers? |
string[] |
号码列表 |
showNumber |
boolean |
是否显示号码 |
subHotPage? |
number | null
|
热键子页ID |
subHotPageName? |
string |
热键子页名称 |
type |
HotkeyType |
热键类型 |
Ƭ HotPageLayout: Object
热键页布局数据结构
| Name | Type | Description |
|---|---|---|
hotkeys |
((number | null)[] | null)[] |
热键ID二维数组,按行x列布局,某行列未配置热键时,取值null,整行未配置热键时,行取值null |
name |
string |
热键名称 |
Ƭ InstantMeetingParty: Object
即时会议成员状态数据结构
| Name | Type | Description |
|---|---|---|
listen |
boolean |
是否允许收听 |
name |
string |
名称 |
number |
string |
电话号码 |
speak |
boolean |
是否允许发言 |
state |
PhoneCallState |
呼叫状态 |
Ƭ InstantMeetingState: Object
即时会议状态数据结构
| Name | Type | Description |
|---|---|---|
keepCalling |
boolean |
成员掉线是否自动呼叫 |
parties |
InstantMeetingParty[] |
会议成员列表 |
startTime |
number |
会议开始时间戳 |
Ƭ MainHotPageItem: Object
一级热键配置项
| Name | Type | Description |
|---|---|---|
id |
number |
热键页ID |
name |
string |
热键页名称 |
Ƭ MainHotPages: Object
一级热键页配置数据结构
| Name | Type | Description |
|---|---|---|
pages |
MainHotPageItem[] |
热键页列表 |
visibleSize |
number |
TAB页可见热键页数量 |
Ƭ Message: Object
协议消息结构
| Name | Type | Description |
|---|---|---|
Catalog |
MsgCatalog |
消息分类 |
ErrorMsg? |
string |
出错信息 |
InvokeID |
number |
调用ID |
MsgType |
MsgTypes |
消息具体类型 |
Param? |
any |
调用参数 |
Ret? |
any |
调用返回结果 |
Ƭ QueuedCall: Object
工作组通话(来话/保持通话)队列项数据结构
| Name | Type | Description |
|---|---|---|
chID? |
number |
中继线路通道号 |
emergency? |
boolean |
是否紧急呼叫 |
hasVideo |
boolean |
是否视频呼叫 |
hkeys? |
{ [key: string]: number; } |
通话对应热键集合 |
hotlineName? |
string |
热线名称 |
hotlineNumber |
string |
热线号码 |
name |
string |
名称 |
number |
string |
电话号码 |
picked? |
boolean |
是否被应答(或恢复) |
priority |
number |
来话方优先级别 |
startTime? |
number |
来话开始时间 |
▸ answerCall(index, chID): Promise<void>
接听来话队列中的工作组来话
| Name | Type | Description |
|---|---|---|
index |
number |
队列中序号 |
chID |
number |
中继电路通道号 |
Promise<void>
▸ cdtPhoneAlt(number, callID): Promise<void>
调度话机通话切换(保持当前通话,恢复咨询通话时保持的通话)
| Name | Type | Description |
|---|---|---|
number |
string |
调度话机号码 |
callID |
string |
恢复的通话ID号 |
Promise<void>
▸ cdtPhoneHook(number): Promise<void>
调度话机叉簧操作,根据状态接听来话或挂断当前通话
| Name | Type | Description |
|---|---|---|
number |
string |
调度话机号码 |
Promise<void>
▸ cdtPhoneSelect(number): Promise<void>
调度话机键权选择
| Name | Type | Description |
|---|---|---|
number |
string |
调度话机号码 |
Promise<void>
▸ dialDTMF(digits): Promise<void>
调度话机二次DTMF拨号
| Name | Type | Description |
|---|---|---|
digits |
string |
号码串 |
Promise<void>
▸ dialNumber(digits): Promise<void>
调度话机拨打号码
| Name | Type | Description |
|---|---|---|
digits |
string |
号码串 |
Promise<void>
▸ funcBtnClick(funcID): Promise<void>
点击功能键操作
| Name | Type | Description |
|---|---|---|
funcID |
CdtFunction |
功能键ID |
Promise<void>
▸ getVersion(): Promise<string>
获取终端软件版本号
Promise<string>
版本号
▸ hotKeyClick(id): Promise<void>
点击热键操作
| Name | Type | Description |
|---|---|---|
id |
number |
热键ID |
Promise<void>
▸ hotKeyMapClose(): Promise<any>
关闭卸载图形化调度界面
Promise<any>
▸ hotKeyMapOpen(): Promise<{ hkeys: MapHotKeyMarkSet ; zones: MapZoneMarkSet }>
打开加载图形化调度界面
Promise<{ hkeys: MapHotKeyMarkSet ; zones: MapZoneMarkSet }>
▸ instantMeetKeepCalling(keep): Promise<void>
设置会议成员掉线是否保持自动呼叫
| Name | Type | Description |
|---|---|---|
keep |
boolean |
是否保持自动呼叫 |
Promise<void>
▸ instantMeetLoad(): Promise<InstantMeetingState>
加载即时会议状态
Promise<InstantMeetingState>
即时会议状态数据结构 InstantMeetingState
▸ instantMeetPartyBye(number): Promise<void>
挂断会议成员
| Name | Type | Description |
|---|---|---|
number |
string |
会议成员电话号码 |
Promise<void>
▸ instantMeetPartyInvite(number): Promise<void>
呼叫邀请会议成员
| Name | Type | Description |
|---|---|---|
number |
string |
会议成员电话号码 |
Promise<void>
▸ instantMeetPartyListen(number, enable): Promise<void>
允许/禁止会议成员收听
| Name | Type | Description |
|---|---|---|
number |
string |
会议成员电话号码 |
enable |
boolean |
是否允许收听 |
Promise<void>
▸ instantMeetPartyRemove(number): Promise<void>
移除会议成员
| Name | Type | Description |
|---|---|---|
number |
string |
会议成员电路通道号 |
Promise<void>
▸ instantMeetPartySpeak(number, enable): Promise<void>
允许/禁止会议成员发言
| Name | Type | Description |
|---|---|---|
number |
string |
会议成员电话号码 |
enable |
boolean |
是否允许发言 |
Promise<void>
▸ loadActiveHotKeyPage(pageId?): Promise<{ pageHotKeysConfig: HotKeyPageConfig ; pageLayout: HotPageLayout }>
加载当前热键页
| Name | Type | Description |
|---|---|---|
pageId? |
number |
热键页ID,可以不填,表示加载登录用户的个性化热键页 |
Promise<{ pageHotKeysConfig: HotKeyPageConfig ; pageLayout: HotPageLayout }>
热键页布局及其热键配置
▸ loadCdtDevice(): Promise<CdtDeviceConfig>
加载终端设备配置
Promise<CdtDeviceConfig>
终端设备配置,参考类型CdtDeviceConfig
▸ loadCommonFunc(): Promise<FuncKeyLayout>
加载常用功能键布局
Promise<FuncKeyLayout>
加载常用功能键布局,参考类型CommonFuncLayout
▸ loadExtPages(): Promise<ExtPageLayout>
加载扩展页列表
Promise<ExtPageLayout>
扩展页列表,参考类型ExtPageLayout
▸ loadFuncPage(): Promise<FuncKeyLayout>
加载功能页布局
Promise<FuncKeyLayout>
功能页布局,参考类型FuncKeyLayout
▸ loadMainHotKeyPages(): Promise<MainHotPages>
加载一级热键页列表
Promise<MainHotPages>
一级热键页列表,参考类型MainHotPages
▸ resumeCall(index, chID): Promise<void>
取回工作组保持队列中的通话
| Name | Type | Description |
|---|---|---|
index |
number |
队列中序号 |
chID |
number |
中继电路通道号 |
Promise<void>
▸ searchHotKeys(offset, filter, rows): Promise<{ pageHotKeysConfig: HotKeyPageConfig ; pageLayout: HotPageLayout }>
条件搜索热键,按filter条件过滤,offset,rows返回单页结果
| Name | Type | Description |
|---|---|---|
offset |
number |
起始记录偏移量 |
filter |
string |
过滤条件字符串 |
rows |
number |
返回热键数 |
Promise<{ pageHotKeysConfig: HotKeyPageConfig ; pageLayout: HotPageLayout }>
按搜索结果临时创建的热键页
▸ setCdGroupForwarding(cfg): Promise<void>
设置登录工作组离位转移
| Name | Type | Description |
|---|---|---|
cfg |
CdGroupForwardState |
工作组离位转移配置,参见CdGroupForwardState |
Promise<void>
▸ setForwarding(toNumber): Promise<void>
设置或清除无条件转移目标号码
| Name | Type | Description |
|---|---|---|
toNumber |
string |
转移目标号码,为空时取消无条件转移 |
Promise<void>
▸ setHuntGroupForward(forwardTo): Promise<void>
设置寻线组转移目标号码
| Name | Type | Description |
|---|---|---|
forwardTo |
string |
转移目标号码,参数为空则取消转移 |
Promise<void>
▸ setOffHourForwarding(forwardTo): Promise<void>
设置工作组值班号码
| Name | Type | Description |
|---|---|---|
forwardTo |
string |
值班号码 |
Promise<void>
- AdmObjTypes
- AdmOpTypes
- CallLogCatalog
- CdtFunction
- CdtOpTypes
- ExtPageName
- ExtPageType
- HotkeyType
- HuntCallMode
- ListMode
- LoginEvtTypes
- ObjectType
- Operation
- PeerNumberType
- RoleRightId
- AdmLoginLog
- AdmOpLog
- CDR
- CSTALinkStatus
- CdGroupConfig
- CdGroupProfile
- CdGroupRing
- CdGroupState
- CdrRow
- CdrRowGeneral
- CdrSummary
- CdtDeviceConfig
- CdtDeviceProfile
- CdtDeviceState
- CdtFuncButtonLayout
- CdtLoginLog
- CdtOpLog
- ClusterStatus
- HotKeyConfig
- HotKeyPageConfig
- HotKeyPageProfile
- HotKeyProfile
- MapHotKeyMark
- MapHotKeyMarkSet
- MapZoneMark
- MapZoneMarkSet
- RoleConfig
- RoleProfile
- SystemStateSummary
- UserConfig
- UserProfile
- UserRights
- UserState
- AdmObjTypeNames
- AdmOpTypeNames
- CallLogCatalogName
- CdtFuntionName
- CdtOpTypeNames
- HotkeyTypeName
- HuntCallModeName
- ListModeName
- LoginEvtNames
- PeerNumberTypeNames
- RoleRightsTree
Ƭ AdmLoginLog: Object
后台管理用户登录日志记录数据结构
| Name | Type | Description |
|---|---|---|
comment? |
string |
详情备注 |
evtType |
LoginEvtTypes |
登录事件类型 |
id? |
number |
记录内部自动ID |
ipAddress |
string |
终端IP地址 |
logTime |
string | Date
|
登录时间 |
userId |
string |
用户账号 |
userName? |
string |
用户名称 |
Ƭ AdmOpLog: Object
后台管理操作日志记录数据结构
| Name | Type | Description |
|---|---|---|
comment? |
string |
操作详情备注 |
id? |
number |
记录内部自动ID |
logTime |
Date | string
|
记录时间 |
objId? |
string |
操作对象ID,如果有的话 |
objName |
string |
操作对象名称 |
objType |
AdmObjTypes |
操作对象类型值 |
opType |
AdmOpTypes |
操作类型值 |
userId |
string |
用户账号 |
userName? |
string |
用户名称 |
Ƭ CDR: Object
通话记录数据结构定义
| Name | Type | Description |
|---|---|---|
alertTime? |
Date |
呼叫振铃时间 |
callid? |
string |
呼叫ID(来自CSTA协议) |
catalog |
CallLogCatalog |
分类 |
cdGroup? |
number |
调度工作组内部ID |
cdGroupName? |
string |
调度工作组名称 |
cdtDevice? |
string |
调度台ID |
cdtDeviceName? |
string |
调度台名称 |
connectTime? |
Date |
呼叫接通时间 |
endTime |
Date |
呼叫结束时间 |
outgo |
boolean |
是否呼出 |
peerName |
string |
对方名称 |
peerNumber |
string |
对方号码 |
peerNumberType |
PeerNumberType |
对方号码类型 |
selfName |
string |
本方名称 |
selfNumber |
string |
本方号码 |
startTime |
Date |
呼叫开始时间 |
userId? |
string |
用户账号 |
userName? |
string |
用户名称 |
Ƭ CSTALinkStatus: { Active: boolean ; PeerAddress: string ; Up: boolean }[]
CSTA交换机状态列表
Ƭ CdGroupConfig: Object
调度工作组详细配置数据结构
| Name | Type | Description |
|---|---|---|
callMode |
HuntCallMode |
工作组呼叫模式 |
createTime? |
Date |
创建时间 |
enableRCG? |
boolean |
使用交换机RCG组 |
enabled |
boolean |
是否启用 |
extPageTabSize |
number |
扩展功能页TAB页可见页数 |
extraRingNumbers? |
string |
组来话额外群振电话,允许多个以逗号分割 |
funcButtonsCommon? |
CdtFuncButtonLayout | string
|
常用功能键面板布局 |
funcButtonsPage? |
CdtFuncButtonLayout | string
|
功能键页布局 |
holdLine? |
string |
组通话保持接入号码 |
holdLineRCG? |
string |
组通话保持RCG号码 H4K |
hotKeyPageNames? |
string[] |
一级热键页名称列表 |
hotKeyPageTabSize |
number |
一级热键页TAB页可见页数 |
hotKeyPages? |
number[] |
一级热键页内部ID列表 |
hotlineRCG? |
string |
组来话RCG号码 |
hotlines? |
{ emergency: boolean ; nName: string ; number: string }[] |
组呼叫热线号码 |
huntGroupNumber? |
string |
交换平台设置的调度台组寻线号码 |
id? |
number |
工作组内部ID |
indexTags? |
string | null
|
字母串索引 |
name? |
string |
工作组名称 |
namePy? |
string |
|
offHourForwards? |
string |
工作组值班电话,允许多个以逗号分割 |
ringListMode |
ListMode |
组来话振铃黑/白名单模式 |
Ƭ CdGroupProfile: Object
调度工作组配置概要
| Name | Type | Description |
|---|---|---|
createTime |
string |
创建时间 |
enabled |
boolean |
是否启用 |
hotlines |
string |
组呼叫号码 |
id |
number |
工作组内部ID |
memberCount |
number |
归属用户成员数量 |
name |
string |
工作组名称 |
Ƭ CdGroupRing: { userId: string ; userName: string }[]
调度工作组来话振铃组循序列表
Ƭ CdGroupState: Object
调度工作组实时状态
| Name | Type | Description |
|---|---|---|
incomingCount |
number |
组来话排队通话数量 |
loginDeviceCount |
number |
组当前登录调度台数量 |
maxWaitDuration |
number |
组来话队列中最长等待时长(秒) |
Ƭ CdrRow: Object
调度台查询通话记录列表行
| Name | Type | Description |
|---|---|---|
alertTime? |
string |
开始振铃时间 |
catalog |
CallLogCatalog |
呼叫类别值 |
cdGroup? |
string |
工作组名称 |
cdtDevice? |
string |
调度台终端ID |
cdtDeviceName? |
string |
调度台名称 |
connectTime? |
string |
接通时间 |
duration? |
string |
通话时长 |
endTime |
string |
呼叫结束时间 |
id? |
number |
记录内部ID |
outgo |
boolean |
是否呼出 |
peerName |
string |
对方名称 |
peerNumber |
string |
对方电话号码 |
peerNumberType |
PeerNumberType |
对方号码类型 |
recordUrl? |
string |
录音文件URL地址 |
selfName |
string |
本方名称 |
selfNumber |
string |
本方电话号码 |
startTime |
string |
呼叫开始时间 |
userId? |
string |
用户ID |
userName? |
string |
用户名称 |
Ƭ CdrRowGeneral: Object
管理后台查询通话记录列表行
| Name | Type | Description |
|---|---|---|
alertTime? |
string |
呼叫振铃时间 |
callType |
PeerNumberType |
呼叫类型 |
calledName |
string |
被叫名称 |
calledNumber |
string |
被叫号码 |
callerName |
string |
主叫名称 |
callerNumber |
string |
主叫号码 |
callid? |
string |
呼叫ID(来自CSTA协议) |
catalog |
CallLogCatalog |
呼叫类别值 |
cdGroupName |
string |
工作组名称 |
cdtDeviceName |
string |
调度台名称 |
connectTime? |
string |
呼叫接通时间 |
duration? |
string |
通话时长 |
endTime |
string |
呼叫结束时间 |
id? |
number |
记录内部ID |
recordUrl? |
string |
录音文件URL地址 |
startTime |
string |
呼叫开始时间 |
Ƭ CdrSummary: Object
调度台通话记录统计数据
| Name | Type | Description |
|---|---|---|
inConnectedCount |
number |
呼入接通数 |
inFailCount |
number |
呼入失败数 |
outConnectedCount |
number |
呼出接通数 |
outFailCount |
number |
呼出失败数 |
totalDuration |
string |
总通话时长 |
totalInDuration |
string |
呼入通话时长统计 |
totalOutDuration |
string |
呼出通话时长统计 |
Ƭ CdtDeviceConfig: Object
调度台终端详细配置
| Name | Type | Description |
|---|---|---|
createTime? |
Date |
创建时间 |
devId? |
string |
设备ID |
enabled? |
boolean |
是否启用 |
leftPhones? |
{ bridgeLine: string ; hasVideo: boolean ; name?: string ; number: string }[] |
左话机列表 |
name |
string |
设备名称 |
namePy? |
string |
|
rightPhones? |
{ bridgeLine: string ; hasVideo: boolean ; name?: string ; number: string }[] |
右话机列表 |
webPhone? |
{ number: string ; password: string ; useAudio: boolean } |
网页软电话配置 |
webPhone.number |
string |
电话号码 |
webPhone.password |
string |
登录注册密码 |
webPhone.useAudio |
boolean |
是否启用音频 |
Ƭ CdtDeviceProfile: Object
调度台终端配置概要
| Name | Type | Description |
|---|---|---|
createTime |
string |
增加时间 |
devId |
string |
设备ID |
enabled |
boolean |
是否启用 |
leftPhones |
string |
左话机号码列表,允许多个以逗号分隔 |
name |
string |
设备名称 |
rightPhones |
string |
右话机号码列表,允许多个以逗号分隔 |
Ƭ CdtDeviceState: Object
调度台终端登录状态
| Name | Type | Description |
|---|---|---|
ipAddr? |
string |
IP地址 |
loginCdGroup? |
string |
登录工作组 |
loginDuration? |
string |
登录时长 |
loginTime? |
string |
登录时间 |
loginUserName? |
string |
登录用户名 |
online |
boolean |
是否在线 |
started |
boolean |
是否启动 |
Ƭ CdtFuncButtonLayout: Object
调度台功能键布局配置数据结构
| Name | Type | Description |
|---|---|---|
colCount |
number |
列数 |
fontSize |
number |
字体大小 |
items |
{ colPos: number ; id: CdtFunction ; rowPos: number }[] |
按键放置列表 |
rowCount |
number |
行数 |
Ƭ CdtLoginLog: Object
调度台登录日志记录数据结构
| Name | Type | Description |
|---|---|---|
cdGroupId? |
number |
工作组内部ID |
cdGroupName? |
string |
工作组名称 |
cdtDeviceName? |
string |
调度台名称 |
comment? |
string |
详情备注 |
devId? |
string |
调度台设备ID |
evtType |
LoginEvtTypes |
事件类型值 |
id? |
number |
记录内部自动ID |
ipAddress? |
string |
调度台IP地址 |
logTime |
string | Date
|
记录时间 |
userId? |
string |
用户账号 |
userName? |
string |
用户名称 |
Ƭ CdtOpLog: Object
调度台操作日志记录数据结构
| Name | Type | Description |
|---|---|---|
cdGroupId? |
number |
工作组内部ID |
cdGroupName? |
number |
工作组名称 |
cdtDeviceName? |
string |
调度台名称 |
comment? |
string |
详情备注 |
devId |
string |
调度台ID |
id? |
number |
记录内部自动ID |
logTime |
Date | string
|
记录时间 |
opType |
CdtOpTypes |
操作类型值 |
userId |
string |
用户账号 |
userName? |
string |
用户名称 |
Ƭ ClusterStatus: Object
双机热备集群状态
| Name | Type | Description |
|---|---|---|
ActiveHost |
string |
主用服务器节点名称 |
ActiveHostAddr |
string |
主用服务器节点IP地址 |
BackupHost |
string |
备用服务器节点名称 |
BackupHostAddr |
string |
备用服务器节点IP地址 |
BackupOnline |
boolean |
备用服务器节点是否在线 |
Ƭ HotKeyConfig: Object
热键详细配置数据结构定义
| Name | Type | Description |
|---|---|---|
cdGroup? |
{ cdGroup: number | null ; cdGroupName?: string | null ; emergency: boolean ; hkey?: number } |
调度组配置 |
cdGroup.cdGroup |
number | null
|
调度组ID |
cdGroup.cdGroupName? |
string | null
|
|
cdGroup.emergency |
boolean |
是否呼叫紧急号码 |
cdGroup.hkey? |
number |
|
classification |
number |
热键密级 |
color? |
string | null
|
按键颜色 |
createTime? |
Date |
添加时间 |
creator? |
string |
创建者账号 |
detail? |
CameraProfile |
摄像头配置 |
fontBold |
boolean |
字体是否加粗 |
fontItalic |
boolean |
是否斜体 |
fontSize |
number |
字体大小 |
fontUnderline |
boolean |
是否加下划线 |
id? |
number |
热键ID |
indexTags? |
string |
字母串索引,允许多个以逗号分隔 |
name? |
string |
热键名称 |
namePy? |
string |
|
numbers? |
HotKeyNumberItem[] |
号码列表 |
post? |
string | null
|
人员职位 |
showNumber |
boolean |
是否显示号码 |
subHotPage? |
number | null
|
热键子页ID |
subHotPageName? |
string |
热键子页名称 |
type? |
number |
类型值 |
Ƭ HotKeyPageConfig: Object
热键页详细配置
| Name | Type | Description |
|---|---|---|
colCount |
number |
布局列数 |
createTime? |
Date |
创建时间 |
creator? |
string |
创建者账号 |
hkeys? |
{ colPos: number ; hkey: number ; name?: string ; page?: number ; rowPos: number ; type?: number }[] |
页面放置的热键配置表 |
id? |
number |
热键页内部ID |
indexTags? |
string |
字母串索引,允许多个以逗号分隔 |
name? |
string |
热键页名称 |
namePy? |
string |
|
pageType? |
number | null
|
客户自定义热键页类型 |
rowCount |
number |
布局行数 |
Ƭ HotKeyPageProfile: Object
热键页配置概要
| Name | Type | Description |
|---|---|---|
colCount |
number |
布局列数 |
createTime |
string |
创建时间 |
creator |
string |
创建者账号 |
id |
number |
热键页内部ID |
indexTags |
string |
字母串索引 |
keyCount |
number |
已放置热键数量 |
name |
string |
热键页名称 |
pageType? |
number | null
|
客户自定义热键页类型 |
rowCount |
number |
布局行数 |
Ƭ HotKeyProfile: Object
热键配置概要
| Name | Type | Description |
|---|---|---|
classification |
number |
热键密级 |
createTime |
string |
创建时间 |
creator |
string |
创建者账号 |
hasVideo? |
boolean |
是否支持视频 |
id |
number |
热键ID |
name |
string |
热键名称 |
numbers? |
string |
号码列表 |
type |
string |
热键类型名 |
Ƭ MapHotKeyMark: Object
图形化调度热键标注点数据结构
| Name | Type | Description |
|---|---|---|
cordX |
number |
热键X轴坐标 |
cordY |
number |
热键Y轴坐标 |
id? |
number |
热键ID |
name? |
string |
热键名称 |
number? |
string |
热键号码 |
Ƭ MapHotKeyMarkSet: Object
图形化调度全部热键标注映射表(热键ID:标注点数据)
▪ [id: string]: MapHotKeyMark
Ƭ MapZoneMark: Object
图形化调度单个区域标注数据结构
| Name | Type | Description |
|---|---|---|
cordX |
number |
区域中心X轴坐标 |
cordY |
number |
区域中心Y轴坐标 |
name? |
string |
区域名称 |
scale |
number |
区域选择自动放大比例 |
size |
number |
区域尺寸(半径) |
Ƭ MapZoneMarkSet: Object
图形化调度全部区域标注映射表(区域名称:区域标注数据)
▪ [name: string]: MapZoneMark
Ƭ RoleConfig: Object
角色详细配置数据结构
| Name | Type | Description |
|---|---|---|
administrator |
boolean |
是否管理员 |
createTime? |
Date |
创建时间 |
enabled |
boolean |
是否启用 |
name? |
string |
角色名称 |
namePy? |
string |
|
rights |
string | RoleRightId[] |
功能权限列表 |
Ƭ RoleProfile: Object
角色配置概要
| Name | Type | Description |
|---|---|---|
administrator |
boolean |
是否管理员 |
createTime |
string | Date
|
创建时间 |
enabled |
boolean |
是否启用 |
name |
string |
角色名称 |
Ƭ SystemStateSummary: Object
系统实时状态概览
| Name | Type | Description |
|---|---|---|
cdGroup |
{ heldCallCount: number ; incomingWaitCallCount: number ; loginedCount: number ; maxCallWaitDuration: number ; total: number } |
工作组 |
cdGroup.heldCallCount |
number |
组保持通话总数 |
cdGroup.incomingWaitCallCount |
number |
组来话排队总数 |
cdGroup.loginedCount |
number |
已登录工作组数量 |
cdGroup.maxCallWaitDuration |
number |
组来话最长等待时长 |
cdGroup.total |
number |
启用工作组总数 |
cdtDevice |
{ busyCount: number ; onlineCount: number ; total: number } |
调度台 |
cdtDevice.busyCount |
number |
通话中调度台数量 |
cdtDevice.onlineCount |
number |
在线调度台数量 |
cdtDevice.total |
number |
启用调度台总数 |
system |
{ cpuUsed: number ; memoryTotal: number ; memoryUsed: number ; networkTotal: number ; networkUsed: number ; storageTotal: number ; storageUsed: number } |
系统资源占用 |
system.cpuUsed |
number |
CPU占用率 |
system.memoryTotal |
number |
内存总容量 |
system.memoryUsed |
number |
内存占用量 |
system.networkTotal |
number |
网络总带宽 |
system.networkUsed |
number |
当前占用带宽 |
system.storageTotal |
number |
数据盘总容量 |
system.storageUsed |
number |
数据盘占用量 |
Ƭ UserConfig: Object
用户详细配置数据结构
| Name | Type | Description |
|---|---|---|
bizCode? |
string |
- |
cdConfig? |
{ cdPriority: number ; intrudeEnabled: boolean ; monitorEnabled: boolean ; priCdGroup: number | null ; priCdGroupName?: string | null ; tearEnabled: boolean ; userId?: string } |
调度功能配置 |
cdConfig.cdPriority |
number |
调度特权级别 |
cdConfig.intrudeEnabled |
boolean |
是否允许强插操作 |
cdConfig.monitorEnabled |
boolean |
是否允许监听操作 |
cdConfig.priCdGroup |
number | null
|
归属调度组 |
cdConfig.priCdGroupName? |
string | null
|
|
cdConfig.tearEnabled |
boolean |
是否允许强拆操作 |
cdConfig.userId? |
string |
|
classification |
number |
用户密级 |
createTime? |
Date |
创建时间 |
enabled |
boolean |
是否启用 |
id? |
string |
用户账号 |
indexTags? |
string |
用户字母索引,可以多个已逗号分隔 |
name? |
string |
用户名称 |
namePy? |
string |
|
otherCdGroupNames? |
string[] |
可登录调度工作组名称列表 |
otherCdGroups? |
number[] |
可登录调度工作组ID列表 |
recordPhones? |
string |
可回放下载录音电话白名单列表 |
roles? |
string[] |
用户角色列表 |
Ƭ UserProfile: Object
用户账号配置概要
| Name | Type | Description |
|---|---|---|
classification |
number |
用户密级 |
createTime |
string | Date
|
创建时间 |
enabled |
boolean |
是否启用 |
id |
string |
用户登录账号 |
name |
string |
用户名称 |
priCdGroup? |
string |
归属调度工作组 |
roles |
string |
用户角色列表 |
Ƭ UserRights: Object
用户会话权限数据结构
| Name | Type | Description |
|---|---|---|
administrator |
boolean |
是否系统管理员 |
cdRights? |
{ cdPriority: number ; intrudeEnabled: boolean ; monitorEnabled: boolean ; tearEnabled: boolean } |
用户调度功能权限 |
cdRights.cdPriority |
number |
调度特权级别 |
cdRights.intrudeEnabled |
boolean |
是否允许强插操作 |
cdRights.monitorEnabled |
boolean |
是否允许监听操作 |
cdRights.tearEnabled |
boolean |
是否允许强拆 |
classification |
number |
用户密级 |
name |
string |
用户名称 |
recordPhones? |
string[] |
允许回放下载录音电话号码白名单列表 |
role |
string |
用户角色 |
roleRights |
{ [key: string]: boolean; } |
用户权限表 |
Ƭ UserState: Object
用户会话状态
| Name | Type | Description |
|---|---|---|
cdLogin? |
{ loginCdt: string ; loginTime: string ; logincdGroup: string } |
登录调度台状态 |
cdLogin.loginCdt |
string |
登录调度台名称 |
cdLogin.loginTime |
string |
登录时间 |
cdLogin.logincdGroup |
string |
登录工作组名称 |
logon |
boolean |
是否已登录 |
• Const AdmObjTypeNames: string[]
后台管理操作对象分类名称列表
• Const AdmOpTypeNames: string[]
后台管理操作类型名称列表
• Const CallLogCatalogName: string[]
通话记录分类名称列表
• Const CdtFuntionName: string[]
调度台操作功能键名称列表
• Const CdtOpTypeNames: string[]
调度台操作类型名称列表
• Const HotkeyTypeName: string[]
热键类型到名称转换表
• Const HuntCallModeName: string[]
寻线组号码呼叫模式名列表
• Const ListModeName: string[]
名单模式名列表
• Const LoginEvtNames: string[]
用户登录事件名称列表
• Const PeerNumberTypeNames: string[]
通话对方号码类型名称列表
• Const RoleRightsTree: { children: ({ children: undefined ; id: RoleRightId = RoleRightId.SMS_admin; label: string = "管理" } | { children: { id: RoleRightId = RoleRightId.SMS_bcTask_query; label: string = "查询" }[] ; id: undefined = RoleRightId.SMS_admin; label: string = "群发任务" })[] ; label: string = "短信系统" }[]
用户角色权限树结构