@webex/contact-center 3.12.0-webex-services-ready.4 → 3.13.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (250) hide show
  1. package/.sdd/manifest.json +24 -13
  2. package/ai-docs/ARCHITECTURE.md +1 -1
  3. package/ai-docs/CONTRACTS.md +21 -3
  4. package/ai-docs/SECURITY.md +1 -1
  5. package/ai-docs/SERVICE_STATE.md +4 -0
  6. package/ai-docs/contact-center-spec.md +53 -6
  7. package/ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md +362 -0
  8. package/ai-docs/features/contact-owner-change-refactor.md +78 -0
  9. package/dist/cc.js +816 -26
  10. package/dist/cc.js.map +1 -1
  11. package/dist/config.js +7 -0
  12. package/dist/config.js.map +1 -1
  13. package/dist/constants.js +29 -2
  14. package/dist/constants.js.map +1 -1
  15. package/dist/index.js +66 -12
  16. package/dist/index.js.map +1 -1
  17. package/dist/metrics/MetricsManager.js +16 -0
  18. package/dist/metrics/MetricsManager.js.map +1 -1
  19. package/dist/metrics/behavioral-events.js +110 -0
  20. package/dist/metrics/behavioral-events.js.map +1 -1
  21. package/dist/metrics/constants.js +33 -0
  22. package/dist/metrics/constants.js.map +1 -1
  23. package/dist/services/AddressBook.js +18 -15
  24. package/dist/services/AddressBook.js.map +1 -1
  25. package/dist/services/AnswerCallOnWebexService.js +202 -0
  26. package/dist/services/AnswerCallOnWebexService.js.map +1 -0
  27. package/dist/services/ApiAiAssistant.js +221 -11
  28. package/dist/services/ApiAiAssistant.js.map +1 -1
  29. package/dist/services/EntryPoint.js +46 -68
  30. package/dist/services/EntryPoint.js.map +1 -1
  31. package/dist/services/Queue.js +27 -22
  32. package/dist/services/Queue.js.map +1 -1
  33. package/dist/services/WebCallingService.js +287 -37
  34. package/dist/services/WebCallingService.js.map +1 -1
  35. package/dist/services/WebexCrossClientService.js +225 -0
  36. package/dist/services/WebexCrossClientService.js.map +1 -0
  37. package/dist/services/WxAppTelephonyMercurySync.js +111 -0
  38. package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
  39. package/dist/services/config/Util.js +46 -46
  40. package/dist/services/config/Util.js.map +1 -1
  41. package/dist/services/config/constants.js +34 -77
  42. package/dist/services/config/constants.js.map +1 -1
  43. package/dist/services/config/index.js +100 -226
  44. package/dist/services/config/index.js.map +1 -1
  45. package/dist/services/config/types.js +55 -35
  46. package/dist/services/config/types.js.map +1 -1
  47. package/dist/services/constants.js +11 -1
  48. package/dist/services/constants.js.map +1 -1
  49. package/dist/services/core/Err.js.map +1 -1
  50. package/dist/services/core/Utils.js +25 -1
  51. package/dist/services/core/Utils.js.map +1 -1
  52. package/dist/services/core/WebexRequest.js +6 -2
  53. package/dist/services/core/WebexRequest.js.map +1 -1
  54. package/dist/services/core/aqm-reqs.js +17 -11
  55. package/dist/services/core/aqm-reqs.js.map +1 -1
  56. package/dist/services/core/constants.js +9 -1
  57. package/dist/services/core/constants.js.map +1 -1
  58. package/dist/services/core/types.js.map +1 -1
  59. package/dist/services/core/websocket/WebSocketManager.js +17 -1
  60. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  61. package/dist/services/task/Task.js +275 -8
  62. package/dist/services/task/Task.js.map +1 -1
  63. package/dist/services/task/TaskFactory.js +11 -6
  64. package/dist/services/task/TaskFactory.js.map +1 -1
  65. package/dist/services/task/TaskManager.js +590 -42
  66. package/dist/services/task/TaskManager.js.map +1 -1
  67. package/dist/services/task/TaskUtils.js +11 -1
  68. package/dist/services/task/TaskUtils.js.map +1 -1
  69. package/dist/services/task/WebexCallingUtils.js +70 -0
  70. package/dist/services/task/WebexCallingUtils.js.map +1 -0
  71. package/dist/services/task/constants.js +14 -2
  72. package/dist/services/task/constants.js.map +1 -1
  73. package/dist/services/task/contact.js +29 -0
  74. package/dist/services/task/contact.js.map +1 -1
  75. package/dist/services/task/digital/Digital.js +4 -3
  76. package/dist/services/task/digital/Digital.js.map +1 -1
  77. package/dist/services/task/state-machine/TaskStateMachine.js +162 -53
  78. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -1
  79. package/dist/services/task/state-machine/actions.js +6 -1
  80. package/dist/services/task/state-machine/actions.js.map +1 -1
  81. package/dist/services/task/state-machine/guards.js +7 -10
  82. package/dist/services/task/state-machine/guards.js.map +1 -1
  83. package/dist/services/task/state-machine/types.js.map +1 -1
  84. package/dist/services/task/state-machine/uiControlsComputer.js +118 -18
  85. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -1
  86. package/dist/services/task/types.js +47 -1
  87. package/dist/services/task/types.js.map +1 -1
  88. package/dist/services/task/voice/Voice.js +477 -17
  89. package/dist/services/task/voice/Voice.js.map +1 -1
  90. package/dist/services/task/voice/WebRTC.js +6 -3
  91. package/dist/services/task/voice/WebRTC.js.map +1 -1
  92. package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
  93. package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
  94. package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
  95. package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
  96. package/dist/services/wxAppDiagnosticLogging.js +159 -0
  97. package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
  98. package/dist/services/wxAppTelephonyUtils.js +19 -0
  99. package/dist/services/wxAppTelephonyUtils.js.map +1 -0
  100. package/dist/types/cc.d.ts +127 -9
  101. package/dist/types/config.d.ts +7 -0
  102. package/dist/types/constants.d.ts +23 -0
  103. package/dist/types/index.d.ts +38 -17
  104. package/dist/types/metrics/MetricsManager.d.ts +6 -0
  105. package/dist/types/metrics/constants.d.ts +31 -0
  106. package/dist/types/services/AddressBook.d.ts +2 -1
  107. package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
  108. package/dist/types/services/ApiAiAssistant.d.ts +48 -4
  109. package/dist/types/services/EntryPoint.d.ts +7 -5
  110. package/dist/types/services/Queue.d.ts +5 -3
  111. package/dist/types/services/WebexCrossClientService.d.ts +32 -0
  112. package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
  113. package/dist/types/services/config/Util.d.ts +4 -8
  114. package/dist/types/services/config/constants.d.ts +28 -76
  115. package/dist/types/services/config/index.d.ts +16 -64
  116. package/dist/types/services/config/types.d.ts +150 -173
  117. package/dist/types/services/constants.d.ts +9 -0
  118. package/dist/types/services/core/Err.d.ts +2 -0
  119. package/dist/types/services/core/Utils.d.ts +10 -0
  120. package/dist/types/services/core/WebexRequest.d.ts +1 -0
  121. package/dist/types/services/core/constants.d.ts +7 -0
  122. package/dist/types/services/core/types.d.ts +2 -0
  123. package/dist/types/services/task/Task.d.ts +34 -5
  124. package/dist/types/services/task/TaskFactory.d.ts +4 -2
  125. package/dist/types/services/task/TaskUtils.d.ts +6 -0
  126. package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
  127. package/dist/types/services/task/constants.d.ts +12 -0
  128. package/dist/types/services/task/contact.d.ts +4 -0
  129. package/dist/types/services/task/digital/Digital.d.ts +4 -3
  130. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +304 -56
  131. package/dist/types/services/task/state-machine/guards.d.ts +6 -5
  132. package/dist/types/services/task/state-machine/types.d.ts +9 -1
  133. package/dist/types/services/task/types.d.ts +192 -5
  134. package/dist/types/services/task/voice/Voice.d.ts +68 -11
  135. package/dist/types/services/task/voice/WebRTC.d.ts +5 -4
  136. package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
  137. package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
  138. package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
  139. package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
  140. package/dist/types/types.d.ts +125 -13
  141. package/dist/types/utils/PageCache.d.ts +20 -3
  142. package/dist/types.js +90 -8
  143. package/dist/types.js.map +1 -1
  144. package/dist/utils/PageCache.js +19 -5
  145. package/dist/utils/PageCache.js.map +1 -1
  146. package/dist/webex.js +9 -1
  147. package/dist/webex.js.map +1 -1
  148. package/package.json +10 -9
  149. package/src/cc.ts +1047 -48
  150. package/src/config.ts +7 -0
  151. package/src/constants.ts +36 -0
  152. package/src/index.ts +49 -11
  153. package/src/metrics/MetricsManager.ts +16 -0
  154. package/src/metrics/ai-docs/metrics-spec.md +138 -21
  155. package/src/metrics/behavioral-events.ts +112 -0
  156. package/src/metrics/constants.ts +36 -0
  157. package/src/services/AddressBook.ts +17 -6
  158. package/src/services/AnswerCallOnWebexService.ts +239 -0
  159. package/src/services/ApiAiAssistant.ts +297 -13
  160. package/src/services/EntryPoint.ts +59 -60
  161. package/src/services/Queue.ts +29 -12
  162. package/src/services/WebCallingService.ts +362 -40
  163. package/src/services/WebexCrossClientService.ts +298 -0
  164. package/src/services/WxAppTelephonyMercurySync.ts +142 -0
  165. package/src/services/agent/ai-docs/AGENTS.md +1 -1
  166. package/src/services/agent/ai-docs/agent-spec.md +1 -0
  167. package/src/services/ai-docs/AGENTS.md +11 -11
  168. package/src/services/ai-docs/services-spec.md +25 -5
  169. package/src/services/config/Util.ts +52 -82
  170. package/src/services/config/ai-docs/AGENTS.md +35 -40
  171. package/src/services/config/ai-docs/ARCHITECTURE.md +90 -103
  172. package/src/services/config/ai-docs/config-spec.md +132 -132
  173. package/src/services/config/constants.ts +39 -85
  174. package/src/services/config/index.ts +116 -277
  175. package/src/services/config/types.ts +145 -195
  176. package/src/services/constants.ts +10 -0
  177. package/src/services/core/Err.ts +1 -0
  178. package/src/services/core/Utils.ts +28 -0
  179. package/src/services/core/WebexRequest.ts +3 -1
  180. package/src/services/core/ai-docs/core-spec.md +25 -11
  181. package/src/services/core/aqm-reqs.ts +18 -12
  182. package/src/services/core/constants.ts +8 -0
  183. package/src/services/core/types.ts +33 -1
  184. package/src/services/core/websocket/WebSocketManager.ts +26 -2
  185. package/src/services/task/Task.ts +386 -12
  186. package/src/services/task/TaskFactory.ts +33 -6
  187. package/src/services/task/TaskManager.ts +857 -41
  188. package/src/services/task/TaskUtils.ts +13 -0
  189. package/src/services/task/WebexCallingUtils.ts +136 -0
  190. package/src/services/task/ai-docs/ARCHITECTURE.md +1 -0
  191. package/src/services/task/ai-docs/task-spec.md +190 -8
  192. package/src/services/task/constants.ts +13 -0
  193. package/src/services/task/contact.ts +30 -0
  194. package/src/services/task/digital/Digital.ts +11 -4
  195. package/src/services/task/state-machine/TaskStateMachine.ts +235 -81
  196. package/src/services/task/state-machine/actions.ts +5 -2
  197. package/src/services/task/state-machine/ai-docs/AGENTS.md +6 -4
  198. package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +35 -16
  199. package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +103 -33
  200. package/src/services/task/state-machine/guards.ts +7 -10
  201. package/src/services/task/state-machine/types.ts +16 -1
  202. package/src/services/task/state-machine/uiControlsComputer.ts +206 -32
  203. package/src/services/task/types.ts +269 -4
  204. package/src/services/task/voice/Voice.ts +625 -17
  205. package/src/services/task/voice/WebRTC.ts +11 -4
  206. package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
  207. package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
  208. package/src/services/wxAppDiagnosticLogging.ts +286 -0
  209. package/src/services/wxAppTelephonyUtils.ts +14 -0
  210. package/src/types.ts +159 -13
  211. package/src/utils/AGENTS.md +21 -10
  212. package/src/utils/PageCache.ts +38 -5
  213. package/src/utils/ai-docs/utils-spec.md +21 -11
  214. package/src/webex.js +8 -0
  215. package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
  216. package/test/unit/spec/cc.ts +3595 -120
  217. package/test/unit/spec/index.ts +891 -0
  218. package/test/unit/spec/metrics/MetricsManager.ts +25 -0
  219. package/test/unit/spec/metrics/behavioral-events.ts +60 -0
  220. package/test/unit/spec/services/AddressBook.ts +37 -6
  221. package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
  222. package/test/unit/spec/services/ApiAiAssistant.ts +269 -8
  223. package/test/unit/spec/services/EntryPoint.ts +87 -40
  224. package/test/unit/spec/services/Queue.ts +123 -12
  225. package/test/unit/spec/services/WebCallingService.ts +483 -54
  226. package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
  227. package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
  228. package/test/unit/spec/services/config/Util.ts +501 -0
  229. package/test/unit/spec/services/config/index.ts +313 -543
  230. package/test/unit/spec/services/core/Utils.ts +22 -0
  231. package/test/unit/spec/services/core/WebexRequest.ts +8 -7
  232. package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
  233. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +64 -14
  234. package/test/unit/spec/services/task/Task.ts +2257 -11
  235. package/test/unit/spec/services/task/TaskFactory.ts +56 -2
  236. package/test/unit/spec/services/task/TaskManager.ts +5559 -1493
  237. package/test/unit/spec/services/task/TaskUtils.ts +72 -0
  238. package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
  239. package/test/unit/spec/services/task/contact.ts +33 -0
  240. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +1501 -92
  241. package/test/unit/spec/services/task/state-machine/guards.ts +210 -8
  242. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +445 -7
  243. package/test/unit/spec/services/task/voice/Voice.ts +1710 -4
  244. package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
  245. package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
  246. package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
  247. package/test/unit/spec/wellnessSampleUtils.ts +288 -0
  248. package/typedoc.md +1 -1
  249. package/umd/contact-center.min.js +2 -2
  250. package/umd/contact-center.min.js.map +1 -1
