Class CallingClient

The CallingClient module provides a set of APIs for line registration and calling functionalities within the SDK.

The following code snippet demonstrates how to create an instance of CallingClient using a webex instance and callingConfig:

Example

const callingClient = createClient(webex, callingConfig);

Hierarchy

  • Eventing<CallingClientEventTypes>
    • CallingClient

Implements

Properties

mediaEngine

Methods

getLines getActiveCalls getConnectedCall uploadLogs

Events

emit on off

Properties

mediaEngine

mediaEngine: __module

Represents the `mediaEngine for managing media-related operations within the CallingClient. The media engine provides access to audio and video devices such as cameras, microphones, and speakers within the media layer.

Example

const microphones = await callingClient.mediaEngine.Media.getMicrophones();
const speakers = await callingClient.mediaEngine.Media.getSpeakers();
const cameras = await callingClient.mediaEngine.Media.getCameras();

Methods

getLines

  • Retrieves details of all the Line objects belonging to a User NOTE: currently multiple lines are not supported

    Returns Record<string, ILine>

getActiveCalls

  • Retrieves call objects for all the active calls present in the client

    Returns Record<string, ICall[]>

getConnectedCall

uploadLogs

  • Uploads logs to help troubleshoot SDK issues.

    This method collects the current SDK logs including network requests, WebSocket messages, and client-side events, then securely submits them to Webex's diagnostics service. The returned tracking ID, feedbackID can be provided to Webex support for faster issue resolution.

    Returns

    Promise

    Throws

    Error

    Returns Promise<UploadLogsResponse>

Events

emit

  • Type Parameters

    • E extends keyof CallingClientEventTypes

    Parameters

    • event: E

      Event that is going ot be emitted.

    • Rest ...args: Parameters<CallingClientEventTypes[E]>

      Parameters that are emitted with the event.

    Returns boolean

on

  • .

    Type Parameters

    • E extends keyof CallingClientEventTypes

    Parameters

    • event: E

      Event to listen to.

    • listener: CallingClientEventTypes[E]

      Callback for event.

    Returns CallingClient

off

  • .

    Type Parameters

    • E extends keyof CallingClientEventTypes

    Parameters

    • event: E

      Event to remove listener on.

    • listener: CallingClientEventTypes[E]

      Callback for event.

    Returns CallingClient

Settings

Member Visibility

Theme