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

ICallHistory

Index

Methods

getCallHistoryData updateMissedCalls deleteCallHistoryRecords handleSessionEvents handleUserReadSessionEvents handleUserSessionsDeletedEvents

Events

emit on off

Methods

getCallHistoryData

getCallHistoryData(days?: number, limit?: number, sort?: SORT, sortBy?: SORT_BY): Promise<JanusResponseEvent>
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>

Implementation of ICallHistory.getCallHistoryData

updateMissedCalls

updateMissedCalls(endTimeSessionIds: EndTimeSessionId[]): Promise<UpdateMissedCallsResponse>
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>

Implementation of ICallHistory.updateMissedCalls

deleteCallHistoryRecords

deleteCallHistoryRecords(deleteSessionIds: EndTimeSessionId[]): Promise<DeleteCallHistoryRecordsResponse>
Function to delete the call history records using sessionId and endTime.

Returns
Resolves to an object of type DeleteCallHistoryRecordsResponse.Response details with success or error status.
Parameters
- deleteSessionIds: EndTimeSessionId[]
  
  An array of objects containing endTime and sessionId of the call history records
Returns Promise<DeleteCallHistoryRecordsResponse>

Implementation of ICallHistory.deleteCallHistoryRecords

handleSessionEvents

handleSessionEvents(event?: CallSessionEvent): Promise<void>
Parameters
- Optional event: CallSessionEvent
Returns Promise<void>

handleUserReadSessionEvents

handleUserReadSessionEvents(event?: CallSessionViewedEvent): Promise<void>
Parameters
- Optional event: CallSessionViewedEvent
Returns Promise<void>

handleUserSessionsDeletedEvents

handleUserSessionsDeletedEvents(event?: CallSessionDeletedEvent): Promise<void>
Parameters
- Optional event: CallSessionDeletedEvent
Returns Promise<void>

Events

emit

emit<E>(event: E, ...args: Parameters<CallHistoryEventTypes[E]>): boolean
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

Implementation of ICallHistory.emit

Inherited from Eventing.emit

on

on<E>(event: E, listener: CallHistoryEventTypes[E]): CallHistory
.
Type Parameters
- E extends keyof CallHistoryEventTypes
Parameters
- event: E
  
  Event to listen to.
- listener: CallHistoryEventTypes[E]
  
  Callback for event.
Returns CallHistory

Implementation of ICallHistory.on

Inherited from Eventing.on

off

off<E>(event: E, listener: CallHistoryEventTypes[E]): CallHistory
.
Type Parameters
- E extends keyof CallHistoryEventTypes
Parameters
- event: E
  
  Event to remove listener on.
- listener: CallHistoryEventTypes[E]
  
  Callback for event.
Returns CallHistory

Implementation of ICallHistory.off

Inherited from Eventing.off

Class CallHistory

Example

Hierarchy

Implements

Index

Methods

Events

Methods

getCallHistoryData

Parameters

days: number = NUMBER_OF_DAYS

limit: number = LIMIT

sort: SORT = SORT.DEFAULT

sortBy: SORT_BY = SORT_BY.DEFAULT

Returns Promise<JanusResponseEvent>

updateMissedCalls

Returns

Parameters

endTimeSessionIds: EndTimeSessionId[]

Returns Promise<UpdateMissedCallsResponse>

deleteCallHistoryRecords

Returns

Parameters

deleteSessionIds: EndTimeSessionId[]

Returns Promise<DeleteCallHistoryRecordsResponse>

handleSessionEvents

Parameters

Optional event: CallSessionEvent

Returns Promise<void>

handleUserReadSessionEvents

Parameters

Optional event: CallSessionViewedEvent

Returns Promise<void>

handleUserSessionsDeletedEvents

Parameters

Optional event: CallSessionDeletedEvent

Returns Promise<void>

Events

emit

Type Parameters

E extends keyof CallHistoryEventTypes

Parameters

event: E

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

Returns boolean

on

Type Parameters

E extends keyof CallHistoryEventTypes

Parameters

event: E

listener: CallHistoryEventTypes[E]

Returns CallHistory

off

Type Parameters

E extends keyof CallHistoryEventTypes

Parameters

event: E

listener: CallHistoryEventTypes[E]

Returns CallHistory

Settings

Member Visibility

Theme

`Optional` event: CallSessionEvent

`Optional` event: CallSessionViewedEvent

`Optional` event: CallSessionDeletedEvent

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