RingCentral .Net SDK
Properties | List of all members
RingCentral.ReadCompanyCallLogParameters Class Reference

Query parameters for operation readCompanyCallLog More...

Properties

string extensionNumber [get, set]
 Short extension number of a user. If specified, returns call log for this particular extension only. Cannot be combined with phoneNumber filter Example: 101 More...
 
string phoneNumber [get, set]
 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 More...
 
string[] direction [get, set]
 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 More...
 
string[] type [get, set]
 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 More...
 
string view [get, set]
 Defines the level of details for returned call records Default: Simple Enum: Simple, Detailed More...
 
bool? withRecording [get, set]
 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 More...
 
string recordingType [get, set]
 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 More...
 
string dateFrom [get, set]
 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 More...
 
string dateTo [get, set]
 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 More...
 
string sessionId [get, set]
 Internal identifier of a call session More...
 
string telephonySessionId [get, set]
 Internal identifier of a telephony session More...
 
long? page [get, set]
 Indicates the page number to retrieve. Only positive number values are accepted Minimum: 1 Format: int32 Default: 1 More...
 
long? perPage [get, set]
 Indicates the page size (number of items) Minimum: 1 Format: int32 Default: 100 More...
 

Detailed Description

Query parameters for operation readCompanyCallLog

Property Documentation

◆ dateFrom

string RingCentral.ReadCompanyCallLogParameters.dateFrom
getset

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

◆ dateTo

string RingCentral.ReadCompanyCallLogParameters.dateTo
getset

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

◆ direction

string [] RingCentral.ReadCompanyCallLogParameters.direction
getset

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

◆ extensionNumber

string RingCentral.ReadCompanyCallLogParameters.extensionNumber
getset

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

◆ page

long? RingCentral.ReadCompanyCallLogParameters.page
getset

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

◆ perPage

long? RingCentral.ReadCompanyCallLogParameters.perPage
getset

Indicates the page size (number of items) Minimum: 1 Format: int32 Default: 100

◆ phoneNumber

string RingCentral.ReadCompanyCallLogParameters.phoneNumber
getset

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

◆ recordingType

string RingCentral.ReadCompanyCallLogParameters.recordingType
getset

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

◆ sessionId

string RingCentral.ReadCompanyCallLogParameters.sessionId
getset

Internal identifier of a call session

◆ telephonySessionId

string RingCentral.ReadCompanyCallLogParameters.telephonySessionId
getset

Internal identifier of a telephony session

◆ type

string [] RingCentral.ReadCompanyCallLogParameters.type
getset

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

◆ view

string RingCentral.ReadCompanyCallLogParameters.view
getset

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

◆ withRecording

bool? RingCentral.ReadCompanyCallLogParameters.withRecording
getset

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


The documentation for this class was generated from the following file: