anchorPrerequisites

• A Webex access token (via OAuth or an access token string).
• Initialize the SDK with your token using Webex.init() as mentioned in the Quickstart Guide.

Optionally, you can control Contact Center plugin behavior via configuration flags:

• allowMultiLogin (default: true)
• allowAutomatedRelogin (opt-in)

anchorSession Registration and Cleanup

Register

Establishes the connection to Contact Center services and fetches the agent profile.

await webex.cc.register();

Request Parameters

None.

Response Payload

Deregister

Closes sockets, removes listeners, and clears cached agent configuration.

await webex.cc.deregister();

Request Parameters

None.

Response Payload

None. The operation completes when resources are released.

anchorAgent Login

Use stationLogin to log the agent into a specific device type:

await webex.cc.stationLogin({
  teamId: '<TEAM_ID>',
  loginOption: 'BROWSER' | 'EXTENSION' | 'AGENT_DN',
  dialNumber: '<DN-OR-EXT>' // required for EXTENSION and AGENT_DN; ignored for BROWSER
});

Request Parameters

Behavioral details:

• For loginOption: 'AGENT_DN', the SDK validates the dial number. If invalid, the promise rejects with an error indicating INVALID_DIAL_NUMBER.

Response Payload

On success, the resolved data includes a media profile summary and login details.

Success & Failure events

webex.cc.on('agent:stationLoginSuccess', (data) => {
  // Update UI with deviceType, dn, auxCodeId, timestamps, etc.
});

webex.cc.on('agent:stationLoginFailed', (error) => {
  // Inspect error for input validation or other failures (e.g., error.data.fieldName, error.data.message)
});

anchorAgent Logout

await webex.cc.stationLogout({ logoutReason: 'logout' });

Request Parameters

Response Payload

None. The operation completes when the station is logged out.

Success & Failure events

webex.cc.on('agent:logoutSuccess', () => {
  // Station logout completed; update UI state
});

webex.cc.on('agent:logoutFailed', (error) => {
  // Handle failure
});

anchorAgent State: Available and Idle (Aux Codes)

Change the agent state using setAgentState:

await webex.cc.setAgentState({
  state: 'Available' | 'Idle',
  auxCodeId: '<AUX_CODE_ID>',
  lastStateChangeReason: '<FREE_TEXT_REASON>',
});

Request Parameters

Response Payload

None. Use events to react to the resulting state.

Success & Failure events

webex.cc.on('agent:stateChangeSuccess', (data) => {
  // Make UI changes as per auxCodeId and timestamps
});

webex.cc.on('agent:stateChangeFailed', (error) => {
  // Handle failure
});

anchorRelogin (Silent Relogin)

When allowAutomatedRelogin is enabled during Webex.init, the SDK can automatically relogin if the agent already has an active session.

Request Parameters

None (automatic behavior).

Response Payload

Delivered via the success event payload.

Success event

webex.cc.on('agent:reloginSuccess', (data) => {
  // Automatic relogin completed; update UI (deviceType, dn, aux code, timestamps)
});

anchorMulti-Login Behavior

The plugin supports a multi-login flag:

• allowMultiLogin (default: false)

If another session is detected for the same agent and the allowMultiLogin flag is false, the SDK emits:

• agent:multiLogin

The consuming application can use this event to prompt the user to close one of the sessions or to take other appropriate action -

webex.cc.on('agent:multiLogin', (data) => {
  // Another session detected; prompt the user or close one session
});

anchorPutting It Together: Minimal Flow

// 1) Initialize Webex with token and (optionally) CC plugin flags
const webex = Webex.init({
  config: {
    cc: { allowAutomatedRelogin: true, allowMultiLogin: true },
  },
  credentials: { access_token: token }
});

// 2) Register
const profile = await webex.cc.register();

// 3) Login (choose device type)
await webex.cc.stationLogin({
  teamId: profile.teams[0].id || profile.teams[0].teamId, // use the appropriate team identifier from the profile
  loginOption: 'BROWSER',
  dialNumber: ''
});

// 4) Set state to Available (auxCodeId '0' is a common default)
await webex.cc.setAgentState({ state: 'Available', auxCodeId: '0', lastStateChangeReason: 'Manual' });

// 5) Later: Logout and/or Deregister
await webex.cc.stationLogout({ logoutReason: 'logout' });
await webex.cc.deregister();

anchorEvents to handle

From the SDK emissions:

• As mentioned before, in single-session flows, these events are not required; you can rely on the resolved/rejected promises of the API calls.

• agent:stationLoginSuccess: Fired after successful station login.

• agent:stationLoginFailed: Fired if station login fails.

• agent:logoutSuccess: Fired after successful station logout.

• agent:logoutFailed: Fired if station logout fails.

• agent:stateChange: Fired for generic agent state change notifications.

• agent:stateChangeSuccess: Fired when state change succeeds.

• agent:stateChangeFailed: Fired when state change fails.

• agent:reloginSuccess: Fired after an automatic relogin completes (when enabled).

• agent:multiLogin: Fired when multiple logins are detected for the same agent.