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

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 +19 -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 +50 -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 +757 -22
  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 +23 -2
  14. package/dist/constants.js.map +1 -1
  15. package/dist/index.js +34 -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 +10 -2
  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 +51 -18
  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 +102 -8
  101. package/dist/types/config.d.ts +7 -0
  102. package/dist/types/constants.d.ts +21 -0
  103. package/dist/types/index.d.ts +34 -15
  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 +146 -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 +80 -13
  141. package/dist/types/utils/PageCache.d.ts +20 -3
  142. package/dist/types.js +54 -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 +969 -38
  150. package/src/config.ts +7 -0
  151. package/src/constants.ts +24 -0
  152. package/src/index.ts +39 -10
  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 +16 -2
  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 +10 -10
  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 +140 -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 +108 -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 +3408 -152
  217. package/test/unit/spec/index.ts +885 -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 +38 -0
  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
@@ -0,0 +1,38 @@
1
+ import { IHttpResponse, WebexSDK } from '../types';
2
+ export type WxAppTelephonyError = Error & {
3
+ isWxAppTelephonyError: true;
4
+ trackingId?: string;
5
+ status?: number | string;
6
+ };
7
+ export type AnswerCallParams = {
8
+ callId: string;
9
+ endpointId: string;
10
+ lineOwnerId?: string;
11
+ };
12
+ export type CallIdParams = {
13
+ callId: string;
14
+ lineOwnerId?: string;
15
+ };
16
+ export type TransmitDtmfParams = CallIdParams & {
17
+ dtmf: string;
18
+ };
19
+ export type CallDetailsResponse = {
20
+ muted?: boolean;
21
+ };
22
+ /**
23
+ * REST telephony client for wxApp thick-client answer (WXCC-6026).
24
+ * Separate from WebCallingService (WebRTC/Mobius).
25
+ */
26
+ export default class AnswerCallOnWebexService {
27
+ private webex;
28
+ constructor(webex: WebexSDK);
29
+ private getTelephonyBaseUrl;
30
+ private extractTrackingId;
31
+ private telephonyRequest;
32
+ answerCall(params: AnswerCallParams): Promise<IHttpResponse>;
33
+ rejectCall(params: CallIdParams): Promise<IHttpResponse>;
34
+ muteCall(params: CallIdParams): Promise<IHttpResponse>;
35
+ unmuteCall(params: CallIdParams): Promise<IHttpResponse>;
36
+ transmitDtmf(params: TransmitDtmfParams): Promise<IHttpResponse>;
37
+ getCallDetails(params: CallIdParams): Promise<CallDetailsResponse>;
38
+ }
@@ -1,5 +1,10 @@
1
- import { WebexSDK, AIAssistantEventType, AIAssistantEventName, HistoricTranscriptsResponse, RealTimeAssistanceParams, RealTimeAssistanceUserActionParams } from '../types';
1
+ import { WebexSDK, AIAssistantEventType, AIAssistantEventName, HistoricTranscriptsResponse, RealTimeAssistanceParams, RealTimeAssistanceUserActionParams, RespondToWellnessBreakParams } from '../types';
2
2
  import { AIFeatureFlags } from './config/types';
