Class AddressBook

AddressBook API class for managing Webex Contact Center address book entries. Provides functionality to fetch address book entries using the entry API.

AddressBook

Example

import Webex from 'webex';

const webex = new Webex({ credentials: 'YOUR_ACCESS_TOKEN' });
const cc = webex.cc;

// Register and login first
await cc.register();
await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });

// Get AddressBook API instance from ContactCenter
const addressBookAPI = cc.addressBook;

// Get entries from agent's default address book
const entries = await addressBookAPI.getEntries();

// Get entries from a specific address book with pagination
const entries = await addressBookAPI.getEntries({
  addressBookId: 'addressBookId123',
  page: 0,
  pageSize: 50
});

// Search for specific entries
const searchResults = await addressBook.getEntries({
  search: 'john',
  filter: 'name=="John Doe"'
});
Copy