feat(cc): getBuddyAgents() implementation

docs/samples/contact-center/app.js

@@ -148,11 +148,41 @@ async function handleAgentLogin(e) {
   }
 }
 
+async function fetchBuddyAgents() {
+  try {
+    const buddyAgentsResponse = await webex.cc.getBuddyAgents({channelName: 'telephony', state: 'Available'});
+    const buddyAgentsDropdown = document.getElementById('buddyAgentsDropdown');
+    buddyAgentsDropdown.innerHTML = ''; // Clear previous options
+
+    if (buddyAgentsResponse.agentList.length === 0) {
+      const option = document.createElement('option');
+      option.text = 'No buddy agents available';
+      option.disabled = true;
+      buddyAgentsDropdown.add(option);
+      return;
+    }
+
+    buddyAgentsResponse.agentList.forEach((agent) => {
+      const option = document.createElement('option');
+      option.text = `${agent.agentName} - ${agent.state}`;
+      option.value = agent.agentId;
+      buddyAgentsDropdown.add(option);
+    });
+  } catch (error) {
+    const buddyAgentsDropdown = document.getElementById('buddyAgentsDropdown');
+    buddyAgentsDropdown.innerHTML = ''; // Clear previous options
+    const option = document.createElement('option');
+    option.text = `Failed to fetch buddy agents, ${error}`;
+    option.disabled = true;
+    buddyAgentsDropdown.add(option);
+    console.log('Failed to fetch buddy agents', error);
+  }
+}
+
 function doAgentLogin() {
   webex.cc.stationLogin({teamId: teamsDropdown.value, loginOption: agentDeviceType, dialNumber: dialNumber.value}).then((response) => {
     console.log('Agent Logged in successfully', response);
-  }
-  ).catch((error) => {
+  }).catch((error) => {
     console.log('Agent Login failed', error);
   });
 }

docs/samples/contact-center/index.html

@@ -80,7 +80,7 @@ <h2 class="collapsible">
             </div>
           </fieldset>
         </form>
-      </div>   
+      </div>
   </div>
   </section>
   </div>
@@ -91,7 +91,7 @@ <h2 class="collapsible">
           Agent Desktop Using Webex CC SDK
           <i class="arrow fa fa-angle-down" aria-hidden="true"></i>
         </h2>
-  
+
         <div class="section-content">
           <fieldset>
             <legend>Agent</legend>
@@ -121,6 +121,11 @@ <h2 class="collapsible">
                 </fieldset>
               </div>
             </div>
+            <fieldset id="buddyAgentsBox">
+              <legend>Buddy Agents</legend>
+              <button id="fetchBuddyAgents" class="btn btn-primary my-3" onclick="fetchBuddyAgents()">Get Buddy Agents</button>
+              <select id="buddyAgentsDropdown" class="form-control w-auto my-3"></select>
+            </fieldset>
           </fieldset>
         </div>
       </section>
@@ -132,4 +137,4 @@ <h2 class="collapsible">
   <script src="app.js"></script>
 </body>
 
-</html>
+</html>

packages/@webex/plugin-cc/src/cc.ts

@@ -9,12 +9,14 @@ import {
   SubscribeRequest,
   WelcomeEvent,
   STATION_LOGIN_TYPE,
+  GetBuddyAgentsRequest,
+  CHANNEL_NAME,
 } from './types';
+import {BuddyAgentsSuccess, StationLoginSuccess} from './services/types';
 import {READY, CC_FILE} from './constants';
 import Agent from './features/Agent';
 import HttpRequest from './services/HttpRequest';
 import WebRTCCalling from './WebRTCCalling';
-import {StationLoginSuccess} from './services/types';
 
 export default class ContactCenter extends WebexPlugin implements IContactCenter {
   namespace = 'cc';
@@ -136,4 +138,36 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
       return Promise.reject(error);
     }
   }
+
+  /**
+   * @param options - GetBuddyAgentsRequest
+   * @returns Promise<BuddyAgentsSuccess>
+   * @throws Error
+   * @example
+   * const buddyAgents = await webex.cc.getBuddyAgents({
+   *  channelType: CHANNEL_TYPE.TELEPHONY,
+   *  state: BuddyAgentState.AVAILABLE,
+   *  });
+   */
+  public async getBuddyAgents(
+    options: GetBuddyAgentsRequest = {
+      channelName: CHANNEL_NAME.TELEPHONY,
+    }
+  ): Promise<BuddyAgentsSuccess> {
+    try {
+      const {channelName, state} = options;
+      const buddyAgents = await this.agent.getBuddyAgents({
+        agentProfileId: this.agentConfig.agentProfileId,
+        channelName,
+        state,
+      });
+      this.$webex.logger.log('Get Buddy Agents API SUCCESS');
+
+      return buddyAgents;
+    } catch (error) {
+      this.$webex.logger.error('Get Buddy Agents API FAILED');
+
+      return Promise.reject(new Error('Error while retrieving buddy agents', error.message));
+    }
+  }
 }

