Class CallHistory

CallHistory module is designed to facilitate the retrieval of Call History Records by providing a set of APIs.

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

Example

const callHistory = createCallHistoryClient(webex, logger);

Hierarchy

  • Eventing<CallHistoryEventTypes>
    • CallHistory

Implements

Methods

getCallHistoryData updateMissedCalls handleSessionEvents handleUserReadSessionEvents

Events

emit on off

Methods

getCallHistoryData

  • Function to display the Janus API response.

    Parameters

    • days: number = NUMBER_OF_DAYS

      Number of days to fetch the call history data.

    • limit: number = LIMIT

      Number of records to be fetched.

    • sort: SORT = SORT.DEFAULT

      Sort the records in ascending or descending order.

    • sortBy: SORT_BY = SORT_BY.DEFAULT

      Sort the records by start time or end time.

    Returns Promise<JanusResponseEvent>

updateMissedCalls

  • Function to update the missed call status in the call history using sessionId and time.

    Returns

    Resolves to an object of type UpdateMissedCallsResponse.Response details with success or error status.

    Parameters

    • endTimeSessionIds: EndTimeSessionId[]

      An array of objects containing endTime and sessionId of the missed call history records

    Returns Promise<UpdateMissedCallsResponse>

handleSessionEvents

  • Parameters

    • Optional event: CallSessionEvent

    Returns Promise<void>

handleUserReadSessionEvents

  • Parameters

    • Optional event: CallSessionViewedEvent

    Returns Promise<void>

Events

emit

  • Type Parameters

    • E extends keyof CallHistoryEventTypes

    Parameters

    • event: E

      Event that is going ot be emitted.

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

      Parameters that are emitted with the event.

    Returns boolean

on

  • .

    Type Parameters

    • E extends keyof CallHistoryEventTypes

    Parameters

    • event: E

      Event to listen to.

    • listener: CallHistoryEventTypes[E]

      Callback for event.

    Returns CallHistory

off

  • .

    Type Parameters

    • E extends keyof CallHistoryEventTypes

    Parameters

    • event: E

      Event to remove listener on.

    • listener: CallHistoryEventTypes[E]

      Callback for event.

    Returns CallHistory

Settings

Member Visibility

Theme