CallSettings module is designed to offer a range of APIs for retrieving and updating settings such as Call Waiting, Do Not Disturb (DND), Call Forwarding, Voicemail, and more. These operations are tailored to work with various calling backends, providing flexibility and adaptability to different scenarios. The selection of the appropriate calling backend occurs during the instantiation of the CallSettings Client and is determined by the user's entitlements.

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

Example

const callSettings = createCallSettingsClient(webex, logger);

Hierarchy

  • CallSettings

Implements

Methods

  • Reads call waiting setting in Webex.

    Returns Promise<CallSettingResponse>

  • Reads DND setting in Webex.

    Returns Promise<CallSettingResponse>

  • Updates DND setting in Webex.

    Parameters

    • enabled: boolean

      true to enable DND, false to disable DND.

    Returns Promise<CallSettingResponse>

  • Reads Call Forward setting in Webex.

    Returns Promise<CallSettingResponse>

  • Reads Voicemail setting in Webex.

    Returns Promise<CallSettingResponse>

  • Reads the Call Forwarding Always settings in Webex. This will also check if CFA is set to Voicemail. If CFA is set to destination, that will take precedence.

    Parameters

    • Optional directoryNumber: string

      Directory number of the user.

    Returns Promise<CallSettingResponse>