Package com.ringcentral.definitions

Class ReadUserCallLogParameters

java.lang.Object
com.ringcentral.definitions.ReadUserCallLogParameters
public class ReadUserCallLogParameters extends Object
Query parameters for operation readUserCallLog

  • Field Details

    • extensionNumber

      public String extensionNumber
      Short extension number of a user. If specified, returns call log for this particular extension only. Cannot be combined with `phoneNumber` filter Example: 101

    • phoneNumber

      public String phoneNumber
      Phone number of a caller/callee in e.164 format without a '+' sign. If specified, all incoming/outgoing calls from/to this phone number are returned. Example: 12053320032

    • showBlocked

      public Boolean showBlocked
      Indicates then calls from/to blocked numbers are returned Default: true

    • direction

      public String[] direction
      The direction of call records to be included in the result. If omitted, both inbound and outbound calls are returned. Multiple values are supported Enum: Inbound, Outbound

    • sessionId

      public String sessionId
      Internal identifier of a call session

    • type

      public String[] type
      The type of call records to be included in the result. If omitted, all call types are returned. Multiple values are supported Enum: Voice, Fax

    • transport

      public String[] transport
      The type of call transport. Multiple values are supported. By default, this filter is disabled Enum: PSTN, VoIP

    • view

      public String view
      Defines the level of details for returned call records Default: Simple Enum: Simple, Detailed

    • withRecording

      public Boolean withRecording
      Deprecated, replaced with `recordingType` filter, still supported for compatibility reasons. Indicates if only recorded calls should be returned.

      If both `withRecording` and `recordingType` parameters are specified, then `withRecording` is ignored

    • recordingType

      public String recordingType
      Indicates that call records with recordings of particular type should be returned. If omitted, then calls with and without recordings are returned Enum: Automatic, OnDemand, All

    • dateTo

      public String dateTo
      The end of the time range to return call records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time Format: date-time

    • dateFrom

      public String dateFrom
      The beginning of the time range to return call records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is `dateTo` minus 24 hours Format: date-time

    • telephonySessionId

      public String telephonySessionId
      Internal identifier of a telephony session

    • page

      public Long page
      Indicates the page number to retrieve. Only positive number values are allowed Minimum: 1 Format: int32 Default: 1

    • perPage

      public Long perPage
      Indicates the page size (number of items). The default value is 100. The maximum value for `Simple` view is 1000, for `Detailed` view - 250 Minimum: 1 Format: int32 Default: 100

    • showDeleted

      public Boolean showDeleted
      Indicates that deleted calls records should be returned

  • Constructor Details

    • ReadUserCallLogParameters

      public ReadUserCallLogParameters()

  • Method Details