packages/@webex/plugin-cc/src/features/Agent.ts

@@ -1,7 +1,7 @@
 import {STATION_LOGIN_TYPE, WebexSDK} from '../types';
 import HttpRequest from '../services/HttpRequest';
 import AgentService from '../services/AgentService';
-import {StationLoginSuccess} from '../services/types';
+import {BuddyAgents, BuddyAgentsSuccess, StationLoginSuccess} from '../services/types';
 
 export default class Agent {
   private webex: WebexSDK;
@@ -34,4 +34,15 @@ export default class Agent {
       return Promise.reject(new Error('Error while performing agent login', error));
     }
   }
+
+  public async getBuddyAgents(options: BuddyAgents): Promise<BuddyAgentsSuccess> {
+    try {
+      const buddyAgentsResponse = await this.agentService.getBuddyAgents(options);
+      this.webex.logger.log('Buddy Agents API SUCCESS');
+
+      return buddyAgentsResponse;
+    } catch (error) {
+      return Promise.reject(new Error('Error while retrieving buddy agents', error));
+    }
+  }
 }

packages/@webex/plugin-cc/src/services/AgentService.ts

@@ -1,7 +1,15 @@
 import {STATION_LOGIN_TYPE, WebexSDK, HTTP_METHODS} from '../types';
-import {AGENT, LOGIN_API, WCC_API_GATEWAY, WEB_RTC_PREFIX} from './constants';
+import {
+  AGENT,
+  GET_BUDDY_AGENTS_API,
+  BuddyAgentsEvent,
+  BuddyAgentsRetrieveFailedEvent,
+  LOGIN_API,
+  WCC_API_GATEWAY,
+  WEB_RTC_PREFIX,
+} from './constants';
 import HttpRequest from './HttpRequest';
-import {StationLoginSuccess} from './types';
+import {BuddyAgentsSuccess, BuddyAgents, StationLoginSuccess} from './types';
 
 export default class AgentService {
   private webex: WebexSDK;
@@ -56,4 +64,28 @@ export default class AgentService {
       return Promise.reject(error);
     }
   }
+
+  public async getBuddyAgents(options: BuddyAgents): Promise<BuddyAgentsSuccess> {
+    try {
+      const data = await this.httpRequest.sendRequestWithEvent({
+        service: WCC_API_GATEWAY,
+        resource: GET_BUDDY_AGENTS_API,
+        method: HTTP_METHODS.POST,
+        payload: {
+          agentProfileId: options.agentProfileId,
+          mediaType: options.channelName,
+          state: options.state || undefined,
+        },
+        eventType: BuddyAgentsEvent,
+        success: [BuddyAgentsEvent],
+        failure: [BuddyAgentsRetrieveFailedEvent],
+      });
+
+      return data as BuddyAgentsSuccess;
+    } catch (error) {
+      this.webex.logger.error(`Error during get buddy agents: ${error}`);
+
+      return Promise.reject(new Error('Error while retrieving buddy agents', error));
+    }
+  }
 }

packages/@webex/plugin-cc/src/services/HttpRequest.ts