@@ -1,6 +1,11 @@
1
1
  import * as Agent from '../agent/types';
2
+ import { COLLABORATION_ACCESS } from './constants';
3
+ /** Desktop Profile access level for a collaboration destination category. */
4
+ export type CollaborationAccess = Enum<typeof COLLABORATION_ACCESS>;
2
5
  /**
3
- * Events emitted on task objects
6
+ * Contact Center backend and realtime event types.
7
+ *
8
+ * Includes task lifecycle, transcript, suggested-response, and AI summary events.
4
9
  * @enum {string}
5
10
  * @private
6
11
  * @ignore
@@ -50,6 +55,8 @@ export declare const CC_TASK_EVENTS: {
50
55
  readonly PARTICIPANT_LEFT_CONFERENCE: "ParticipantLeftConference";
51
56
  /** Event emitted when participant leaving conference fails */
52
57
  readonly PARTICIPANT_LEFT_CONFERENCE_FAILED: "ParticipantLeftConferenceFailed";
58
+ /** Event emitted when dropping another conference participant fails */
59
+ readonly PARTICIPANT_DROP_CONFERENCE_FAILED: "ParticipantDropConferenceFailed";
53
60
  /** Event emitted when consultation conference end fails */
54
61
  readonly AGENT_CONSULT_CONFERENCE_END_FAILED: "AgentConsultConferenceEndFailed";