3
+ type WellnessBreakContextProvider = () => {
4
+ isWellnessBreakEnabled: boolean;
5
+ agentId?: string;
6
+ agentSessionId?: string;
7
+ };
3
8
  /**
4
9
  * ApiAIAssistant provides AI Assistant APIs for transcript controls.
5
10
  * @public
@@ -7,10 +12,49 @@ import { AIFeatureFlags } from './config/types';
7
12
  export declare class ApiAIAssistant {
8
13
  private webex;
9
14
  private metricsManager;
10
- private aiFeature;
11
- constructor(webex: WebexSDK);
15
+ private pendingRtdRequests;
16
+ private readonly wellnessContextProvider?;
17
+ private createWellnessError;
18
+ constructor(webex: WebexSDK, wellnessContextProvider?: WellnessBreakContextProvider);
12
19
  setAIFeatureFlags(aiFeature: AIFeatureFlags): void;
20
+ /**
21
+ * Validates a caller-supplied identifier (agentId/interactionId) before it is used to
22
+ * construct a request. Accepts a non-empty alphanumeric identifier that may contain
23
+ * hyphens or underscores.
24
+ * @param value - the identifier to validate
25
+ * @returns {boolean} true when the identifier is a non-empty, well-formed string
26
+ * @private
27
+ */
28
+ private isValidTranscriptIdentifier;
29
+ private sendWellnessBreakAction;
30
+ /**
31
+ * Requests an Agent Wellness Break.
32
+ * The promise resolves when the HTTP request is accepted with status 202; the later
33
+ * approval or denial is delivered independently through a wellness notification.
34
+ * @returns A promise that resolves with no value after HTTP acceptance
35
+ * @throws Structured Contact Center error when disabled, stale, invalid, or delivery fails
36
+ * @example
37
+ * await webex.cc.apiAIAssistant.requestWellnessBreak();
38
+ * @public
39
+ */
40
+ requestWellnessBreak(): Promise<void>;
41
+ /**
42
+ * Responds to a backend-provided Agent Wellness Break offer.
43
+ * The promise resolves when the HTTP request is accepted with status 202 and does not
44
+ * wait for a WebSocket completion event.
45
+ * @param params - ACCEPTED, REJECTED, or NO_RESPONSE
46
+ * @returns A promise that resolves with no value after HTTP acceptance
47
+ * @throws Structured Contact Center error when disabled, stale, invalid, or delivery fails
48
+ * @example
49
+ * await webex.cc.apiAIAssistant.respondToWellnessBreak({
50
+ * action: WELLNESS_BREAK_USER_ACTIONS.ACCEPTED,
51
+ * });
52
+ * @public
53
+ */
54
+ respondToWellnessBreak(params: RespondToWellnessBreakParams): Promise<void>;
13
55
  private getBaseUrl;
56
+ private static getRtdRequestKey;
57
+ private removeRtdRequest;
14
58
  /**
15
59
  * Sends an event to the AI Assistant service.
16
60
  * @param agentId - agent identifier
@@ -21,7 +65,7 @@ export declare class ApiAIAssistant {
21
65
  * @param languageCode - language code within eventDetails.data
22
66
  * @param trackingId - tracking identifier within eventDetails.data
23
67
  */
24
- sendEvent(agentId: string, interactionId: string, eventType: AIAssistantEventType, eventName: AIAssistantEventName, eventMetaData?: Record<string, unknown>, languageCode?: string, trackingId?: string): Promise<Record<string, unknown>>;
68
+ sendEvent(agentId: string, interactionId: string, eventType: AIAssistantEventType, eventName: AIAssistantEventName, eventMetaData?: Record<string, unknown>, languageCode?: string, trackingId?: string, publishTimestamp?: number, timeout?: number): Promise<Record<string, unknown>>;
25
69
  /**
26
70
  * Requests real-time assistance for an interaction.
27
71
  *
@@ -27,7 +27,7 @@ import type { EntryPointListResponse, EntryPointSearchParams } from '../types';
27
27
  * });
28
28
  *
29
29
  * // Search for specific entry points
30
- * const searchResults = await entryPointAPI.searchEntryPoints({
30
+ * const searchResults = await entryPointAPI.getEntryPoints({
31
31
  * search: 'support',
32
32
  * filter: 'type=="voice"'
33
33
  * });
@@ -37,7 +37,6 @@ export declare class EntryPoint {
37
37
  private webexRequest;
38
38
  private webex;
39
39
  private metricsManager;
40
- private pageCache;
41
40
  /**
42
41
  * Creates an instance of EntryPoint
43
42
  * @param {WebexSDK} webex - The Webex SDK instance
@@ -45,14 +44,17 @@ export declare class EntryPoint {
45
44
  */
46
45
  constructor(webex: WebexSDK);