@@ -87,14 +87,24 @@ class HttpRequest {
     try {
       const {service, resource, method, payload, eventType, success, failure} = options;
 
+      // prune undefined values
+      Object.keys(payload).forEach((key) => payload[key] === undefined && delete payload[key]);
+
       // Send the service request
       const response = await this.webex.request({
         service,
         resource,
         method,
         body: payload,
       });
-      this.webex.logger.log(`Service request sent successfully: ${response}`);
+      // @ts-ignore
+      const trackingid = response.headers.trackingid;
+
+      this.webex.logger.log(
+        `Service request sent successfully to ${service}/${resource} with payload: ${JSON.stringify(
+          payload
+        )}, Request TrackingID: ${trackingid}`
+      );
 
       // Listen for the event
       return new Promise((resolve, reject) => {

packages/@webex/plugin-cc/src/services/constants.ts

@@ -6,4 +6,10 @@ export const AGENT = 'agent';
 // CC GATEWAY API URL PATHS
 export const SUBSCRIBE_API = 'v1/notification/subscribe';
 export const LOGIN_API = 'v1/agents/login';
+export const GET_BUDDY_AGENTS_API = 'v1/agents/buddyList';
 export const WEB_RTC_PREFIX = 'webrtc-';
+
+export const AgentDesktopMessage = 'AgentDesktopMessage';
+
+export const BuddyAgentsEvent = 'BuddyAgents';
+export const BuddyAgentsRetrieveFailedEvent = 'BuddyAgentsRetrieveFailed';

packages/@webex/plugin-cc/src/services/types.ts

@@ -1,3 +1,6 @@
+import {CHANNEL_NAME, BUDDY_AGENT_STATE} from '../types';
+import {BuddyAgentsEvent, AgentDesktopMessage} from './constants';
+
 type Enum<T extends Record<string, unknown>> = T[keyof T];
 
 export type Msg<T = any> = {
@@ -228,6 +231,31 @@ export interface StationLoginSuccess {
   type: 'AgentStationLoginSuccess';
 }
 
+export type BuddyAgents = {
+  agentProfileId: string;
+  channelName: CHANNEL_NAME;
+  state?: BUDDY_AGENT_STATE;
+};
+
+export interface BuddyDetails {
+  agentId: string;
+  state: string;
+  teamId: string;
+  dn: string;
+  agentName: string;
+  siteId: string;
+}
+
+export type BuddyAgentsSuccess = {
+  eventType: typeof AgentDesktopMessage;
+  agentId: string;
+  orgId: string;
+  trackingId: string;
+  agentList: BuddyDetails[];
+  agentSessionId: string;
+  type: typeof BuddyAgentsEvent;
+};
+
 export type SubscribeResponse = {
   statusCode: number;
   body: {

packages/@webex/plugin-cc/src/types.ts

@@ -148,3 +148,24 @@ export interface SubscribeRequest {
 }
 
 export type EventResult = IAgentProfile;
+
+export const CHANNEL_NAME = {
+  TELEPHONY: 'telephony',
+  CHAT: 'chat',
+  SOCIAL: 'social',
+  EMAIL: 'email',
+} as const;
+
+export type CHANNEL_NAME = Enum<typeof CHANNEL_NAME>;
+
+export const BUDDY_AGENT_STATE = {
+  AVAILABLE: 'Available',
+  IDLE: 'Idle',
+} as const;
+
+export type BUDDY_AGENT_STATE = Enum<typeof BUDDY_AGENT_STATE>;
+
+export type GetBuddyAgentsRequest = {
+  channelName: CHANNEL_NAME;
+  state?: BUDDY_AGENT_STATE;
+};

packages/@webex/plugin-cc/test/unit/spec/features/Agent.ts

@@ -1,8 +1,8 @@
-import { STATION_LOGIN_TYPE, WebexSDK } from '../../../../src/types';
+import {STATION_LOGIN_TYPE, WebexSDK, CHANNEL_NAME, BUDDY_AGENT_STATE} from '../../../../src/types';
 import HttpRequest from '../../../../src/services/HttpRequest';
 import AgentService from '../../../../src/services/AgentService';
 import Agent from '../../../../src/features/Agent';
-import { StationLoginSuccess } from '../../../../src/services/types';
+import {BuddyAgents, BuddyAgentsSuccess, StationLoginSuccess} from '../../../../src/services/types';
 
 // Mock dependencies
 jest.mock('../../../../src/services/AgentService');
@@ -85,4 +85,49 @@ describe('Agent', () => {
     expect(webexMock.logger.log).toHaveBeenCalledWith('LOGIN API SUCCESS');
     expect(response).toBe(loginResponse);
   });
-});
+
+  describe('getBuddyAgents', () => {
+    const options: BuddyAgents = {
+      channelName: CHANNEL_NAME.TELEPHONY,
+      state: BUDDY_AGENT_STATE.AVAILABLE,
+      agentProfileId: '123',
+    };
+
+    it('should return buddy agents on success', async () => {
+      const buddyAgentsSuccess: BuddyAgentsSuccess = {
+        agentId: 'agentId1',
+        eventType: 'AgentDesktopMessage',
+        agentList: [
+          {
+            agentId: '12345',
+            state: 'Available',
+            teamId: 'abcd',
+            dn: '1001',
+            agentName: 'Agent1 Name1',
+            siteId: 'site1',
+          },
+        ],
+        orgId: 'org1',
+        trackingId: 'track1',
+        agentSessionId: 'session1',
+        type: 'BuddyAgents',
+      };
+      agentServiceMock.getBuddyAgents.mockResolvedValue(buddyAgentsSuccess);
+
+      const result = await agent.getBuddyAgents(options);
+
+      expect(result).toEqual(buddyAgentsSuccess);
+      expect(agentServiceMock.getBuddyAgents).toHaveBeenCalledWith(options);
+    });
+
+    it('should throw an error when getBuddyAgents fails', async () => {
+      const error = new Error('API Error');
+      agentServiceMock.getBuddyAgents.mockRejectedValue(error);
+
+      await expect(agent.getBuddyAgents(options)).rejects.toThrow(
+        'Error while retrieving buddy agents'
+      );
+      expect(agentServiceMock.getBuddyAgents).toHaveBeenCalledWith(options);
+    });
+  });
+});