55
62
  /** Event emitted when conference is successfully transferred */
@@ -128,16 +135,19 @@ export declare const CC_TASK_EVENTS: {
128
135
  readonly SUGGESTED_RESPONSE: "SUGGESTED_RESPONSE";
129
136
  /** Event emitted when backend acknowledges it is listening for more context */
130
137
  readonly SUGGESTED_RESPONSE_ACKNOWLEDGE: "SUGGESTED_RESPONSE_ACKNOWLEDGE";
131
- /** Event emitted when a mid-call summary is available */
132
- readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
133
- /** Event emitted when a post-call summary is available */
138
+ /** Event received when a post-call summary is available through realtime delivery */
134
139
  readonly POST_CALL_SUMMARY: "POST_CALL_SUMMARY";
140
+ /** Event received when a mid-call summary is available through realtime delivery */
141
+ readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
142
+ /** Event received when AI-summary feature enablement is available through realtime delivery */
143
+ readonly FEATURE_ENABLEMENT: "FEATURE_ENABLEMENT";
144
+ /** Event received when a subsequent agent receives a mid-call summary */
145
+ readonly MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT: "MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT";
135
146
  };
136
147
  /**
137
148
  * Events emitted on Contact Center agent operations
138
149
  * @enum {string}
139
- * @private
140
- * @ignore
150
+ * @public
141
151
  */
