Class ContactsClient

ContactsClient module is designed to offer a set of APIs for retrieving and updating contacts and groups from the contacts-service.

This code snippet demonstrates how to create an instance of ContactClient using webex and logger.

Example

const contactClient = createContactsClient(webex, logger);

Hierarchy

  • ContactsClient

Implements

Methods

getContacts createContactGroup deleteContactGroup createContact deleteContact

Methods

getContacts

  • Returns list of contacts.

    Returns Promise<ContactResponse>

createContactGroup

  • Creates a personal contact group. Also creates a KRO, if there aren't any groups.

    Parameters

    • displayName: string

      Name of the group to create.

    • Optional encryptionKeyUrl: string

      EncryptionKeyUrl to encrypt the displayName.

    • Optional groupType: GroupType

      Type of the group to create.

    Returns Promise<ContactResponse>

deleteContactGroup

  • Deletes a contact group.

    Parameters

    • groupId: string

      GroupId of the group to delete.

    Returns Promise<JanusResponseEvent | UpdateMissedCallsResponse | UCMLinesResponse | VoicemailResponseEvent | CallSettingResponse | ContactResponse>

createContact

  • Creates a custom contact.

    Parameters

    • contactInfo: Contact

      Contact object to create.

    Returns Promise<ContactResponse>

deleteContact

  • Delete a contact.

    Parameters

    • contactId: string

      ContactId of the contact to delete.

    Returns Promise<ContactResponse>

Settings

Member Visibility

Theme