47
46
  /**
48
- * Fetches entry points for the organization with pagination support
49
- * @param {EntryPointSearchParams} [params] - Search and pagination parameters
47
+ * Fetches entry-point dial-number mappings for the organization with pagination support. By
48
+ * default, returns the agent's desktop-profile-filtered mappings in backend entry-point-name order.
49
+ * Search, filter, attribute, and sort parameters can customize the request while desktop-profile
50
+ * scoping and required mapping fields remain SDK-owned.
51
+ * @param {EntryPointSearchParams} [params] - Search, pagination, and compatible override parameters.
50
52
  * @returns {Promise<EntryPointListResponse>} Promise resolving to paginated entry points
51
53
  * @throws {Error} If the API call fails
52
54
  * @public
53
55
  * @example
54
56
  * ```typescript
55
- * // Get first page of entry points
57
+ * // Get the first page using the default entry-point policy
56
58
  * const response = await entryPointAPI.getEntryPoints();
57
59
  *
58
60
  * // Get specific page with custom page size
@@ -48,14 +48,16 @@ export declare class Queue {
48
48
  */
49
49
  constructor(webex: WebexSDK);
50
50
  /**
51
- * Fetches contact service queues for the organization
52
- * @param {ContactServiceQueueSearchParams} [params] - Search and pagination parameters
51
+ * Fetches contact service queues for the organization. By default, returns active inbound
52
+ * telephony queues in backend name-ascending order using the agent's desktop profile views.
53
+ * Existing filter, sort, and desktop-profile parameters override those defaults.
54
+ * @param {ContactServiceQueueSearchParams} [params] - Search, pagination, and override parameters
53
55
  * @returns {Promise<ContactServiceQueuesResponse>} Promise resolving to contact service queues
54
56
  * @throws {Error} If the API call fails
55
57
  * @public
56
58
  * @example
57
59
  * ```typescript
58
- * // Get all queues with default pagination
60
+ * // Get queues using the default list policy and pagination
59
61
  * const response = await queueAPI.getQueues();
60
62
  *
61
63
  * // Get queues with specific pagination
@@ -0,0 +1,32 @@
1
+ import { WebexSDK } from '../types';
2
+ /**
3
+ * Publishes usersub cross-client state so Webex App suppresses native calling toasts (WXCC-6026).
4
+ */
5
+ export default class WebexCrossClientService {
6
+ private webex;
7
+ private refreshTimer?;
8
+ private refreshRetryTimer?;
9
+ private answerCallsState;
10
+ private appName;
11
+ /** Incremented on teardown/disable to ignore stale refresh timer callbacks. */
12
+ private refreshGeneration;
13
+ /** Monotonic id for usersub publish metrics timers; stale publishes cancel only their own timer. */
14
+ private usersubPublishMetricsId;
15
+ constructor(webex: WebexSDK);
16
+ private extractDeviceIdFromUrl;
17
+ private getDeviceUrl;
18
+ private clearRefreshTimer;
19
+ private scheduleRefreshRetry;
20
+ private startRefreshTimer;
21
+ private publishCrossClientState;
22
+ setManageWebexCallingInWxcc(enable: boolean, options?: {
23
+ userId?: string;
24
+ ttl?: number;
25
+ appName?: string;
26
+ trackPublishMetrics?: boolean;
27
+ }): Promise<void>;
28
+ private trackUsersubPreflightFailure;
29
+ teardown(): void;
30
+ /** Whether usersub `answer-calls-on-wxcc: true` was successfully published this session. */
31
+ isAnswerCallsStateActive(): boolean;
32
+ }
@@ -0,0 +1,28 @@
1
+ import { WebexSDK } from '../types';
2
+ export declare const TELEPHONY_CALL_MUTED = "event:telephony_calls.muted";
3
+ export declare const TELEPHONY_CALL_UNMUTED = "event:telephony_calls.unmuted";
4
+ export type UpdatedCallMuteStateEvent = {
5
+ data: {
6
+ actorId: string;
7
+ callId: string;
8
+ muted: boolean;
9
+ };
10
+ };
11
+ type MuteChangeHandler = (callId: string, muted: boolean) => void;
12
+ /**
13
+ * Subscribes to Mercury telephony mute/unmute events for wxApp thick-client sync (AD parity).
14
+ */
15
+ export default class WxAppTelephonyMercurySync {
16
+ private webex;
17
+ private subscribedAgentId?;
18
+ private muteChangeHandler?;
19
+ private boundMuteHandler?;
20
+ private boundUnmuteHandler?;
21
+ constructor(webex: WebexSDK);
22
+ private decodeBase64;
23
+ private handleMuteStateEvent;
24
+ subscribe(agentId: string, onMuteChange: MuteChangeHandler): void;
25
+ unsubscribe(): void;
26
+ isSubscribed(): boolean;
27
+ }
28
+ export {};
@@ -1,20 +1,16 @@
1
- import { AgentResponse, AuxCode, DesktopProfileResponse, DialPlanEntity, OrgInfo, OrgSettings, Profile, Team, TenantData, URLMapping, AIFeatureFlagsResponse } from './types';
1
+ import { AgentProfile, AgentResponse, AuxCode, DialPlanEntity, OrgDesktopLoginResponse, Profile, TeamList } from './types';
2
2
  /**
3
3
  * Parse the agent configurations
4
4
  * @param {Object} profileData
5
5
  * @returns {Profile}
6
6
  */
