Interface ICallHistory

Interface for CallHistory Client. This encompasses a set of APIs designed to facilitate the retrieval of recent Call History Record.

Hierarchy

  • Eventing<CallHistoryEventTypes>
    • ICallHistory

Implemented by

Methods

getCallHistoryData updateMissedCalls

Events

emit on off

Methods

getCallHistoryData

  • This API getCallHistoryData is utilized to request and retrieve Call History Records based on specified parameters. It accepts the following input parameters:

    Example

    const callHistoryResponse = await callHistory.getCallHistoryData(days, limit, sort, sortBy);

    Parameters

    • days: number

      Number of days to fetch the call history data.

    • limit: number

      Number of records to be fetched.

    • sort: SORT

      Sort the records in ascending or descending order.

    • sortBy: SORT_BY

      Sort the records by start time or end time.

    Returns Promise<JanusResponseEvent>

updateMissedCalls

  • This API updateMissedCalls is utilized to update the read state of user missed calls based on the specified parameters. It accepts the following input parameters:

    Example

    const updateMissedCallHistoryResponse = await callHistory.updateMissedCalls(endTimeSessionIds);

    Parameters

    • endTimeSessionIds: EndTimeSessionId[]

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

    Returns Promise<UpdateMissedCallsResponse>

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 ICallHistory

off

  • .

    Type Parameters

    • E extends keyof CallHistoryEventTypes

    Parameters

    • event: E

      Event to remove listener on.

    • listener: CallHistoryEventTypes[E]

      Callback for event.

    Returns ICallHistory

Settings

Member Visibility

Theme