Package com.ringcentral.definitions
package com.ringcentral.definitions
-
ClassesClassDescriptionEvent initiator infoAction target object (company/extension)Limits which are effective for the accountOperator extension information.Notification payload bodyRegional data (timezone, home country, language) of an extension/account.Account service information, including brand, service plan and billing planAccount service information, including brand, service plan and billing planOptional information to be used when account is moved to "Disabled" statusAn 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 roleAdditional call session information.Information on a task for adding multiple contacts to multiple extensionsDescription of an error occurred during request processing.Format of response in case that any error occurred during request processingMeeting informationMeetings pageAllows more granular control over time included in the reportQuery parameters for operation aggregateA2PSMSStatusesAggregation resultThis field provides mapping of possible breakdown options for call aggregation and aggregation formulaThe formula is defined by `aggregationType` and `aggregationInterval` for every counter individually.The formula is defined by `aggregationType` and `aggregationInterval` for every timer individually.Alert informationData for all callsQuery parameters for operation analyticsCallsAggregationFetchQuery parameters for operation analyticsCallsTimelineFetchThis parameter is not supported for all User type extensions if the new call handling service is activated on accountNotification delivery transport informationNotification delivery transport informationNotification delivery transport informationNotification delivery transport informationGeneralized API error structure suitable for any error typeStandard error response model which is returned in case of any unsuccessful operationGeneralized API error structure suitable for any error typeAPNS (Apple Push Notification Service) informationAPS (Apple Push Service) information/ priority dataError responseInformation on a country assigned to an extension user.Attachment is a file to be uploadedFor 'Audio' mode only.Token endpoint request parameters used in the "Authorization Code" and "Authorization code with PKCE" flows with the `authorization_code` grant typeQuery parameters for operation authorizeHardPhone model informationSite data.Controls whether recording can be auto sharedSpecifies a background image oa a card.Sender/initiator caller informationBase schema for call log parties and history call log partiesBase schema for CallLogRecord and CallLogRecordLegInfoTarget caller informationPersonal contact informationPersonal contact informationMeeting informationPaging informationBasic participant informationThe list of batches retrieved for an account and other filter criteria such as fromPhoneNumber, date specified in the request.Describes request for user extension provisioningDescribes request for user extension provisioningBilling information related to the call.Information on account billing planBilling information.Information on a blocked/allowed phone numberList of blocked or allowed phone numbersInformation on account brandInformation about an extension this device is assigned toCompany business addressQuery parameters for operation caiAnalyzeInteractionQuery parameters for operation caiEnrollmentsListQuery parameters for operation caiPunctuateQuery parameters for operation caiSpeakerDiarizeQuery parameters for operation caiSpeakerIdentifyQuery parameters for operation caiSpeechToTextQuery parameters for operation caiSummarizeFiltering of calls based on the overall call lengthReturns the lists of blocked and allowed phone numbersReturns the lists of blocked and allowed phone numbersCaller ID settings by deviceCaller ID settings by deviceCaller ID settings by featureCaller ID settings by featureOptional filters that limit the scope of calls (joined via AND)Primary/additional CQ informationInformation on a delegate extension that actually implemented a call action.Sender/initiator caller informationBase schema for CallLogFromParty and CallLogToPartyCall log recordCall recording data.Call leg recordLinked message (Fax/Voicemail)Target caller informationInformation on a party of a call sessionFor Call Queue extension type only.Call queue informationFor Call Queue extension type only.Call queue member informationCall queue member informationNotification payload bodyCall queue service level settingsCustom greeting dataCustom greeting languageReturns data on call recording custom greetings.Data for calls with breakdown by action (HoldOff, HoldOn, ParkOn, ParkOff, BlindTransfer, WarmTransfer, DTMFTransfer)Result breakdown by actionsData for calls with breakdown by company hours (BusinessHours, AfterHours)Result breakdown by company hoursData for calls with breakdown by direction (Inbound, Outbound)Result breakdown by directionData for calls with breakdown by origin (Internal, External)Result breakdown by originData for calls with breakdown by queue hours (BusinessHours, AfterHours)Result breakdown by queue hoursData for calls with breakdown by queue SLA (InSLA, OutSLA).Result breakdown by queue SLAData for calls with breakdown by response (Answered, NotAnswered, Connected, NotConnected)Result breakdown by responseData for calls with breakdown by result (Completed, Abandoned, Voicemail, Unknown, Missed, Accepted)Result breakdown by call resultData for calls with breakdown by segments (Ringing, LiveTalk, Hold, Park, Transfer, IvrPrompt, Voicemail, VmGreeting, Setup)Result breakdown by segmentsData for calls with breakdown by type (Direct, FromQueue, ParkRetrieval, Transferred, Outbound, Overflow)Result breakdown by typeCall volume data for the specified groupingDuration bounds for the segmentCall session informationStatus data of a call sessionCall length data for the specified groupingQuery parameters for operation checkUserPermissionToken endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant typeToken endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant typeToken endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant typeToken endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant typeToken endpoint request parameters used in the "Client Credentials" authorization flow with the `client_credentials` grant typeMeeting informationRecordings pageAction informationAction informationAll Desktop Ring targetAll Desktop Ring targetAll Desktop Ring targetAll Desktop Ring targetAll Desktop Ring targetAll Mobile Ring targetAll Mobile Ring targetAll Mobile Ring targetAll Mobile Ring targetAll Mobile Ring targetCoworker apps targetCoworker apps targetRing targetRing targetRing targetRing targetRing targetCaller ID informationInteraction rule create requestInteraction ruleInteraction rule update requestCompany emergency response location detailsAction informationAction informationAction informationAction informationAction informationAction informationAction informationAction informationAction informationAction informationAction informationAction informationState-based rule informationState-based rule informationState-based rule update requestAction informationAction informationExtension to which the call is forwarded in 'Bypass' modeSchedule when an answering rule should be appliedSchedule when an answering rule should be appliedWeekly schedule.Schedule when an answering rule is appliedUser's business address.CCRN (Contact Center Routing Number) provider.Detailed contact informationContact InformationSMS and Pager only.Cost center information.Request body for operation createCompanyGreetingQuery parameters for operation createContactQuery parameters for operation createCustomRoleQuery parameters for operation createCustomUserGreetingRequest body for operation createCustomUserGreetingRequest body for operation createFaxMessageForwarding device information.Query parameters for operation createGlipFileNewRequest body for operation createGlipFileNewRequest body for operation createIVRPromptInformation on a task for multiple switches creationRequest body for operation createUserProfileImageTask creator informationCurrency informationInformation on a greeting language.Information on an answering rule that the greeting is applied toList of users whose data is collected.Query parameters for operation deleteCustomRoleQuery parameters for operation deleteEmergencyLocationQuery parameters for operation deleteExtensionEmergencyLocationQuery parameters for operation deleteExtensionQuery parameters for operation deleteMessageByFilterQuery parameters for operation deleteMessageA list of records for deleting SMS consentsThe indication of a number to be deleted - either `id` or `phoneNumber` must be specified.Query parameters for operation deleteUserCallLogPlease note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminologyPlease note that the `Department` extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminologyPlease note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminologyNotification payload bodyNotification payload bodyToken endpoint request parameters used in the "Device Authorization" flow with the `urn:ietf:params:oauth:grant-type:device_code` grant typeDevice emergency settingsCompany emergency response location detailsAddress for emergency cases.Address for emergency cases.Address for emergency cases.Device informationHardPhone model informationBrief information on a phone number countryPhone number informationInformation on the extension, to which the phone number is assigned.Site dataInformation on extension that the device is assigned toInformation on phone lines added to a deviceThis grouping allows to specify the `groupBy` option by which the data in the response will be groupedEmergency response location informationCompany emergency response location detailsAddress for emergency cases.Address for emergency cases.Emergency response location informationSingle (of potential multiple) error entry in an ASG error responseControls whether participants can start and pause recordingList of extensions to be updatedInformation on a task for updating multiple extensionsResulting record of a task on multiple extensions updateNotification payload bodySpecifies filtering based on extension idsNotification payload bodyInformation on the extension, to which the phone number is assigned.Information about extension on whose behalf a call is initiated.Notification payload bodyExtension informationThis attribute can be omitted for unassigned devicesNotification payload bodyExtension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'Regional data (timezone, home country, language) of an extension.Status information (reason, comment).Query parameters for operation extractSyncAccountCallLogFax receiverFormatting language preferences for numbers, dates and currenciesInformation on a party of a call sessionForwarding parameters.Forwarding parameters.Identifier of a call party the call will be forwarded to.Query parameters for operation getAccountRecordingsQuery parameters for operation getBridgeByPstnPinQuery parameters for operation getBridgeByWebPinQuery parameters for operation getBridgeAccount informationQuery parameters for operation getExtensionEmergencyLocationsQuery parameters for operation getExtensionRecordingsInformation on extension, for which this presence data is returnedQuery parameters for operation getRecordingInsightsQuery parameters for operation getSessionInsightsToken endpoint request parameters used in the "Guest" authorization flow with the `guest` grant typeGreeting's answering rule idInformation on language used for telephony greetingsThis grouping allows to specify the `groupByMembers` option.This grouping allows to specify the `groupByMembers` option.Token endpoint request parameters used in the "Guest" authorization flow with the `guest` grant typeMeeting hostThe internal IDs of RC-authenticated users.Notification payload bodyToken endpoint request parameters used in the "Guest" authorization flow with the `guest` grant typeThe attribute declaration to indicate webinar session participant/invitee roleThe internal IDs of RC-authenticated users.The attribute declaration to indicate webinar session participant/invitee roleFor 'Connect' or 'Voicemail' actions only.Prompt metadataSite dataToken endpoint request parameters used in the "IVR Pin" authorization flow with the `ivr_pin` grant typePublic key definition in JWK format (see [RFC-7517](https://www.rfc-editor.org/rfc/rfc7517.html#section-4))Token endpoint request parameters used in the "Personal JWT", "JWT Bearer" and "Partner JWT" authorization flows with the `urn:ietf:params:oauth:grant-type:jwt-bearer` and `partner_jwt` grant typesAdditional info about the keyUser interface language dataNote last modification informationQuery parameters for operation listA2PBatchesQuery parameters for operation listA2PSMSQuery parameters for operation listAccountMeetingsQuery parameters for operation listAccountPhoneNumbersQuery parameters for operation listAccountPhoneNumbersV2Query parameters for operation listAccountSwitchesQuery parameters for operation listAnsweringRulesQuery parameters for operation listAssignedRolesQuery parameters for operation listAutomaticLocationUpdatesUsersQuery parameters for operation listBlockedAllowedNumbersQuery parameters for operation listCallMonitoringGroupMembersQuery parameters for operation listCallMonitoringGroupsQuery parameters for operation listCallQueueMembersQuery parameters for operation listCallQueuesQuery parameters for operation listCallRecordingCustomGreetingsQuery parameters for operation listChatNotesNewQuery parameters for operation listChatTasksNewQuery parameters for operation listCicStatesQuery parameters for operation listCompanyActiveCallsQuery parameters for operation listCompanyAnsweringRulesQuery parameters for operation listCompanyMessageTemplatesQuery parameters for operation listContactsQuery parameters for operation listCountriesQuery parameters for operation listDataExportTasksNewQuery parameters for operation listDepartmentMembersQuery parameters for operation listDevicesAutomaticLocationUpdatesQuery parameters for operation listDirectoryEntriesQuery parameters for operation listDomesticCountriesQuery parameters for operation listEmergencyLocationsQuery parameters for operation listExtensionActiveCallsQuery parameters for operation listExtensionDevicesQuery parameters for operation listExtensionGrantsQuery parameters for operation listExtensionPhoneNumbersQuery parameters for operation listExtensionsQuery parameters for operation listFavoriteChatsNewQuery parameters for operation listFaxCoverPagesQuery parameters for operation listForwardingNumbersQuery parameters for operation listGlipChatsNewQuery parameters for operation listGlipConversationsNewQuery parameters for operation listGlipTeamsNewQuery parameters for operation listLocationsQuery parameters for operation listMessagesQuery parameters for operation listNetworksQuery parameters for operation listOfAvailableForAssigningRolesQuery parameters for operation listPagingGroupDevicesQuery parameters for operation listPagingGroupUsersQuery parameters for operation listPermissionCategoriesQuery parameters for operation listPermissionsQuery parameters for operation listRecentChatsNewQuery parameters for operation listSmsConsentRecordsQuery parameters for operation listStandardGreetingsQuery parameters for operation listStandardUserRoleQuery parameters for operation listStatesQuery parameters for operation listTimezonesQuery parameters for operation listUserAssignedRolesQuery parameters for operation listUserMessageTemplatesQuery parameters for operation listUserRolesQuery parameters for operation listUserTemplatesQuery parameters for operation listVideoMeetingsQuery parameters for operation listVoiceInteractionRulesQuery parameters for operation listVoiceStateBasedRulesQuery parameters for operation listWirelessPointsInformation on a state this location belongs toEmergency 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 partyPhone number of a caller.Phone number of a called party.Optional.Meeting informationMeetings pageBatch of A2P SMS messages.Batch of A2P SMS messages.Single individual SMS resourceComplete details of the messageNotification payload bodyThe short detail of the message in the get batch responseList of messages retrieved for an account and other filter criteria such as `batchId` and `fromPhoneNumber` specified in the requestMessage status parametersThe messages status object with details of each statusMessage sender information.Sender informationText message template informationInformation on navigationCanonical URI for the corresponding page of the listInformation on pagingCall metadata.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 informationNotification delivery transport informationNotification delivery transport informationInformation on a notificationThe OpenID Connect configuration document as defined by the [OpenID Connect Discovery 1.0](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata) specificationSite 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-insThe list of opt outsOpt-out recordA list of SMS consent recordsRole assigned to participant when invite was sent or during join time (if an invite was not sent)Session origin detailsToken endpoint request parameters used in the "One-time Password" (OTP) authorization flow with the `otp` grant typeDeprecated.Message owner information.Links to other pages of the current result setSender of a pager message.Paging informationStandard error response which may include parameterized errorsCall park informationQuery parameters for operation parsePhoneNumberBasic participant informationThe internal IDs of RC-authenticated users.The internal IDs of RC-authenticated users.The internal IDs of RC-authenticated users.Party update dataQuery parameters for operation patchContactEither `readStatus` or `availability` or both are requiredQuery parameters for operation patchNoteNewQuery parameters for operation pauseResumeCallRecordingPeer (linked) session/party details.Admin permissionInternational Calling permissionAdvanced permissions capabilities.Brief information on a phone number countryTo be used for direct number assignment in case number pool is not supportedTo be used to assign a number by IDTo 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 informationPostal address/locationCall queue informationInformation on navigationCanonical URI for the corresponding page of the listInformation on pagingPrimary call session information.Information on profile imageFor 'TextToSpeech' mode only.Site data.Token endpoint request parameters used in the "Refresh Token" flow with the `refresh_token` grant typeQueue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling actionQueue opportunities data for the specified groupingQuery parameters for operation rcwConfigListAllCompanySessionsQuery parameters for operation rcwConfigListAllSessionsQuery parameters for operation rcwConfigListInviteesQuery parameters for operation rcwConfigListWebinarsQuery parameters for operation rcwHistoryAdminListRecordingsQuery parameters for operation rcwHistoryGetRecordingDownloadQuery parameters for operation rcwHistoryListAllCompanySessionsQuery parameters for operation rcwHistoryListAllSessionsQuery parameters for operation rcwHistoryListInviteesQuery parameters for operation rcwHistoryListParticipantsQuery parameters for operation rcwHistoryListRecordingsThe internal IDs of RC-authenticated users.Query parameters for operation rcwRegGetRegistrantQuery parameters for operation rcwRegListRegistrantsThe attribute declaration to indicate webinar session participant/invitee roleQuery parameters for operation readA2PSMSOptOutsQuery parameters for operation readAccountGreetingContentQuery parameters for operation readAccountPresenceQuery parameters for operation readAnsweringRuleQuery parameters for operation readAuthorizationProfileQuery parameters for operation readCallRecordingContentQuery parameters for operation readCallSessionStatusQuery parameters for operation readCompanyCallLogQuery parameters for operation readCompanyCallRecordQuery parameters for operation readConferencingSettingsQuery parameters for operation readDeviceQuery parameters for operation readDirectoryEntryQuery parameters for operation readDirectoryFederationQuery parameters for operation readEmergencyLocationQuery parameters for operation readExtensionCallQueuePresenceQuery parameters for operation readExtensionFeaturesQuery parameters for operation readForwardingTargetsQuery parameters for operation readGlipEventsNewQuery parameters for operation readGlipPostsNewQuery parameters for operation readGreetingContentQuery parameters for operation readIVRPromptContentQuery parameters for operation readMessageContentQuery parameters for operation readScaledProfileImageQuery parameters for operation readUserCallLogQuery parameters for operation readUserCallRecordQuery parameters for operation readUserPresenceStatusQuery parameters for operation readUserRoleReason for the feature unavailability.Recipient dataRecording informationRecordings preferencesToken endpoint request parameters used in the "Refresh Token" flow with the `refresh_token` grant typeInformation on a language set as regionalRegional data (timezone, home country, language) of an extension/account.The rejected recipient detailsPaging informationQuery parameters for operation revokeTokenRingOut status informationToken endpoint request parameters used in the "Password" (also known as "Resource Owner Password Credentials" - ROPC) authorization flow with the `password` grant typeSchedule when an answering rule should be appliedSchedule when an answering rule is appliedResource metadataQuery parameters for operation scimSearchViaGet2Query parameters for operation searchDirectoryEntriesExtension Type.Request body for operation sendWelcomeEmailV2Account service information, including brand, sub-brand, service plan and billing planInternal RC "brand" informationBilling package informationInformation on account service planAccount sub-brand informationService Plan information (billing package, brand, etc.)Information on account service planSharedLines call handling action settingsShipping 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 customerDevices shipping method.Devices shipping method.Account sign up dataSIP (Session Initiation Protocol) information.SIP flags informationEmergency response location settings of a deviceCompany emergency response location detailsSpecifies a site that message template is associated with.Keys handling settingsExtension informationTop IVR Menu extension.Top IVR Menu extensionSite Fax/SMS recipient (operator) reference.Target number country information.Information specified in requestSwap device requestQuery parameters for operation syncAccountCallLogQuery parameters for operation syncAddressBookSync type, token and timeQuery parameters for operation syncMessagesQuery parameters for operation syncUserCallLogPersonal contact informationTask informationTask detailed result.Notification payload bodyTemporary phone number, if any.A list of time-value points of call data as per the grouping and filtering options specified in the requestCounters and timers options for calls breakdownOptions for selecting breakdown for calls countOptions for selecting breakdown for calls durationTime range for the requestDate-time range for the calls.Filtering of calls based on the time spent by specified mailbox(es) on callTimezone informationFile informationPost data.Note creator informationOne utterance of a call.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 informationCall information on user interfaceUnconditional forwarding parameters.Returned if *Glip* feature is switched onReturned if *Meetings* feature is switched onReturned if *BLF* feature is switched onQuery parameters for operation updateContactQuery parameters for operation updateDeviceThe attribute declaration to indicate webinar session participant/invitee roleA list of records for updating SMS consentsRequest body for operation updateUserProfileImageQuery parameters for operation updateUserRoleSchedule when an answering rule is appliedInformation on address book groupsInformation on navigationCanonical URI for a corresponding page of a listInformation on pagingInformation on the extension, to which the phone number is assigned.For `NotActivated` extensions only.Specifies whether to take a voicemail and who should do itNotification payload bodyThe internal IDs of RC-authenticated users.Various settings which define behavior of this Webinar's SessionsVarious settings which define behavior of this Webinar's SessionsWeekly schedule