7
7
  declare function parseAgentConfigs(profileData: {
8
+ orgConfig: OrgDesktopLoginResponse;
8
9
  userData: AgentResponse;
9
- teamData: Team[];
10
- tenantData: TenantData;
11
- orgInfoData: OrgInfo;
10
+ agentProfileData: AgentProfile;
11
+ teamData: TeamList[];
12
12
  auxCodes: AuxCode[];
13
- orgSettingsData: OrgSettings;
14
- agentProfileData: DesktopProfileResponse;
15
13
  dialPlanData: DialPlanEntity[];
16
- urlMapping: URLMapping[];
17
14
  multimediaProfileId: string;
18
- aiFeatureFlags: AIFeatureFlagsResponse;
19
15
  }): Profile;
20
16
  export { parseAgentConfigs };
@@ -1,4 +1,10 @@
1
1
  export declare const DEFAULT_PAGE = 0;
2
+ /** Desktop Profile access levels for collaboration destination categories. */
3
+ export declare const COLLABORATION_ACCESS: {
4
+ readonly ALL: "ALL";
5
+ readonly SPECIFIC: "SPECIFIC";
6
+ readonly NONE: "NONE";
7
+ };
2
8
  /**
3
9
  * Default page size for paginated API requests.
4
10
  * @type {number}
@@ -22,6 +28,8 @@ export declare const AGENT_STATE_AVAILABLE_ID = "0";
22
28
  * @ignore
23
29
  */
24
30
  export declare const AGENT_STATE_AVAILABLE = "Available";