142
152
  export declare const CC_AGENT_EVENTS: {
143
153
  /** Welcome event when agent connects to websocket/backend */
@@ -176,6 +186,8 @@ export declare const CC_AGENT_EVENTS: {
176
186
  readonly AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: "BuddyAgentsRetrieveFailed";
177
187
  /** Event emitted when contact is reserved for agent */
178
188
  readonly AGENT_CONTACT_RESERVED: "AgentContactReserved";
189
+ /** Agent-level Agent Wellness Break notification */
190
+ readonly WELLNESS_BREAK: "WellnessBreak";
179
191
  };
180
192
  /**
181
193
  * Combined Contact Center events including both agent and task events
@@ -227,6 +239,8 @@ export declare const CC_EVENTS: {
227
239
  readonly PARTICIPANT_LEFT_CONFERENCE: "ParticipantLeftConference";
228
240
  /** Event emitted when participant leaving conference fails */
229
241
  readonly PARTICIPANT_LEFT_CONFERENCE_FAILED: "ParticipantLeftConferenceFailed";
242
+ /** Event emitted when dropping another conference participant fails */
243
+ readonly PARTICIPANT_DROP_CONFERENCE_FAILED: "ParticipantDropConferenceFailed";
230
244
  /** Event emitted when consultation conference end fails */
231
245
  readonly AGENT_CONSULT_CONFERENCE_END_FAILED: "AgentConsultConferenceEndFailed";
232
246
  /** Event emitted when conference is successfully transferred */
@@ -305,10 +319,14 @@ export declare const CC_EVENTS: {
305
319
  readonly SUGGESTED_RESPONSE: "SUGGESTED_RESPONSE";
306
320
  /** Event emitted when backend acknowledges it is listening for more context */
307
321
  readonly SUGGESTED_RESPONSE_ACKNOWLEDGE: "SUGGESTED_RESPONSE_ACKNOWLEDGE";
308
- /** Event emitted when a mid-call summary is available */
309
- readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
310
- /** Event emitted when a post-call summary is available */
322
+ /** Event received when a post-call summary is available through realtime delivery */
311
323
  readonly POST_CALL_SUMMARY: "POST_CALL_SUMMARY";
324
+ /** Event received when a mid-call summary is available through realtime delivery */
325
+ readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
326
+ /** Event received when AI-summary feature enablement is available through realtime delivery */
327
+ readonly FEATURE_ENABLEMENT: "FEATURE_ENABLEMENT";
328
+ /** Event received when a subsequent agent receives a mid-call summary */
329
+ readonly MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT: "MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT";
312
330
  /** Welcome event when agent connects to websocket/backend */
313
331
  readonly WELCOME: "Welcome";
314
332
  /** Event emitted when agent re-login is successful */
@@ -345,7 +363,13 @@ export declare const CC_EVENTS: {
345
363
  readonly AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: "BuddyAgentsRetrieveFailed";
346
364
  /** Event emitted when contact is reserved for agent */
347
365
  readonly AGENT_CONTACT_RESERVED: "AgentContactReserved";
366
+ /** Agent-level Agent Wellness Break notification */
367
+ readonly WELLNESS_BREAK: "WellnessBreak";
348
368
  };
369
+ /** Public Contact Center browser voice event names. */
370
+ export declare enum VOICE_CONNECTION_EVENTS {
371
+ STATE_CHANGE = "voice:connectionStateChange"
372
+ }
349
373
  /**
350
374
  * Event data received when agent connects to the system
351
375
  * @public
@@ -383,7 +407,7 @@ export type WebSocketEvent = {
383
407
  data: WelcomeEvent | Agent.StationLoginSuccess | Agent.LogoutSuccess | Agent.ReloginSuccess | Agent.StateChangeSuccess | Agent.BuddyAgentsSuccess;
384
408
  };
385
409
  /**
386
- * Represents the response from getUserUsingCI method.
410
+ * Agent identity carried by the `user` section of the user desktop-login aggregate.
387
411
  */
388
412
  export type AgentResponse = {
389
413
  /**
@@ -410,14 +434,6 @@ export type AgentResponse = {
410
434
  * The email address of the agent.
411
435
  */
412
436
  email: string;
413
- /**
414
- * Team IDs assigned to the agent.
415
- */
416
- teamIds: string[];
417
- /**
418
- * Multimedia profile ID associated with the agent.
419
- */
420
- multimediaProfileId: string;
421
437
  /**
422
438
  * Skill profile ID of the agent.
423
439
  */
@@ -427,9 +443,10 @@ export type AgentResponse = {
427
443
  */
428
444
  siteId: string;
429
445
  /**
430
- * Database ID of the agent.
446
+ * Database ID of the agent, distinct from `ciUserId`. Passed as `userDbId` to the team lookup,
447
+ * which sends it as the backend's `filter=userId==` value.
431
448
  */
432
- dbId?: string;
449
+ dbId: string;
433
450
  /**
434
451
  * The default dialed number of the agent.
435
452
  * Note: The API returns this field as "deafultDialledNumber" (with typo).
@@ -437,31 +454,12 @@ export type AgentResponse = {
437
454
  deafultDialledNumber?: string;
438
455
  };
439
456
  /**
440
- * Represents the response from getDesktopProfileById method.
457
+ * Desktop Profile settings carried by the `agentProfile` section of the user desktop-login
458
+ * aggregate.
441
459
  */
442
- export type DesktopProfileResponse = {
443
- /**
444
- * Unique identifier of the agent profile configuration.
445
- */
446
- id: string;
447
- /**
448
- * Display name for the agent profile.
449
- */
450
- name: string;
451
- /**
452
- * Description of the agent profile.
453
- */
454
- description: string;
455
- /**
456
- * Parent entity type for the profile (for example ORGANIZATION).
457
- */
458
- parentType: string;
459
- /**
460
- * Indicates whether screen pop is enabled.
461
- */
462
- screenPopup: boolean;
460
+ export type AgentProfile = {
463
461
  /**
464
- * Represents the voice options of an agent.
462
+ * Represents the voice options of an agent. The order is nondeterministic; treat as a set.
465
463
  */
466
464
  loginVoiceOptions: LoginOption[];
467
465
  /**
@@ -472,14 +470,6 @@ export type DesktopProfileResponse = {
472
470
  * Idle codes that the agents can select in Agent Desktop. It can take one of these values: ALL - To make all idle codes available. SPECIFIC - To make specific codes available.
473
471
  */
474
472
  accessIdleCode: string;
475
- /**
476
- * Wrap-up codes list that the agents can select when they wrap up a contact.
477
- */
478
- wrapUpCodes: string[];
479
- /**
480
- * Idle codes list that the agents can select in Agent Desktop.
481
- */
482
- idleCodes: string[];
483
473
  /**
484
474
  * Dial plan enabled for the agent.
485
475
  */
@@ -495,11 +485,7 @@ export type DesktopProfileResponse = {
495
485
  /**
496
486
  * Whether the agent personal greeting is enabled.
497
487
  */
498
- agentPersonalGreeting: boolean;
499
- /**
500
- * Auto answer allowed.
501
- */
502
- autoAnswer: boolean;
488
+ agentPersonalGreeting?: boolean;
503
489
  /**
504
490
  * Auto wrap-up after seconds.
505
491
  */
@@ -513,29 +499,17 @@ export type DesktopProfileResponse = {
513
499
  */
514
500
  allowAutoWrapUpExtension: boolean;
515
501
  /**
516
- * Access control for queues assigned to the agent (ALL or SPECIFIC).
502
+ * Access control for queues assigned to the agent (ALL, SPECIFIC, or NONE).
517
503
  */
518
- accessQueue: string;
519
- /**
520
- * Queue identifiers available to the agent when access is SPECIFIC.
521
- */
522
- queues: string[];
504
+ accessQueue: CollaborationAccess;
523
505
  /**
524
506
  * Access control for entry points assigned to the agent.
525
507
  */
526
- accessEntryPoint: string;
527
- /**
528
- * Entry point identifiers available to the agent when access is SPECIFIC.
529
- */
530
- entryPoints: string[];
508
+ accessEntryPoint: CollaborationAccess;
531
509
  /**
532
510
  * Access control for buddy teams assigned to the agent.
533
511
  */
534
- accessBuddyTeam: string;
535
- /**
536
- * Buddy team identifiers available to the agent when access is SPECIFIC.
537
- */
538
- buddyTeams: string[];
512
+ accessBuddyTeam: CollaborationAccess;
539
513
  /**
540
514
  * Outdial enabled for the agent.
541
515
  */
@@ -548,6 +522,10 @@ export type DesktopProfileResponse = {
548
522
  * Outdial ANI ID of the agent.
549
523
  */
550
524
  outdialANIId: string;
525
+ /**
526
+ * Whether the agent can schedule and manage callbacks.
527
+ */
528
+ scheduleAndManageCallBack?: boolean;
551
529
  /**
552
530
  * Consult to queue allowed.
553
531
  */
@@ -555,31 +533,18 @@ export type DesktopProfileResponse = {
555
533
  /**
556
534
  * Address book ID of the agent.
557
535
  */
558
- addressBookId: string;
536
+ addressBookId?: string;
559
537
  /**
560
538
  * Viewable statistics of the agent.
561
539
  */
562
540
  viewableStatistics: {
563
- id: string;
564
541
  agentStats: boolean;
565
- accessQueueStats: string;
566
- contactServiceQueues: string[];
567
- loggedInTeamStats: boolean;
568
- accessTeamStats: string;
569
- teams: string[];
542
+ aiAgentPerformance?: boolean;
570
543
  };
571
544
  /**
572
545
  * Agent DN validation of the agent.
573
546
  */
574
547
  agentDNValidation: string;
575
- /**
576
- * Additional DN validation criteria configured for the agent.
577
- */
578
- agentDNValidationCriterions: string[];
579
- /**
580
- * Dial plans of the agent.
581
- */
582
- dialPlans: string[];
583
548
  /**
584
549
  * Timeout desktop inactivity custom enabled.
585
550
  */
@@ -587,43 +552,7 @@ export type DesktopProfileResponse = {
587
552
  /**
588
553
  * Timeout desktop inactivity minutes.
589
554
  */
590
- timeoutDesktopInactivityMins: number;
591
- /**
592
- * Show user details in Microsoft enabled or not.
593
- */
594
- showUserDetailsMS: boolean;
595
- /**
596
- * State synchronization in Microsoft enabled or not.
597
- */
598
- stateSynchronizationMS: boolean;
599
- /**
600
- * Show user details in Webex enabled or not.
601
- */
602
- showUserDetailsWebex: boolean;
603
- /**
604
- * State synchronization in Webex enabled or not.
605
- */
606
- stateSynchronizationWebex: boolean;
607
- /**
608
- * Threshold rules configured for the agent profile.
609
- */
610
- thresholdRules: Array<Record<string, string | number>>;
611
- /**
612
- * Whether the agent profile is currently active.
613
- */
614
- active: boolean;
615
- /**
616
- * Whether this profile is the system default.
617
- */
618
- systemDefault: boolean;
619
- /**
620
- * Timestamp when the profile was created.
621
- */
622
- createdTime: number;
623
- /**
624
- * Timestamp when the profile was last updated.
625
- */
626
- lastUpdatedTime: number;
555
+ timeoutDesktopInactivityMins?: number;
627
556
  };
628
557
  /**
629
558
  * Response containing multimedia profile configuration for an agent
@@ -770,7 +699,8 @@ export type ListTeamsResponse = {
770
699
  };
771
700
  };
772
701
  /**
773
- * Basic organization information in the contact center system
702
+ * Basic organization information carried by the `organization` section of the org desktop-login
703
+ * aggregate.
774
704
  * @private
775
705
  * @ignore
776
706
  */
@@ -779,11 +709,10 @@ export type OrgInfo = {
779
709
  tenantId: string;
780
710
  /** Organization timezone */
781
711
  timezone: string;
782
- /** Current environment (e.g., 'produs1', 'intgus1') */
783
- environment: string;
784
712
  };
785
713
  /**
786
- * Organization-wide feature settings and configurations
714
+ * Organization-wide feature settings carried by the `organizationSetting` section of the org
715
+ * desktop-login aggregate.
787
716
  * @private
788
717
  */
789
718
  export type OrgSettings = {
@@ -793,6 +722,8 @@ export type OrgSettings = {
793
722
  maskSensitiveData: boolean;
794
723
  /** Whether campaign manager features are enabled */
795
724
  campaignManagerEnabled: boolean;
725
+ /** Number of AI Assistant licenses assigned to the organization */
726
+ aiAssistantQuantity?: number | null;
796
727
  };
797
728
  /**
798
729
  * Contact center site configuration information
@@ -811,12 +742,13 @@ export type SiteInfo = {
811
742
  systemDefault: boolean;
812
743
  };
813
744
  /**
814
- * Tenant-level configuration data and settings
745
+ * Tenant-level configuration carried by the `tenantConfiguration` section of the org
746
+ * desktop-login aggregate.
815
747
  * @private
816
748
  */
817
749
  export type TenantData = {
818
- /** Desktop inactivity timeout in minutes */
819
- timeoutDesktopInactivityMins: number;
750
+ /** Desktop inactivity timeout in minutes. Omitted when the timeout is not enabled. */
751
+ timeoutDesktopInactivityMins?: number;
820
752
  /** Whether default DN is enforced */
821
753
  forceDefaultDn: boolean;
822
754
  /** Regex pattern for default DN validation */
@@ -839,16 +771,44 @@ export type TenantData = {
839
771
  lostConnectionRecoveryTimeout: number;
840
772
  };
841
773
  /**
842
- * URL mapping configuration for external integrations
774
+ * URL mappings carried by the `urlMappings` section of the org desktop-login aggregate, keyed by
775
+ * mapping name. The aggregate returns `{}` when the organization has no Acqueon configuration.
843
776
  * @public
844
777
  */
845
- export type URLMapping = {
846
- id: string;
847
- name: string;
848
- url: string;
849
- links: string[];
850
- createdTime: number;
851
- lastUpdatedTime: number;
778
+ export type OrgUrlMappings = {
779
+ /** Acqueon API endpoint URL */
780
+ ACQUEON_API_URL?: string;
781
+ /** Acqueon console URL */
782
+ ACQUEON_CONSOLE_URL?: string;
783
+ };
784
+ /**
785
+ * Organization-level Microsoft Teams integration configuration carried by the `microsoftConfig`
786
+ * section of the org desktop-login aggregate. The whole section is absent when the organization
787
+ * has no Microsoft integration.
788
+ * @public
789
+ */
790
+ export type MicrosoftConfig = {
791
+ /** Whether to show user details in Teams */
792
+ showUserDetails?: boolean;
793
+ /** Whether to sync agent state with Teams */
794
+ stateSynchronization?: boolean;
795
+ /** Whether the integration is enabled organization-wide */
796
+ active?: boolean;
797
+ /** Idle codes mapped to Teams presence states */
798
+ idleCodes?: Record<string, string>;
799
+ };
800
+ /**
801
+ * Organization-level Webex integration configuration carried by the `webexConfig` section of the
802
+ * org desktop-login aggregate.
803
+ * @public
804
+ */
805
+ export type WebexConfig = {
806
+ /** Whether to show user details in Webex */
807
+ showUserDetails?: boolean;
808
+ /** Whether to sync agent state with Webex */
809
+ stateSynchronization?: boolean;
810
+ /** Idle codes mapped to Webex presence states */
811
+ idleCodes?: Record<string, string>;
852
812
  };
853
813
  /**
854
814
  * Constant representing idle code
@@ -918,6 +878,8 @@ export type DialPlanEntity = {
918
878
  strippedChars: string;
919
879
  /** Name of the dial plan */
920
880
  name: string;
881
+ /** Whether the dial plan is active */
882
+ active: boolean;
921
883
  };
922
884
  /**
923
885
  * Complete dial plan configuration for number handling
@@ -1019,18 +981,6 @@ export type WrapupData = {
1019
981
  allowCancelAutoWrapup?: boolean;
1020
982
  };
1021
983
  };
1022
- /**
1023
- * Team configuration information
1024
- * @public
1025
- */
1026
- export type Team = {
1027
- /** Unique team identifier */
1028
- teamId: string;
1029
- /** Team display name */
1030
- teamName: string;
1031
- /** Optional desktop layout configuration identifier */
1032
- desktopLayoutId?: string;
1033
- };
1034
984
  /**
1035
985
  * Basic queue configuration information
1036
986
  * @public
@@ -1052,11 +1002,12 @@ export type URLMappings = {
1052
1002
  acqueonConsoleUrl: string;
1053
1003
  };
1054
1004
  /**
1055
- * AI feature resource row returned by /v2/ai-feature API.
1005
+ * AI feature flags carried by the `aiFeature` section of the org desktop-login aggregate.
1056
1006
  * @public
1057
1007
  */
1058
1008
  export type AIFeatureFlags = {
1059
- id: string;
1009
+ /** Not carried by the aggregate; retained for responses that still supply a record id. */
1010
+ id?: string;
1060
1011
  realtimeTranscripts?: {
1061
1012
  enable?: boolean;
1062
1013
  agentInclusionType?: string;
@@ -1081,26 +1032,40 @@ export type AIFeatureFlags = {
1081
1032
  queuesInclusionType?: string;
1082
1033
  surveyDataSource?: string;
1083
1034
  };
1084
- links?: string[];
1085
- createdTime?: number;
1086
- lastUpdatedTime?: number;
1087
1035
  };
1088
1036
  /**
1089
- * Response type for list AI feature resources API.
1037
+ * Aggregated organization configuration returned by `organization/{orgId}/desktop-login`.
1038
+ * Replaces the separate organization, organization-setting, tenant-configuration,
1039
+ * org-url-mapping and ai-feature calls.
1090
1040
  * @public
1091
1041
  */
1092
- export type AIFeatureFlagsResponse = {
1093
- meta?: {
1094
- orgid?: string;
1095
- page?: number;
1096
- pageSize?: number;
1097
- totalPages?: number;
1098
- totalRecords?: number;
1099
- links?: {
1100
- self?: string;
1101
- };
1102
- };
1103
- data: AIFeatureFlags[];
1042
+ export type OrgDesktopLoginResponse = {
1043
+ /** Organization identity and timezone */
1044
+ organization: OrgInfo;
1045
+ /** Organization-wide feature settings */
1046
+ organizationSetting: OrgSettings;
1047
+ /** Tenant-level configuration */
1048
+ tenantConfiguration: TenantData;
1049
+ /** External integration URLs, keyed by mapping name */
1050
+ urlMappings?: OrgUrlMappings;
1051
+ /** AI feature flags */
1052
+ aiFeature?: AIFeatureFlags;
1053
+ /** Microsoft Teams integration configuration; absent when not configured */
1054
+ microsoftConfig?: MicrosoftConfig;
1055
+ /** Webex integration configuration */
1056
+ webexConfig?: WebexConfig;
1057
+ };
1058
+ /**
1059
+ * Aggregated user configuration returned by
1060
+ * `organization/{orgId}/v2/user/by-ci-user-id/{ciUserId}/desktop-login`.
1061
+ * Replaces the separate user and agent-profile calls.
1062
+ * @public
1063
+ */
1064
+ export type UserDesktopLoginResponse = {
1065
+ /** Agent identity */
1066
+ user: AgentResponse;
1067
+ /** Desktop Profile settings for the agent */
1068
+ agentProfile: AgentProfile;
1104
1069
  };
1105
1070
  /**
1106
1071
  * Comprehensive agent profile configuration in the contact center system
@@ -1122,8 +1087,8 @@ export type Profile = {
1122
1087
  /** Whether to sync agent state with Webex */
1123
1088
  stateSynchronizationWebex?: boolean;
1124
1089
  };
1125
- /** List of teams the agent belongs to */
1126
- teams: Team[];
1090
+ /** List of teams the agent belongs to, as returned by the team API */
1091
+ teams: TeamList[];
1127
1092
  /** Agent's default dial number */
1128
1093
  defaultDn: string;
1129
1094
  dn?: string;
@@ -1197,6 +1162,12 @@ export type Profile = {
1197
1162
  agentAnalyzerId?: string;
1198
1163
  /** Whether consult to queue is allowed */
1199
1164
  allowConsultToQueue: boolean;
1165
+ /** Access control for queues on Desktop Profile Collaboration tab */
1166
+ accessQueue?: CollaborationAccess;
1167
+ /** Access control for entry points on Desktop Profile Collaboration tab */
1168
+ accessEntryPoint?: CollaborationAccess;
1169
+ /** Access control for buddy teams on Desktop Profile Collaboration tab */
1170
+ accessBuddyTeam?: CollaborationAccess;
1200
1171
  /** Additional campaign manager information */
1201
1172
  campaignManagerAdditionalInfo?: string;
1202
1173
  /** Whether personal statistics are enabled */
@@ -1233,8 +1204,6 @@ export type Profile = {
1233
1204
  isAnalyzerEnabled?: boolean;
1234
1205
  /** Tenant timezone */
1235
1206
  tenantTimezone?: string;
1236
- /** Current environment (e.g., 'produs1', 'intgus1') */
1237
- environment?: string;
1238
1207
  /** Available voice login options */
1239
1208
  loginVoiceOptions?: LoginOption[];
1240
1209
  /** Current login device type */
@@ -1253,6 +1222,8 @@ export type Profile = {
1253
1222
  maskSensitiveData?: boolean;
1254
1223
  /** Whether agent is currently logged in */
1255
1224
  isAgentLoggedIn?: boolean;
1225
+ /** Active station session after a successful registered relogin. */
1226
+ agentSessionId?: string;
1256
1227
  /** Last auxiliary code ID used for state change */
1257
1228
  lastStateAuxCodeId?: string;
1258
1229
  /** Timestamp of last state change */
@@ -1261,6 +1232,12 @@ export type Profile = {
1261
1232
  lastIdleCodeChangeTimestamp?: number;
1262
1233
  /** AI feature flags resolved from organization config */
1263
1234
  aiFeature?: AIFeatureFlags;
1235
+ /**
1236
+ * Whether Agent Wellness Break is effectively enabled for this profile.
1237
+ * This combines the organization wellbeing configuration with AI Assistant licensing;
1238
+ * Server-side rollout remains enforced by the backend configuration and notification delivery.
1239
+ */
1240
+ isWellnessBreakEnabled?: boolean;
1264
1241
  };
1265
1242
  /**
1266
1243
  * Contact distribution group configuration for routing logic
@@ -28,6 +28,15 @@ export declare const WCC_CALLING_RTMS_DOMAIN = "wcc-calling-rtms-domain";
28
28
  * @ignore
29
29
  */
30
30
  export declare const DEFAULT_RTMS_DOMAIN = "rtw.prod-us1.rtmsprod.net";
31
+ /**
32
+ * Trusted domain suffix for RTMS hosts returned by the u2c service catalog. A catalog-provided
33
+ * RTMS host is only used when its hostname is, or is a subdomain of, this domain; otherwise
34
+ * `DEFAULT_RTMS_DOMAIN` is used.
35
+ * @type {string}
36
+ * @public
37
+ * @ignore
38
+ */
39
+ export declare const ALLOWED_RTMS_DOMAIN = "rtmsprod.net";
31
40
  /**
32
41
  * Timeout in milliseconds for WebSocket events.
33
42
  * @type {number}
@@ -49,6 +49,8 @@ export type TaskErrorIds = {
49
49
  'Service.aqm.task.consultAccept': Failure;
50
50
  } | {
51
51
  'Service.aqm.task.consultConference': Failure;
52
+ } | {
53
+ 'Service.aqm.task.dropConferenceParticipant': Failure;
52
54
  } | {
53
55
  'Service.aqm.task.consultEnd': Failure;
54
56
  } | {
@@ -3,6 +3,8 @@ import { LoginOption, WebexRequestPayload } from '../../types';
3
3
  import { Failure, AugmentedError } from './GlobalTypes';
4
4
  import { ConsultConferenceData, consultConferencePayloadData, ConsultTransferDestinationType, TaskData, Interaction } from '../task/types';
5
5
  import { DialPlan } from '../config/types';
6
+ /** Returns whether a value is a non-null object with string keys. */
7
+ export declare const isRecord: (value: unknown) => value is Record<string, unknown>;
6
8
  /**
7
9
  * Strips characters defined in the dial plan entry from the input string.
8
10
  *
@@ -21,6 +23,14 @@ export declare const stripDialPlanChars: (input: string, strippedChars: string)
21
23
  * @returns true if the input matches at least one dial plan regex pattern or no entries are configured, false otherwise
22
24
  */
23
25
  export declare const isValidDialNumber: (input: string, dialPlanEntries: DialPlan['dialPlanEntity']) => boolean;
26
+ /**
27
+ * Checks whether a URL's hostname is, or is a subdomain of, one of the allowed domains.
28
+ *
29
+ * @param url - The candidate URL to validate
30
+ * @param allowedDomains - Domains (or domain suffixes) the URL's hostname must match
31
+ * @returns true when the URL parses and its hostname matches an allowed domain, false otherwise
32
+ */
33
+ export declare const isAllowedUrlHost: (url: string | undefined | null, allowedDomains: string[]) => boolean;
24
34
  export declare const getStationLoginErrorData: (failure: Failure, loginOption: LoginOption) => {
25
35
  message: any;
26
36
  fieldName: any;
@@ -11,6 +11,7 @@ declare class WebexRequest {
11
11
  resource: string;
12
12
  method: HTTP_METHODS;
13
13
  body?: RequestBody;
14
+ headers?: Record<string, string | null>;
14
15
  }): Promise<IHttpResponse>;
15
16
  /**
16
17
  * This is used for uploading the logs to backend/mats.
@@ -67,6 +67,13 @@ export declare const PARTICIPANT_TYPES: {
67
67
  };
68
68
  /** Interaction state for consultation */
69
69
  export declare const STATE_CONSULT = "consult";
70
+ /**
71
+ * Trusted domains for the RoutingNotifs WebSocket connection. A `webSocketUrl` returned by the
72
+ * subscribe/register API is only opened when its hostname matches one of these domains exactly
73
+ * or is a subdomain of one of them.
74
+ * @ignore
75
+ */
76
+ export declare const ALLOWED_ROUTING_NOTIFS_DOMAINS: string[];
70
77
  export declare const METHODS: {
71
78
  REQUEST: string;
72
79
  UPLOAD_LOGS: string;
@@ -18,6 +18,8 @@ export type Req<TRes, TErr> = {
18
18
  url: string;
19
19
  host?: string;
20
20
  method?: HTTP_METHODS;
21
+ /** Suppress request URLs and routing payloads from AQM logs for sensitive operations. */
22
+ redactSensitiveLogs?: boolean;
21
23
  err?: ((errObj: WebexRequestPayload) => Err.Details<'Service.reqs.generic.failure'>) | Err.IdsMessage | ((e: WebexRequestPayload) => Err.Message | Err.Details<Err.IdsDetails>);
22
24
  notifSuccess: {
23
25
  bind: Bind;