All Classes and Interfaces
Class
Description
Event initiator info
Action target object (company/extension)
Limits which are effective for the account
Operator extension information.
Notification payload body
Account level region data (web service Auto-Receptionist settings)
Account service information, including brand, service plan and billing plan
Account service information, including brand, service plan and billing plan
Status information (reason, comment, lifetime).
An action that will be invoked when the card is tapped or selected.
Updates either blocked or allowed phone number list with a new phone number.
The attribute declaration to indicate webinar session participant/invitee role
Additional call session information.
Information on a task for adding multiple contacts to multiple extensions
Description of an error occurred during request processing.
Format of response in case that any error occurred during request processing
Allows more granular control over time included in the report
Query parameters for operation aggregateA2PSMSStatuses
Aggregation result
This field provides mapping of possible breakdown options for call aggregation and aggregation formula
The formula is defined by `aggregationType` and `aggregationInterval` for every counter individually.
The formula is defined by `aggregationType` and `aggregationInterval` for every timer individually.
Alert information
Data for all calls
Query parameters for operation analyticsCallsAggregationFetch
Query parameters for operation analyticsCallsTimelineFetch
Generalized API error structure suitable for any error type
Standard error response model which is returned in case of any unsuccessful operation
Generalized API error structure suitable for any error type
APNS (Apple Push Notification Service) information
APS (Apple Push Service) information/ priority data
Error response
Information on a country assigned to an extension user.
Attachment is a file to be uploaded
For 'Audio' mode only.
HardPhone model information
Site data.
Specifies a background image oa a card.
Sender/initiator caller information
Base schema for call log parties and history call log parties
Base schema for CallLogRecord and CallLogRecordLegInfo
Target caller information
Personal contact information
Personal contact information
The list of batches retrieved for an account and other filter criteria such as fromPhoneNumber, date specified in the request.
Describes request for user extension provisioning
Describes request for user extension provisioning
Billing information related to the call.
Information on account billing plan
Billing information.
Information on a blocked/allowed phone number
List of blocked or allowed phone numbers
Information on account brand
Information about an extension this device is assigned to
Company business address
Query parameters for operation caiAnalyzeInteraction
Query parameters for operation caiEnrollmentsList
Query parameters for operation caiPunctuate
Query parameters for operation caiSpeakerDiarize
Query parameters for operation caiSpeakerIdentify
Query parameters for operation caiSpeechToText
Query parameters for operation caiSummarize
Filtering of calls based on the overall call length
Returns the lists of blocked and allowed phone numbers
Returns the lists of blocked and allowed phone numbers
Caller ID settings by device
Caller ID settings by device
Caller ID settings by feature
Caller ID settings by feature
Optional filters that limit the scope of calls (joined via AND)
Primary/additional CQ information
Information on a delegate extension that actually implemented a call action.
Sender/initiator caller information
Base schema for CallLogFromParty and CallLogToParty
Call log record
Call recording data.
Call leg record
Linked message (Fax/Voicemail)
Target caller information
Information on a party of a call session
For Call Queue extension type only.
Call queue information
For Call Queue extension type only.
Call queue member information
Call queue member information
Notification payload body
Call queue service level settings
Custom greeting data
Custom greeting language
Returns data on call recording custom greetings.
Data for calls with breakdown by action (HoldOff, HoldOn, ParkOn, ParkOff, BlindTransfer, WarmTransfer, DTMFTransfer)
Result breakdown by actions
Data for calls with breakdown by company hours (BusinessHours, AfterHours)
Result breakdown by company hours
Data for calls with breakdown by direction (Inbound, Outbound)
Result breakdown by direction
Data for calls with breakdown by origin (Internal, External)
Result breakdown by origin
Data for calls with breakdown by queue SLA (InSLA, OutSLA).
Result breakdown by queue SLA
Data for calls with breakdown by response (Answered, NotAnswered, Connected, NotConnected)
Result breakdown by response
Data for calls with breakdown by result (Completed, Abandoned, Voicemail, Unknown, Missed, Accepted)
Result breakdown by call result
Data for calls with breakdown by segments (Ringing, LiveTalk, Hold, Park, Transfer, IvrPrompt, Voicemail, VmGreeting, Setup)
Result breakdown by segments
Data for calls with breakdown by type (Direct, FromQueue, ParkRetrieval, Transferred, Outbound, Overflow)
Result breakdown by type
Call volume data for the specified grouping
Duration bounds for the segment
Call session information
Status data of a call session
Call length data for the specified grouping
Query parameters for operation checkUserPermission
Recording information
Recordings page
Company emergency response location details
Extension to which the call is forwarded in 'Bypass' mode
Schedule when an answering rule should be applied
Schedule when an answering rule should be applied
Weekly schedule.
Schedule when an answering rule is applied
Extension user business address.
CCRN (Contact Center Routing Number) provider.
Contact detailed information
Contact Information
SMS and Pager only.
Cost center information.
Request body for operation createCompanyGreeting
Query parameters for operation createContact
Query parameters for operation createCustomUserGreeting
Request body for operation createCustomUserGreeting
Request body for operation createFaxMessage
Forwarding device information.
Query parameters for operation createGlipFileNew
Request body for operation createGlipFileNew
Request body for operation createIVRPrompt
Information on a task for multiple switches creation
Request body for operation createUserMeetingProfileImage
Request body for operation createUserProfileImage
Task creator information
Currency information
Information on a greeting language.
Information on an answering rule that the greeting is applied to
List of users whose data is collected.
Query parameters for operation deleteCustomRole
Query parameters for operation deleteEmergencyLocation
Query parameters for operation deleteExtensionEmergencyLocation
Query parameters for operation deleteExtension
Query parameters for operation deleteMeeting
Query parameters for operation deleteMessageByFilter
Query parameters for operation deleteMessage
The indication of a number to be deleted - either "id" or "phoneNumber" must be specified.
Query parameters for operation deleteUserCallLog
Please note that legacy 'Department' extension type corresponds to
'Call Queue' extensions in modern RingCentral product terminology
Please note that legacy 'Department' extension type corresponds to
'Call Queue' extensions in modern RingCentral product terminology
Please note that legacy 'Department' extension type corresponds to
'Call Queue' extensions in modern RingCentral product terminology
Notification payload body
Notification payload body
Device emergency settings
Company emergency response location details
Address for emergency cases.
Address for emergency cases.
Address for emergency cases.
Device information
HardPhone model information
Brief information on a phone number country
Phone number information
Information on the extension, to which the phone number is assigned.
Site data
Information on extension that the device is assigned to
Information on phone lines added to a device
This grouping allows to specify the `groupBy` option by which the data in the response will be grouped
Emergency response location information
Address for emergency cases.
Address for emergency cases.
Emergency response location information
Controls whether participants can start and pause recording
List of extensions to be updated
Information on a task for updating multiple extensions
Result record on multiple extension update task
Notification payload body
Specifies filtering based on extension ids
Notification payload body
Information on the extension, to which the phone number is assigned.
Information about extension on whose behalf a call is initiated.
Notification payload body
Extension information
This attribute can be omitted for unassigned devices
Notification payload body
Extension permissions, corresponding to the Service Web permissions
'Admin' and 'InternationalCalling'
Status information (reason, comment).
Fax receiver
Formatting language preferences for numbers, dates and currencies
Information on a party of a call session
Forwarding parameters.
Forwarding parameters.
Identifier of a call party the call will be forwarded to.
Query parameters for operation getAccountRecordings
Query parameters for operation getBridgeByPstnPin
Query parameters for operation getBridgeByWebPin
Query parameters for operation getBridge
Account information
Query parameters for operation getExtensionEmergencyLocations
Query parameters for operation getExtensionRecordings
Information on extension, for which this presence data is returned
Greeting's answering rule id
Information on language used for telephony greetings
This grouping allows to specify the `groupByMembers` option.
This grouping allows to specify the `groupByMembers` option.
Meeting host
Meeting host information
The internal IDs of RC-authenticated users.
Notification payload body
The attribute declaration to indicate webinar session participant/invitee role
The internal IDs of RC-authenticated users.
The attribute declaration to indicate webinar session participant/invitee role
For 'Connect' or 'Voicemail' actions only.
Prompt metadata
Site data
Additional info about the key
User interface language data
Note last modification information
Query parameters for operation listA2PBatches
Query parameters for operation listA2PSMS
Query parameters for operation listAccountMeetingRecordings
Query parameters for operation listAccountPhoneNumbers
Query parameters for operation listAccountPhoneNumbersV2
Query parameters for operation listAccountSwitches
Query parameters for operation listAnsweringRules
Query parameters for operation listAssignedRoles
Query parameters for operation listAutomaticLocationUpdatesUsers
Query parameters for operation listBlockedAllowedNumbers
Query parameters for operation listCallMonitoringGroupMembers
Query parameters for operation listCallMonitoringGroups
Query parameters for operation listCallQueueMembers
Query parameters for operation listCallQueues
Query parameters for operation listCallRecordingCustomGreetings
Query parameters for operation listChatNotesNew
Query parameters for operation listChatTasksNew
Query parameters for operation listCompanyActiveCalls
Query parameters for operation listCompanyAnsweringRules
Query parameters for operation listContacts
Query parameters for operation listCountries
Query parameters for operation listDataExportTasksNew
Query parameters for operation listDepartmentMembers
Query parameters for operation listDevicesAutomaticLocationUpdates
Query parameters for operation listDirectoryEntries
Query parameters for operation listDomesticCountries
Query parameters for operation listEmergencyLocations
Query parameters for operation listExtensionActiveCalls
Query parameters for operation listExtensionDevices
Query parameters for operation listExtensionGrants
Query parameters for operation listExtensionPhoneNumbers
Query parameters for operation listExtensions
Query parameters for operation listFavoriteChatsNew
Query parameters for operation listFaxCoverPages
Query parameters for operation listForwardingNumbers
Query parameters for operation listGlipChatsNew
Query parameters for operation listGlipConversationsNew
Query parameters for operation listGlipTeamsNew
Query parameters for operation listLocations
Query parameters for operation listMessages
Query parameters for operation listNetworks
Query parameters for operation listPagingGroupDevices
Query parameters for operation listPagingGroupUsers
Query parameters for operation listPermissionCategories
Query parameters for operation listPermissions
Query parameters for operation listRecentChatsNew
Query parameters for operation listStandardGreetings
Query parameters for operation listStandardUserRole
Query parameters for operation listStates
Query parameters for operation listTimezones
Query parameters for operation listUserAssignedRoles
Query parameters for operation listUserMeetingRecordings
Query parameters for operation listUserRoles
Query parameters for operation listUserTemplates
Query parameters for operation listVideoMeetings
Query parameters for operation listWirelessPoints
Information on a state this location belongs to
Emergency address assigned to the switch.
Returned for the note being edited (locked) at the current moment.
Instance id of the caller.
Phone number of the called party.
Phone number which will be displayed to the called party
Phone number of a caller.
Phone number of a called party.
Optional.
Meeting information
Meeting links
Meetings page
Canonical URI for the corresponding page of the list
Timing of a meeting
Batch of A2P SMS messages.
Batch of A2P SMS messages.
Single individual SMS resource
Complete details of the message
Notification payload body
The short detail of the message in the get batch response
List of messages retrieved for an account and other filter criteria such as `batchId` and `fromPhoneNumber` specified in the request
Message status parameters
The messages status object with details of each status
Message sender information.
Sender information
Information on navigation
Canonical URI for the corresponding page of the list
Information on paging
Specifies an extension (a calling group) which should be used for the missed call transfer.
Specifies an external PSTN number which should be used for the missed call transfer.
Specifies behavior for the missed call scenario.
HardPhone model information
Notification delivery transport information
Notification delivery transport information
Information on a notification
Site Fax/SMS recipient (operator) reference.
Represents a failure of adding opt-out / opt-in.
Consists of `from` field and `optOuts` and `optIns` lists.
The results of adding opt-outs and opt-ins
The list of opt outs
Opt-out record
Role assigned to participant when invite was sent or during join time (if an invite was not sent)
Session origin details
Deprecated.
Links to other pages of the current result set
Sender of a pager message.
Paging information
Pagination details
Standard error response which may include parameterized errors
Call park information
Query parameters for operation parsePhoneNumber
Participant information
The internal IDs of RC-authenticated users.
The internal IDs of RC-authenticated users.
The internal IDs of RC-authenticated users.
Party update data
Query parameters for operation patchContact
Either `readStatus` or `availability` or both are required
Query parameters for operation patchNoteNew
Query parameters for operation pauseResumeCallRecording
Peer session/party details.
Admin permission
International Calling permission
Brief information on a phone number country
To be used for direct number assignment in case number pool is not supported
To be used to assign a number by ID
To use as selection hint when a "toll" number to be selected from the number pool.
To use as selection criteria when a number to be selected from the number pool.
Phone number information
Postal address/location
Call queue information
Information on navigation
Canonical URI for the corresponding page of the list
Information on paging
Primary call session information.
Information on profile image
For 'TextToSpeech' mode only.
Site data.
Queue settings applied for department (call queue) extension type,
with the 'AgentQueue' value specified as a call handling action
Queue opportunities data for the specified grouping
Query parameters for operation rcvListDelegators
Query parameters for operation rcwConfigListAllCompanySessions
Query parameters for operation rcwConfigListAllSessions
Query parameters for operation rcwConfigListInvitees
Query parameters for operation rcwConfigListWebinars
Query parameters for operation rcwHistoryAdminListRecordings
Query parameters for operation rcwHistoryGetRecordingDownload
Query parameters for operation rcwHistoryListAllCompanySessions
Query parameters for operation rcwHistoryListAllSessions
Query parameters for operation rcwHistoryListInvitees
Query parameters for operation rcwHistoryListParticipants
Query parameters for operation rcwHistoryListRecordings
The internal IDs of RC-authenticated users.
Query parameters for operation rcwRegGetRegistrant
Query parameters for operation rcwRegListRegistrants
The attribute declaration to indicate webinar session participant/invitee role
Query parameters for operation readA2PSMSOptOuts
Query parameters for operation readAccountGreetingContent
Query parameters for operation readAccountPresence
Query parameters for operation readAnsweringRule
Query parameters for operation readAuthorizationProfile
Query parameters for operation readCallRecordingContent
Query parameters for operation readCallSessionStatus
Query parameters for operation readCompanyCallLog
Query parameters for operation readCompanyCallRecord
Query parameters for operation readConferencingSettings
Query parameters for operation readDevice
Query parameters for operation readDirectoryFederation
Query parameters for operation readEmergencyLocation
Query parameters for operation readExtensionCallQueuePresence
Query parameters for operation readExtensionFeatures
Query parameters for operation readGlipEventsNew
Query parameters for operation readGlipPostsNew
Query parameters for operation readGreetingContent
Query parameters for operation readIVRPromptContent
Query parameters for operation readMessageContent
Query parameters for operation readScaledProfileImage
Query parameters for operation readUserCallLog
Query parameters for operation readUserCallRecord
Query parameters for operation readUserPresenceStatus
Reason for the feature unavailability.
Recipient data
Recording information
Recordings preferences
Information on a language set as regional
Regional data (timezone, home country, language) of an extension/account.
The rejected recipient details
Paging information
Query parameters for operation revokeToken
RingOut status information
Schedule when an answering rule should be applied
Schedule when an answering rule is applied
Scheduling meeting settings locked on account level || Settings defining how to schedule user meetings
Resource metadata
Query parameters for operation scimSearchViaGet2
Query parameters for operation searchDirectoryEntries
Extension Type.
Request body for operation sendWelcomeEmailV2
Account service information, including brand, sub-brand, service plan and
billing plan
Internal RC "brand" information
Billing package information
Service Plan information (billing package, brand, etc.)
Information on account service plan
SharedLines call handling action settings
Shipping address for the order.
Shipping information, according to which devices (in case of HardPhone)
or e911 stickers (in case of SoftPhone and OtherPhone) will be delivered
to the customer
Devices shipping method.
Devices shipping method.
Account sign up data
SIP flags information
Emergency response location settings of a device
Company emergency response location details
Keys handling settings
Extension information
Extension information
Keys handling settings
Top IVR Menu extension.
Top IVR Menu extension
Site Fax/SMS recipient (operator) reference.
Site extension information
Target number country information.
Information specified in request
Optional information to be used when account is moved to "Disabled" status
Swap device request
Query parameters for operation syncAccountCallLog
Query parameters for operation syncAddressBook
Sync type, token and time
Query parameters for operation syncMessages
Query parameters for operation syncUserCallLog
Personal contact information
Information on account target service plan
Task detailed result.
Notification payload body
Temporary phone number, if any.
A list of time-value points of call data as per the grouping and filtering options specified in the request
Counters and timers options for calls breakdown
Options for selecting breakdown for calls count
Options for selecting breakdown for calls duration
Time range for the request
Date-time range for the calls.
Filtering of calls based on the time spent by specified mailbox(es) on call
Extension timezone information
Post data.
Note creator information
Transfer extension settings, set/returned if `callHandlingAction` is specified as `TransferToExtension`
Transfer extension settings, set/returned if `callHandlingAction` is specified as `TransferToExtension`
Identifier of a call party the call will be transferred to.
Account sub-brand information
Unconditional forwarding parameters.
Returned if *Glip* feature is switched on
Returned if *Meetings* feature is switched on
Returned if *BLF* feature is switched on
Query parameters for operation updateContact
Query parameters for operation updateDevice
The attribute declaration to indicate webinar session participant/invitee role
Request body for operation updateUserProfileImage
Schedule when an answering rule is applied
Information on address book groups
Information on navigation
Canonical URI for a corresponding page of a list
Information on paging
Meeting recording settings locked on account level
Information on the extension, to which the phone number is assigned.
For NotActivated extensions only.
Specifies whether to take a voicemail and who should do it
Notification payload body
The internal IDs of RC-authenticated users.
Various settings which define behavior of this Webinar's Sessions
Various settings which define behavior of this Webinar's Sessions
Weekly schedule