31
+ /** System idle-code name reserved for Agent Wellness Break. */
32
+ export declare const WELLBEING_BREAK_IDLE_CODE = "WellbeingBreak";
25
33
  /**
26
34
  * Description for the 'Available' agent state.
27
35
  * @type {string}
@@ -38,23 +46,18 @@ export declare const AGENT_STATE_AVAILABLE_DESCRIPTION = "Agent is available to
38
46
  export declare const DEFAULT_AUXCODE_ATTRIBUTES: string[];
39
47
  export declare const METHODS: {
40
48
  GET_AGENT_CONFIG: string;
41
- GET_USER_USING_CI: string;
42
- GET_DESKTOP_PROFILE_BY_ID: string;
49
+ GET_ORG_DESKTOP_LOGIN_CONFIG: string;
50
+ GET_USER_DESKTOP_LOGIN_CONFIG: string;
43
51
  GET_MULTIMEDIA_PROFILE_BY_ID: string;
44
52
  GET_LIST_OF_TEAMS: string;
45
53
  GET_ALL_TEAMS: string;
46
54
  GET_LIST_OF_AUX_CODES: string;
47
55
  GET_ALL_AUX_CODES: string;
48
56
  GET_SITE_INFO: string;
49
- GET_ORG_INFO: string;
50
- GET_ORGANIZATION_SETTING: string;
51
- GET_TENANT_DATA: string;
52
- GET_URL_MAPPING: string;
53
57
  GET_DIAL_PLAN_DATA: string;
54
- GET_AI_FEATURE_FLAGS: string;
58
+ GET_WELLBEING_BREAK_IDLE_CODE: string;
55
59
  GET_QUEUES: string;
56
60
  PARSE_AGENT_CONFIGS: string;
57
- GET_URL_MAPPING_UTIL: string;
58
61
  GET_MSFT_CONFIG: string;
59
62
  GET_WEBEX_CONFIG: string;
60
63
  GET_DEFAULT_AGENT_DN: string;
@@ -66,31 +69,30 @@ export declare const METHODS: {
66
69
  * Maps API endpoint names to functions that generate endpoint URLs for various organization resources.
67
70
  * @public
68
71
  * @example
69
- * const url = endPointMap.userByCI('org123', 'agent456');
72
+ * const url = endPointMap.userDesktopLogin('org123', 'agent456');
70
73
  */
71
74
  export declare const endPointMap: {
72
75
  /**
73
- * Gets the endpoint for a user by CI user ID.
76
+ * Gets the endpoint for the aggregated organization desktop-login configuration.
74
77
  * @param orgId - Organization ID.
75
- * @param agentId - Agent ID.
76
78
  * @returns The endpoint URL string.
77
79
  * @public
78
80
  * @example
79
- * const url = endPointMap.userByCI('org123', 'agent456');
81
+ * const url = endPointMap.orgDesktopLogin('org123');
80
82
  * @ignore
81
83
  */
82
- userByCI: (orgId: string, agentId: string) => string;
84
+ orgDesktopLogin: (orgId: string) => string;
83
85
  /**
84
- * Gets the endpoint for a desktop profile.
86
+ * Gets the endpoint for the aggregated user desktop-login configuration.
85
87
  * @param orgId - Organization ID.
86
- * @param desktopProfileId - Desktop profile ID.
88
+ * @param ciUserId - CI user ID of the agent.
87
89
  * @returns The endpoint URL string.
88
90
  * @public
89
91
  * @example
90
- * const url = endPointMap.desktopProfile('org123', 'profile789');
92
+ * const url = endPointMap.userDesktopLogin('org123', 'agent456');
91
93
  * @ignore
92
94
  */
93
- desktopProfile: (orgId: string, desktopProfileId: string) => string;
95
+ userDesktopLogin: (orgId: string, ciUserId: string) => string;
94
96
  /**
95
97
  * Gets the endpoint for a multimedia profile.
96
98
  * @param orgId - Organization ID.
@@ -103,18 +105,19 @@ export declare const endPointMap: {
103
105
  */
104
106
  multimediaProfile: (orgId: string, multimediaProfileId: string) => string;
105
107
  /**
106
- * Gets the endpoint for listing teams with optional filters.
108
+ * Gets the endpoint for listing the teams a user belongs to.
109
+ * The filter value must stay unquoted — the quoted form returns HTTP 400.
107
110
  * @param orgId - Organization ID.
108
111
  * @param page - Page number.
109
112
  * @param pageSize - Page size.
110
- * @param filter - Array of team IDs to filter.
113
+ * @param userDbId - Database ID of the user whose teams are requested.
111
114
  * @returns The endpoint URL string.
112
115
  * @public
113
116
  * @example
114
- * const url = endPointMap.listTeams('org123', 0, 100, ['team1', 'team2']);
117
+ * const url = endPointMap.listTeams('org123', 0, 100, 'userDb456');
115
118
  * @ignore
116
119
  */
117
- listTeams: (orgId: string, page: number, pageSize: number, filter: string[]) => string;
120
+ listTeams: (orgId: string, page: number, pageSize: number, userDbId: string) => string;
118
121
  /**
119
122
  * Gets the endpoint for listing auxiliary codes with optional filters and attributes.
120
123
  * @param orgId - Organization ID.
@@ -129,26 +132,8 @@ export declare const endPointMap: {
129
132
  * @ignore
130
133
  */
131
134
  listAuxCodes: (orgId: string, page: number, pageSize: number, filter: string[], attributes: string[]) => string;
132
- /**
133
- * Gets the endpoint for organization info.
134
- * @param orgId - Organization ID.
135
- * @returns The endpoint URL string.
136
- * @public
137
- * @example
138
- * const url = endPointMap.orgInfo('org123');
139
- * @ignore
140
- */
141
- orgInfo: (orgId: string) => string;
142
- /**
143
- * Gets the endpoint for organization settings.
144
- * @param orgId - Organization ID.
145
- * @returns The endpoint URL string.
146
- * @public
147
- * @example
148
- * const url = endPointMap.orgSettings('org123');
149
- * @ignore
150
- */
151
- orgSettings: (orgId: string) => string;
135
+ /** Lists system idle codes without applying the agent Desktop Profile filter. */
136
+ systemIdleCodes: (orgId: string, page: number, pageSize: number) => string;
152
137
  /**
153
138
  * Gets the endpoint for site info.
154
139
  * @param orgId - Organization ID.
@@ -160,26 +145,6 @@ export declare const endPointMap: {
160
145
  * @ignore
161
146
  */
162
147
  siteInfo: (orgId: string, siteId: string) => string;
163
- /**
164
- * Gets the endpoint for tenant configuration data.
165
- * @param orgId - Organization ID.
166
- * @returns The endpoint URL string.
167
- * @public
168
- * @example
169
- * const url = endPointMap.tenantData('org123');
170
- * @ignore
171
- */
172
- tenantData: (orgId: string) => string;
173
- /**
174
- * Gets the endpoint for organization URL mapping.
175
- * @param orgId - Organization ID.
176
- * @returns The endpoint URL string.
177
- * @public
178
- * @example
179
- * const url = endPointMap.urlMapping('org123');
180
- * @ignore
181
- */
182
- urlMapping: (orgId: string) => string;
183
148
  /**
184
149
  * Gets the endpoint for dial plan.
185
150
  * @param orgId - Organization ID.
@@ -190,16 +155,6 @@ export declare const endPointMap: {
190
155
  * @ignore
191
156
  */
192
157
  dialPlan: (orgId: string) => string;
193
- /**
194
- * Gets the endpoint for listing AI feature flags.
195
- * @param orgId - Organization ID.
196
- * @returns The endpoint URL string.
197
- * @public
198
- * @example
199
- * const url = endPointMap.aiFeatureFlags('org123');
200
- * @ignore
201
- */
202
- aiFeature: (orgId: string) => string;
203
158
  /**
204
159
  * Gets the endpoint for the queue list with custom query parameters.
205
160
  * @param orgId - Organization ID.
@@ -212,16 +167,13 @@ export declare const endPointMap: {
212
167
  */
213
168
  queueList: (orgId: string, queryParams: string) => string;
214
169
  /**
215
- * Gets the endpoint for entry points list with custom query parameters.
170
+ * Gets the desktop-profile-filtered dial-number mappings used by entry-point destination lists.
216
171
  * @param orgId - Organization ID.
217
172
  * @param queryParams - Query parameters string.
218
173
  * @returns The endpoint URL string.
219
- * @public
220
- * @example
221
- * const url = endPointMap.entryPointList('org123', 'page=0&pageSize=10');
222
174
  * @ignore
223
175
  */
224
- entryPointList: (orgId: string, queryParams: string) => string;
176
+ entryPointDialNumberList: (orgId: string, queryParams: string) => string;
225
177
  /**
226
178
  * Gets the endpoint for address book entries with custom query parameters.
227
179
  * @param orgId - Organization ID.
@@ -2,7 +2,7 @@
2
2
  * @packageDocumentation
3
3
  * @module AgentConfigService
4
4
  */
5
- import { DesktopProfileResponse, ListAuxCodesResponse, AgentResponse, TenantData, OrgInfo, OrgSettings, URLMapping, TeamList, DialPlanEntity, Profile, ListTeamsResponse, AuxCode, MultimediaProfileResponse, SiteInfo, OutdialAniEntriesResponse, OutdialAniParams, AIFeatureFlagsResponse } from './types';
5
+ import { ListAuxCodesResponse, OrgDesktopLoginResponse, UserDesktopLoginResponse, TeamList, DialPlanEntity, Profile, ListTeamsResponse, AuxCode, MultimediaProfileResponse, SiteInfo, OutdialAniEntriesResponse, OutdialAniParams } from './types';
6
6
  /**
7
7
  * The AgentConfigService class provides methods to fetch agent configuration data.
8
8
  * @private
@@ -21,25 +21,24 @@ export default class AgentConfigService {
21
21
  */
22
22
  getAgentConfig(orgId: string, agentId: string): Promise<Profile>;
23
23
  /**
24
- * Fetches the agent configuration data for the given orgId and agentId.
24
+ * Fetches the aggregated organization desktop-login configuration for the given orgId.
25
25
  * @ignore
26
- * @param {string} orgId - organization ID for which the agent configuration is to be fetched.
27
- * @param {string} agentId - agent ID for which the configuration is to be fetched.
28
- * @returns {Promise<AgentResponse>} - A promise that resolves to the agent configuration response.
26
+ * @param {string} orgId - organization ID for which the configuration is to be fetched.
27
+ * @returns {Promise<OrgDesktopLoginResponse>} - A promise that resolves to the organization configuration.
29
28
  * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
30
29
  * @private
31
30
  */
32
- getUserUsingCI(orgId: string, agentId: string): Promise<AgentResponse>;
31
+ getOrgDesktopLoginConfig(orgId: string): Promise<OrgDesktopLoginResponse>;
33
32
  /**
34
- * Fetches the desktop profile data for the given orgId and desktopProfileId.
33
+ * Fetches the aggregated user desktop-login configuration for the given orgId and ciUserId.
35
34
  * @ignore
36
- * @param {string} orgId - organization ID for which the desktop profile is to be fetched.
37
- * @param {string} desktopProfileId - desktop profile ID for which the data is to be fetched.
38
- * @returns {Promise<DesktopProfileResponse>} - A promise that resolves to the desktop profile response.
35
+ * @param {string} orgId - organization ID for which the configuration is to be fetched.
36
+ * @param {string} ciUserId - CI user ID of the agent whose configuration is to be fetched.
37
+ * @returns {Promise<UserDesktopLoginResponse>} - A promise that resolves to the user configuration.
39
38
  * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
40
39
  * @private
41
40
  */
42
- getDesktopProfileById(orgId: string, desktopProfileId: string): Promise<DesktopProfileResponse>;
41
+ getUserDesktopLoginConfig(orgId: string, ciUserId: string): Promise<UserDesktopLoginResponse>;
43
42
  /**
44
43
  * Fetches the multimedia profile data for the given orgId and multimediaProfileId.
45
44
  * @ignore
@@ -51,30 +50,28 @@ export default class AgentConfigService {
51
50
  */
52
51
  getMultimediaProfileById(orgId: string, multimediaProfileId: string): Promise<MultimediaProfileResponse>;
53
52
  /**
54
- * fetches the list of teams for the given orgId.
53
+ * fetches the list of teams the given user belongs to.
55
54
  * @ignore
56
55
  * @param {string} orgId - organization ID for which the teams are to be fetched.
57
56
  * @param {number} page - the page number to fetch.
58
57
  * @param {number} pageSize - the number of teams to fetch per page.
59
- * @param {string[]} filter - optional filter criteria for the teams.
60
- * @param {string[]} attributes - optional attributes to include in the response.
58
+ * @param {string} userDbId - database ID of the user whose teams are to be fetched.
61
59
  * @returns {Promise<ListTeamsResponse>} - A promise that resolves to the list of teams response.
62
60
  * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
63
61
  * @private
64
62
  */
65
- getListOfTeams(orgId: string, page: number, pageSize: number, filter: string[]): Promise<ListTeamsResponse>;
63
+ getListOfTeams(orgId: string, page: number, pageSize: number, userDbId: string): Promise<ListTeamsResponse>;
66
64
  /**
67
- * Fetches all teams from all pages for the given orgId
65
+ * Fetches all teams the given user belongs to, from all pages
68
66
  * @ignore
69
67
  * @param {string} orgId - organization ID for which the teams are to be fetched.
70
68
  * @param {number} pageSize - the number of teams to fetch per page.
71
- * @param {string[]} filter - optional filter criteria for the teams.
72
- * @param {string[]} attributes - optional attributes to include in the response.
69
+ * @param {string} userDbId - database ID of the user whose teams are to be fetched.
73
70
  * @returns {Promise<TeamList[]>} - A promise that resolves to the list of teams.
74
71
  * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
75
72
  * @private
76
73
  */
77
- getAllTeams(orgId: string, pageSize: number, filter: string[]): Promise<TeamList[]>;
74
+ getAllTeams(orgId: string, pageSize: number, userDbId: string): Promise<TeamList[]>;
78
75
  /**
79
76
  * fetches the list of aux codes for the given orgId.
80
77
  * @ignore
@@ -110,51 +107,6 @@ export default class AgentConfigService {
110
107
  * @private
111
108
  */
112
109
  getSiteInfo(orgId: string, siteId: string): Promise<SiteInfo>;
113
- /**
114
- * Fetches the organization info for the given orgId.
115
- * @ignore
116
- * @param {string} orgId - organization ID for which the organization info is to be fetched.
117
- * @returns {Promise<OrgInfo>} - A promise that resolves to the organization info response.
118
- * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
119
- * @private
120
- */
121
- getOrgInfo(orgId: string): Promise<OrgInfo>;
122
- /**
123
- * Fetches the organization settings for the given orgId.
124
- * @ignore
125
- * @param {string} orgId - organization ID for which the organization settings are to be fetched.
126
- * @returns {Promise<OrgSettings>} - A promise that resolves to the organization settings response.
127
- * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
128
- * @private
129
- */
130
- getOrganizationSetting(orgId: string): Promise<OrgSettings>;
131
- /**
132
- * Fetches the tenant data for the given orgId.
133
- * @ignore
134
- * @param {string} orgId - organization ID for which the tenant data is to be fetched.
135
- * @returns {Promise<TenantData>} - A promise that resolves to the tenant data response.
136
- * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
137
- * @private
138
- */
139
- getTenantData(orgId: string): Promise<TenantData>;
140
- /**
141
- * Fetches the URL mapping data for the given orgId.
142
- * @ignore
143
- * @param {string} orgId - organization ID for which the URL mapping is to be fetched.
144
- * @returns {Promise<URLMapping[]>} - A promise that resolves to the URL mapping response.
145
- * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
146
- * @private
147
- */
148
- getURLMapping(orgId: string): Promise<URLMapping[]>;
149
- /**
150
- * Fetches AI feature resources for the organization.
151
- * @ignore
152
- * @param {string} orgId - organization ID for which AI feature resources are to be fetched.
153
- * @returns {Promise<AIFeatureFlagsResponse>} - AI feature resources response.
154
- * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
155
- * @private
156
- */
157
- getAIFeatureFlags(orgId: string): Promise<AIFeatureFlagsResponse>;
158
110
  /**
159
111
  * Fetches the dial plan data for the given orgId.
160
112
  * @ignore