RingCentral Python SDK 1.0.0
Welcome to the RingCentral SDK documentation. This guide will help you get started with integrating and using the RingCentral SDK in your project.
Versions
- API version:
1.0.58-20240529-47eda8bd - SDK version:
1.0.0
About the API
RingCentral API specification
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: Python >= 3.7
Installation
To get started with the SDK, we recommend installing using pip:
pip install ring-central-client
Authentication
Access Token Authentication
The RingCentral API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
Setting the Access Token
When you initialize the SDK, you can set the access token as follows:
RingCentral(
access_token="YOUR_ACCESS_TOKEN"
)
If you need to set or update the access token after initializing the SDK, you can use:
sdk.set_access_token("YOUR_ACCESS_TOKEN")
Using Union Types
Union types allow you to specify that a variable can have more than one type. This is particularly useful when a function can accept multiple types of inputs. The Union type hint is used for this purpose.
Example Function with Union Types
You can call service method with an instance of TypeA, TypeB, or a dictionary that can be converted to an instance of either type.
# Model Definition
ParamType = Union[TypeA, TypeB]
# Service Method
def service_method(param: ParamType):
...
## Usage
type_a = TypeA(key="value")
type_b = TypeB(key="value")
sdk.service.service_method(type_a)
sdk.service.service_method(type_b)
sdk.service.service_method({"key": "value"})
You cannot create an instance of a Union type itself. Instead, pass an instance of one of the types in the Union, or a dictionary that can be converted to one of those types.
Services
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
| Name | Description |
|---|---|
| SubscriptionListResource | |
| CreateWebhookSubscriptionRequest | |
| SubscriptionInfo | |
| UpdateSubscriptionRequest | |
| WebinarResource | |
| SessionResource | |
| ParticipantListResource | |
| RcwRoleEnum | The role of the webinar session participant/invitee. See also: Understanding Webinar Roles |
| ParticipantReducedModel | |
| InviteeListResource | |
| InviteeModel | |
| SessionGlobalListResource | |
| RcwSessionStatusModel | Webinar session status |
| RecordingAdminListResource | |
| RecordingStatusModel | Recording status |
| RecordingAdminExtendedItemModel | |
| RecordingListResource | |
| RecordingItemExtendedModel | |
| RecordingDownloadModel | |
| RecordingMediaType | Recording file media type. 'Video' implies multiplexed audio and video. 'Audio' refers to audio only. |
| RegSessionModel | |
| RegistrantListResource | |
| RegistrantBaseModelWithQuestionnaire | |
| RegistrantModelResponsePostWithQuestionnaire | |
| RegistrantModelWithQuestionnaire | |
| WebinarListResource | |
| WebinarCreationRequest | |
| WcsWebinarResource | |
| WebinarBaseModel | |
| WcsSessionWithLocaleCodeModel | |
| WcsSessionResource | |
| WcsSessionGlobalListResource | |
| WcsSessionStatusModel | Session status (for the purposes of Configuration service) |
| WcsInviteeListResource | |
| BulkUpdateInviteesRequest | |
| BulkUpdateInviteesResponse | |
| InviteeResource | |
| UpdateInviteeRequest | |
| ContentDisposition | |
| CallRecordingIds | |
| GetCallRecordingResponse | |
| GreetingsCreateCompanyGreetingRequest_1 | |
| GreetingsCreateCompanyGreetingRequest_2 | |
| CustomCompanyGreetingInfo | |
| GreetingsCreateCustomUserGreetingRequest_1 | |
| GreetingsCreateCustomUserGreetingRequest_2 | |
| CustomUserGreetingInfo | |
| DictionaryGreetingList | |
| ListStandardGreetingsType | |
| ListStandardGreetingsUsageType | |
| DictionaryGreetingInfo | |
| ScaleSize | |
| BatchProvisionUsersRequest | Describes request for user extension provisioning |
| BatchProvisionUsersResponse | |
| BulkDeleteUsersRequest | |
| BulkDeleteUsersResponse | |
| GetExtensionInfoResponse | |
| ExtensionUpdateRequest | |
| GetExtensionGrantListResponse | |
| ExtensionType | |
| GetConferencingInfoResponse | |
| UpdateConferencingInfoRequest | |
| CreateUserProfileImageRequest | |
| UpdateUserProfileImageRequest | |
| ExtensionCallerIdInfo | |
| ExtensionCallerIdInfoRequest | |
| NotificationSettings | |
| NotificationSettingsUpdateRequest | |
| MessageStoreConfiguration | |
| GetMessageSyncResponse | |
| MessageDirectionEnum | Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound |
| MessageTypeEnum | Type of the message |
| SyncTypeEnum | Type of message synchronization request: - FSync -- full sync - ISync -- incremental sync |
| GetMessageList | |
| MessageAvailabilityEnum | Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly |
| MessageReadStatusEnum | Message read status |
| DeleteMessageByFilterType | |
| GetMessageInfoResponse | |
| GetMessageInfoMultiResponse | |
| UpdateMessageRequest | |
| UpdateMessageBulkRequest | |
| PatchMessageRequest | Either readStatus or availability or both are required |
| PatchMessageBulkRequest | |
| IvrPrompts | |
| CreateIvrPromptRequest | |
| PromptInfo | |
| UpdateIvrPromptRequest | |
| IvrMenuList | |
| IvrMenuInfo | |
| CreateBridgeRequest | |
| BridgeResponse | |
| UpdateBridgeRequest | |
| CloudRecordings | Recordings page |
| DelegatorsListResult | |
| MeetingPage | Meetings page |
| ListVideoMeetingsType | |
| Meeting | Meeting information |
| ApiVersionsList | |
| ApiVersionInfo | |
| GetTokenRequest | |
| TokenInfo | |
| AuthorizeResponseType | |
| DisplayModesEnum | Specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. |
| CodeChallengeMethodEnum | The code challenge method as defined by the PKCE specification - RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients" |
| AuthorizeRequest | |
| RevokeTokenRequest | |
| AccountInfo | |
| SendWelcomeEmailV2Request | |
| GetAccountInfoResponse | |
| AccountServiceInfo | |
| AccountBusinessAddressResource | |
| ModifyAccountBusinessAddressRequest | |
| ContractedCountryListResponse | |
| CountryListDictionaryModel | |
| AddDeviceToInventoryRequest | |
| AddDeviceToInventoryResponse | |
| DeleteDeviceFromInventoryRequest | |
| DeleteDeviceFromInventoryResponse | |
| RemoveLineRequest | |
| RemoveLineResponse | |
| BulkAddDevicesRequest | |
| BulkAddDevicesResponse | |
| SwapDeviceRequest | Swap device request |
| DeviceResource | |
| AccountDeviceUpdate | |
| SipInfoResource | |
| GetExtensionDevicesResponse | |
| LinePooling | |
| DeviceFeatureEnum | Device feature |
| ListExtensionDevicesType | |
| PhoneLineTypeEnum | The type of phone line |
| AccountPhoneNumberList | |
| PhoneNumberType | Type of phone number |
| PhoneNumberUsageType | Usage type of phone number |
| PhoneNumberStatus | Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral |
| PhoneNumberTollType | Indicates if a number is toll or toll-free |
| ExtensionStatus | Extension status |
| DeletePhoneNumbersRequest | |
| DeletePhoneNumbersResponse | |
| AssignPhoneNumberRequest | |
| AccountPhoneNumberInfo | |
| ReplacePhoneNumberRequest | |
| AddPhoneNumbersRequest | |
| AddPhoneNumbersResponse | |
| AddPhoneNumbersTask | |
| GetExtensionPhoneNumbersResponse | |
| ListExtensionPhoneNumbersStatus | |
| ListExtensionPhoneNumbersUsageType | |
| AccountPhoneNumbers | |
| ListAccountPhoneNumbersUsageType | |
| PlatformPaymentType | Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system |
| ListAccountPhoneNumbersStatus | |
| CompanyPhoneNumberInfo | |
| ParsePhoneNumberRequest | |
| ParsePhoneNumberResponse | |
| CompanyBusinessHours | |
| CompanyBusinessHoursUpdateRequest | |
| GetUserBusinessHoursResponse | |
| UserBusinessHoursUpdateRequest | |
| UserBusinessHoursUpdateResponse | |
| CustomFieldList | |
| CustomFieldCreateRequest | |
| CustomFieldModel | |
| CustomFieldUpdateRequest | |
| CallRecordingSettingsResource | |
| CallRecordingCustomGreetings | Returns data on call recording custom greetings. |
| ListCallRecordingCustomGreetingsType | |
| BulkAccountCallRecordingsResource | |
| CallRecordingExtensions | |
| MakeCallOutRequest | |
| CallSession | |
| CallSessionObject | Call session information |
| AddPartyRequest | |
| CallParty | Information on a party of a call session |
| PartyUpdateRequest | |
| CallPartyFlip | |
| CallPartyReply | |
| ReplyParty | |
| BridgeTargetRequest | |
| IgnoreRequestBody | |
| PartySuperviseRequest | |
| PartySuperviseResponse | |
| CallRecordingUpdate | |
| CallRecording | |
| AnswerTarget | |
| TransferTarget | Identifier of a call party the call will be transferred to. Only one of these parameters: phoneNumber, voicemail, extensionNumber or parkOrbit must be specified, otherwise an error is returned. |
| HoldCallPartyRequest | |
| PickupTarget | |
| ForwardTarget | Identifier of a call party the call will be forwarded to. Only one of these parameters: phoneNumber, voicemail or extensionNumber must be specified, otherwise an error is returned. |
| ForwardCallPartyResponse | Information on a party of a call session |
| SuperviseCallSessionRequest | |
| SuperviseCallSessionResponse | |
| MessageTemplatesListResponse | |
| MessageTemplateRequest | |
| MessageTemplateResponse | |
| VisibilityType | Specifies if a template is available on a user (Personal) or a company (Company) level |
| CallLogResponse | |
| CallDirectionEnum | The direction of a call |
| CallTypeEnum | The type of call |
| ReadCompanyCallLogView | |
| RecordingType | |
| CallLogRecord | |
| CallLogSyncResponse | |
| SyncAccountCallLogSyncType | Type of call log synchronization request: full or incremental sync |
| StatusGroup | |
| CallTransportEnum | The type of call transport. 'PSTN' indicates that a call leg was initiated from the PSTN network provider; 'VoIP' - from an RC phone. |
| ConferenceType | |
| ExtensionBulkUpdateRequest | List of extensions to be updated |
| ExtensionBulkUpdateTaskResource | Information on a task for updating multiple extensions |
| UserTemplates | |
| ListUserTemplatesType | |
| TemplateInfo | Text message template information |
| GetExtensionListResponse | |
| ListExtensionsStatus | |
| ListExtensionsType | |
| ExtensionCreationRequest | |
| ExtensionCreationResponse | |
| MessageStatusesResponse | The messages status object with details of each status |
| SmsDirectionEnum | Direction of the SMS message |
| MessageListResponse | List of messages retrieved for an account and other filter criteria such as batchId and fromPhoneNumber specified in the request |
| ListA2PsmsView | |
| MessageDetailsResponse | Complete details of the message |
| OptOutListResponse | The list of opt outs |
| ReadA2PsmsOptOutsStatus | |
| OptOutBulkAssignRequest | Consists of from field and optOuts and optIns lists. Both optOuts and optIns can be empty but not simultaneously - at least one of the lists must be entered." |
| OptOutBulkAssignResponse | The results of adding opt-outs and opt-ins |
| BatchListResponse | The list of batches retrieved for an account and other filter criteria such as fromPhoneNumber, date specified in the request. |
| ListA2PBatchesStatus | |
| MessageBatchCreateRequest | Batch of A2P SMS messages. This object provides specification to send message(s) to many recipients. It contains top-level attributes, such as text which apply to all messages. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients. |
| MessageBatchResponse | Batch of A2P SMS messages. This object provides a specification to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients |
| CompanyAnsweringRuleList | |
| CompanyAnsweringRuleRequest | |
| CompanyAnsweringRuleInfo | |
| CompanyAnsweringRuleUpdate | |
| ForwardAllCompanyCallsInfo | |
| ForwardAllCompanyCallsRequest | |
| UserAnsweringRuleList | |
| ListAnsweringRulesType | |
| ListAnsweringRulesView | |
| CreateAnsweringRuleRequest | |
| CustomAnsweringRuleInfo | |
| AnsweringRuleInfo | |
| UpdateAnsweringRuleRequest | |
| AddressBookBulkUploadRequest | |
| AddressBookBulkUploadResponse | Information on a task for adding multiple contacts to multiple extensions |
| FavoriteContactList | |
| FavoriteCollection | |
| ContactList | |
| SortBy | |
| PersonalContactRequest | |
| PersonalContactResource | |
| AddressBookSync | |
| SyncAddressBookSyncType | |
| CallQueues | |
| CallQueueDetails | |
| CallQueueBulkAssignResource | |
| CallQueueMembers | |
| DepartmentMemberList | Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| DepartmentBulkAssignResource | Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| UserCallQueues | |
| CallQueueOverflowSettings | |
| CallQueueOverflowSettingsRequestResource | |
| CallQueuePresence | |
| CallQueueUpdatePresence | |
| AccountPresenceInfo | |
| ExtensionCallQueuePresenceList | |
| ExtensionCallQueueUpdatePresenceList | |
| GetPresenceInfo | |
| PresenceInfoRequest | |
| PresenceInfoResponse | |
| UnifiedPresence | |
| UnifiedPresenceListEntry | |
| UpdateUnifiedPresence | |
| EmergencyLocationsResource | |
| EmergencyAddressStatus | |
| EmergencyLocationUsageStatus | |
| ListEmergencyLocationsOrderBy | |
| EmergencyLocationRequestResource | |
| EmergencyLocationResponseResource | |
| CommonEmergencyLocationResource | Company emergency response location details |
| GetLocationDeletionMultiResponse | |
| GetExtensionEmergencyLocationsOrderBy | |
| CreateUserEmergencyLocationRequest | |
| AutomaticLocationUpdatesTaskInfo | |
| AutomaticLocationUpdatesUserList | |
| ListAutomaticLocationUpdatesUsersType | |
| EmergencyAddressAutoUpdateUsersBulkAssignResource | |
| CreateMultipleWirelessPointsRequest | |
| CreateMultipleWirelessPointsResponse | |
| NetworksList | |
| CreateNetworkRequest | |
| NetworkInfo | |
| UpdateNetworkRequest | |
| ValidateMultipleSwitchesRequest | |
| ValidateMultipleSwitchesResponse | |
| SwitchesList | |
| CreateSwitchInfo | |
| SwitchInfo | |
| UpdateSwitchInfo | |
| ValidateMultipleWirelessPointsRequest | |
| ValidateMultipleWirelessPointsResponse | |
| WirelessPointsList | |
| CreateWirelessPoint | |
| WirelessPointInfo | |
| UpdateWirelessPoint | |
| ListDevicesAutomaticLocationUpdates | |
| AssignMultipleDevicesAutomaticLocationUpdates | |
| CreateMultipleSwitchesRequest | |
| CreateMultipleSwitchesResponse | Information on a task for multiple switches creation |
| UpdateMultipleWirelessPointsRequest | |
| UpdateMultipleWirelessPointsResponse | |
| UpdateMultipleSwitchesRequest | |
| UpdateMultipleSwitchesResponse | |
| AccountLockedSettingResponse | |
| MeetingResponseResource | |
| ListMeetingRecordingsResponse | |
| CreateUserMeetingProfileImageRequest | |
| MeetingsResource | |
| MeetingRequestResource | |
| MeetingUserSettingsResponse | |
| PublicMeetingInvitationResponse | |
| MeetingServiceInfoResource | |
| MeetingServiceInfoRequest | |
| AssistedUsersResource | |
| AssistantsResource | |
| ExtensionWithRolesCollectionResource | |
| RolesCollectionResource | |
| RoleResource | |
| DefaultUserRole | |
| DefaultUserRoleRequest | |
| BulkRoleAssignResource | |
| AssignedRolesResource | |
| CallMonitoringGroups | |
| CreateCallMonitoringGroupRequest | |
| CallMonitoringGroup | |
| CallMonitoringBulkAssign | |
| CallMonitoringGroupMemberList | |
| AccountHistorySearchPublicRequest | |
| AccountHistorySearchPublicResponse | |
| CreateMessageStoreReportRequest | |
| MessageStoreReport | |
| MessageStoreReportArchive | |
| DirectoryResource | |
| ListDirectoryEntriesType | |
| TypeGroup | |
| ContactResource | |
| SearchDirectoryEntriesRequest | |
| SearchDirectoryExtensionType | Type of extension to filter the contacts |
| FederationResource | |
| FederationTypes | Federation types for search |
| PagingOnlyGroupUsers | |
| EditPagingGroupRequest | |
| PagingOnlyGroupDevices | |
| SitesList | |
| CreateSiteRequest | |
| SiteInfo | |
| SiteUpdateRequest | |
| SiteMembersBulkUpdate | |
| SiteMembersList | |
| SiteIvrSettings | |
| SiteIvrSettingsUpdate | |
| UserVideoConfiguration | |
| CreateInternalTextMessageRequest | |
| GetInternalTextMessageInfoResponse | |
| AuthProfileResource | |
| AuthProfileCheckResource | |
| PermissionCollectionResource | |
| PermissionResource | |
| PermissionCategoryCollectionResource | |
| PermissionCategoryResource | |
| GetExtensionForwardingNumberListResponse | |
| CreateForwardingNumberRequest | |
| ForwardingNumberInfo | |
| DeleteForwardingNumbersRequest | |
| ForwardingNumberResource | |
| UpdateForwardingNumberRequest | |
| CreateFaxMessageRequest | |
| FaxResponse | |
| ListFaxCoverPagesResponse | |
| MakeRingOutRequest | |
| GetRingOutStatusResponse | |
| BusinessSiteCollectionResource | |
| BusinessSiteCollectionRequest | |
| CreateSmsMessage | |
| GetSmsMessageInfoResponse | |
| CreateMmsMessage | |
| FeatureList | |
| CallerBlockingSettings | Returns the lists of blocked and allowed phone numbers |
| CallerBlockingSettingsUpdate | Returns the lists of blocked and allowed phone numbers |
| BlockedAllowedPhoneNumbersList | List of blocked or allowed phone numbers |
| BlockedNumberStatusEnum | Status of a phone number |
| AddBlockedAllowedPhoneNumber | Updates either blocked or allowed phone number list with a new phone number. |
| BlockedAllowedPhoneNumberInfo | Information on a blocked/allowed phone number |
| CreateSubscriptionRequest | |
| GetStateListResponse | |
| GetStateInfoResponse | |
| GetLocationListResponse | |
| ListLocationsOrderBy | |
| LanguageList | |
| LanguageInfo | User interface language data |
| GetTimezoneListResponse | |
| GetTimezoneInfoResponse | |
| CountryInfoDictionaryModel | |
| CreateSipRegistrationRequest | |
| CreateSipRegistrationResponse | |
| SummaryInput | |
| CaiAsyncApiResponse | |
| PunctuateInput | |
| ListEnrolledSpeakers | |
| EnrollmentInput | |
| EnrollmentStatus | |
| EnrollmentPatchInput | |
| AsrInput | |
| DiarizeInput | |
| IdentifyInput | |
| InteractionInput | |
| ContentList | |
| ContentStatus | Content status. |
| SocMsgCreationTimeOrder | Ordering by creationTime is descending by default. |
| CreateContentRequest | |
| ContentModel | |
| IdentitiesList | |
| IdentityModel | |
| ScimSchemaSearchResponse | |
| ScimSchemaResponse | |
| ScimUserSearchResponse | |
| ScimUser | |
| ScimUserResponse | |
| ScimSearchRequest | |
| ScimUserPatch | |
| ScimProviderConfig | |
| ScimResourceTypeSearchResponse | |
| ScimResourceTypeResponse | |
| AggregationRequest | |
| AggregationResponse | |
| TimelineRequest | |
| TimelineResponse | |
| Interval | |
| TmTaskInfo | |
| TmUpdateTaskRequest | |
| TmTaskList | |
| TmCompleteTaskRequest | |
| ListChatTasksNewStatus | |
| AssignmentStatus | |
| AssigneeStatus | |
| TmCreateTaskRequest | |
| TmEventList | |
| TmCreateEventRequest | |
| TmEventInfo | |
| TmChatListWithoutNavigation | |
| ListRecentChatsNewType | |
| TmChatList | |
| ListGlipChatsNewType | |
| TmChatInfo | |
| CreateGlipFileNewRequest | |
| TmAddFileRequest | |
| TmPostsList | |
| TmCreatePostRequest | Post data. At least one attribute should be provided (text or attachments) |
| TmPostInfo | |
| TmUpdatePostRequest | |
| AdaptiveCardRequest | |
| AdaptiveCardShortInfo | |
| AdaptiveCardInfo | |
| TmNoteList | |
| ListChatNotesNewStatus | |
| TmCreateNoteRequest | |
| TmNoteInfo | |
| TmNoteWithBodyInfo | |
| TmWebhookList | |
| TmWebhookInfo | |
| TmCompanyInfo | |
| TmPersonInfo | |
| TmConversationList | |
| CreateConversationRequest | |
| TmConversationInfo | |
| DataExportTaskList | |
| ListDataExportTasksNewStatus | |
| CreateDataExportTaskRequest | |
| DataExportTask | |
| EveryoneTeamInfo | |
| UpdateEveryoneTeamRequest | |
| TmTeamList | |
| TmCreateTeamRequest | |
| TmTeamInfo | |
| TmUpdateTeamRequest | |
| TmRemoveTeamMembersRequest | |
| TmAddTeamMembersRequest | |
| DisabledFilterInfo | |
| SubscriptionInfoStatus | Subscription status |
| NotificationDeliveryMode | Notification delivery transport information |
| BlacklistedData | Returned if a WebHook subscription is blacklisted |
| WebhookDeliveryMode | |
| MobileDeliveryMode | |
| PubNubDeliveryMode | |
| WebSocketDeliveryMode | |
| WebhookDeliveryModeTransportType | The transport type for this subscription, or the channel by which an app should be notified of an event |
| WebhookDeliveryModeEncryption | Specifies if notification messages will be encrypted or not. |
| MobileDeliveryModeTransportType | The transport type for this subscription, or the channel by which an app should be notified of an event |
| MobileDeliveryModeEncryption | Specifies if notification messages will be encrypted or not. |
| PubNubDeliveryModeTransportType | The transport type for this subscription, or the channel by which an app should be notified of an event |
| EncryptionAlgorithm | (Only for a "PubNub" transport, returned only if encryption is true) Encryption algorithm used |
| WebSocketDeliveryModeTransportType | The transport type for this subscription, or the channel by which an app should be notified of an event |
| WebhookDeliveryModeRequest | |
| WebhookDeliveryModeRequestTransportType | The transport type for this subscription, or the channel by which an app should be notified of an event |
| WebinarSettingsModel | Various settings which define behavior of this Webinar's Sessions |
| HostModel | |
| WebinarSettingsModelPanelistAuthentication | Indicates if Panelists have to be authenticated users |
| WebinarSettingsModelAttendeeAuthentication | Indicates if attendees have to be authenticated users |
| WebinarSettingsModelArtifactsAccessAuthentication | Indicates who can access webinar artifacts. Applies to recordings at present. Applicable to other artifacts such as Q&A, Polls in the future. |
| RcwDomainUserModel | |
| Domain | Identity domain |
| SessionRuntimeStatusModel | Session runtime status (for 'Active' Sessions only). It is omitted (or null) if the status is not Active |
| RecordingExtendedModel | |
| SessionLivestreamMinimalModel | |
| SessionLivestreamStatusModel | Last known state of the livestream as notified by Webinar Livestreaming Controller Service (WLCS). Value may not be consistent with latest state, especially for livestream associated with OAuth2.0 based service providers. Thus, state must be obtained directly from WLCS |
| ParticipantExtendedModel | |
| RcwPagingModel | |
| ParticipantExtendedModelType | The type of the participant specified in invite or determined at join time |
| ParticipantReducedModelType | The type of the participant specified in invite or determined at join time |
| InviteeModelType | The type of the participant specified in invite or determined at join time |
| SessionGlobalResource | |
| WebinarRefModel | |
| RecordingModel | |
| RecordingAdminModel | |
| SessionRefAdminModel | |
| RecordingItemModel | |
| SessionRefModel | |
| DownloadContentType | MIME type of the file to download. |
| RegistrationStatus | Status of the registration |
| Settings | |
| OnDemandDuration | Duration of on-demand webinar. The default value can only be used if the session is on demand. |
| RcwPagingForwardModel | |
| RegAnswerModel | |
| FixedAnswerModel | |
| VariableAnswerModel | |
| WcsWebinarSettingsModel | Various settings which define behavior of this Webinar's Sessions |
| WcsHostModel | |
| WcsWebinarSettingsModelPanelistAuthentication | Indicates if Panelists have to be authenticated users |
| WcsWebinarSettingsModelAttendeeAuthentication | Indicates if attendees have to be authenticated users |
| WcsWebinarSettingsModelArtifactsAccessAuthentication | Indicates who can access webinar artifacts. Applies to recordings at present. Applicable to other artifacts such as Q&A, Polls in the future. |
| RcwLinkedUserModel | The internal IDs of RC-authenticated users. |
| SessionGlobalListEntry | |
| WcsWebinarRefModel | |
| RcwInviteeTypeEnum | The type of the webinar invitee |
| AddInviteeRequest | |
| UpdatedInvitees | |
| RcwResourceIdModel | |
| CreateCompanyGreetingRequestType_1 | Type of greeting, specifying the case when the greeting is played. |
| AnsweringRuleQueryRequest | |
| CreateCompanyGreetingRequestType_2 | Type of greeting, specifying the case when the greeting is played. |
| CustomCompanyGreetingInfoType | Type of company greeting |
| CustomCompanyGreetingInfoContentType | Content media type |
| CustomGreetingAnsweringRuleInfo | Information on an answering rule that the greeting is applied to |
| CustomCompanyGreetingLanguageInfo | Information on a greeting language. Supported for types 'StopRecording', 'StartRecording', 'AutomaticRecording' |
| CreateCustomUserGreetingRequestType_1 | Type of greeting, specifying the case when the greeting is played. |
| CreateCustomUserGreetingRequestType_2 | Type of greeting, specifying the case when the greeting is played. |
| CustomUserGreetingInfoType | Type of custom user greeting |
| CustomUserGreetingInfoContentType | Content media type |
| PageNavigationModel | Links to other pages of the current result set |
| EnumeratedPagingModel | |
| DictionaryGreetingInfoUsageType | Usage type of greeting, specifying if the greeting is applied for user extension or department (call queue) extension. |
| GreetingTypeEnum | Type of greeting, specifying the case when the greeting is played. |
| DictionaryGreetingInfoCategory | Category of a greeting, specifying data form. The category value 'None' specifies that greetings of a certain type ('Introductory', 'ConnectingAudio', etc.) are switched off for an extension = ['Music', 'Message', 'RingTones', 'None'] |
| PageNavigationUri | |
| BatchProvisionUsersRequestItem | Describes request for user extension provisioning |
| BatchProvisionUsersRequestItemStatus | Extension status. Only "Enabled" can be specified |
| Contact | |
| CostCenter | |
| BatchProvisionUsersRequestItemRoles | |
| BatchProvisionUsersRequestItemDevices | |
| DeviceDefinition | |
| DeviceDefinitionType | Device type. Only "OtherPhone" and "WebRTC" device types are supported at the moment |
| Emergency_1_1 | |
| Emergency_2_1 | |
| PostalAddress | Postal address/location |
| Emergency_2Location_1 | |
| PhoneNumberDefinitionTollType | To use as selection criteria when a number to be selected from the number pool. |
| PhoneNumberDefinitionPreferredAreaCode | To use as selection hint when a "toll" number to be selected from the number pool. |
| PhoneNumberDefinitionDirectNumberWithReservationId | To be used for direct number assignment in case number pool is not supported |
| PhoneNumberDefinitionNumberId | To be used to assign a number by ID |
| BatchProvisionUsersResponseResults | |
| BatchProvisionUsersSuccessItem | |
| BatchProvisionErrorItem | |
| BatchProvisionUsersSuccessItemExtension | |
| ExtensionDevices | |
| ApiErrorWithParameter | |
| BulkOperationExtensionReference | Information about an extension this device is assigned to |
| BulkDeleteUsersResponseRecords | |
| GetExtensionAccountInfo | Account information |
| ContactInfo | Detailed contact information |
| CostCenterInfo | Cost center information. Applicable if Cost Center feature is enabled. The default is root cost center value |
| CustomFieldInfo | |
| DepartmentInfo | Please note that the Department extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| ExtensionPermissions | Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling' |
| ProfileImageInfo | Information on profile image |
| ReferenceInfo | |
| Roles | |
| RegionalSettings | Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings |
| ExtensionServiceFeatureInfo | |
| SetupWizardStateForUpdateEnum | Initial configuration wizard state |
| GetExtensionInfoResponseStatus | Extension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned |
| ExtensionStatusInfo | Status information (reason, comment). Returned for 'Disabled' status only |
| GetExtensionInfoResponseType | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| GetExtensionInfoResponseSubType | Extension subtype, if applicable. For any unsupported subtypes the Unknown value will be returned |
| CallQueueExtensionInfo | For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| ProvisioningSiteInfo | Site data. If multi-site feature is turned on for an account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) the site ID should be set to main-site |
| AssignedCountryInfo | Information on a country assigned to an extension user. Returned for the User extension type only |
| ContactBusinessAddressInfo | User's business address. The default is Company (Auto-Receptionist) settings |
| PronouncedNameInfo | |
| PronouncedNameInfoType | The method used to pronounce the user's name: - Default - default extension name; first and last name specified in user's profile are pronounced using text-to-speech; - TextToSpeech - custom text specified by a user pronounced using text-to-speech; - Recorded - custom audio uploaded by a user, the name recorded in user's own voice (supported only for extension retrieval). |
| PronouncedNamePromptInfo | |
| PronouncedNamePromptInfoContentType | Content media type |
| PermissionInfoAdmin | Admin permission |
| PermissionInfoInt | International Calling permission |
| ProfileImageInfoUri | |
| ReferenceInfoType | Type of external identifier |
| CountryInfoShortModel | |
| TimezoneInfo | Extension timezone information |
| RegionalLanguageInfo | Information on a language set as regional |
| GreetingLanguageInfo | Information on language used for telephony greetings |
| FormattingLocaleInfo | Formatting language preferences for numbers, dates and currencies |
| RegionalSettingsTimeFormat | Time format setting. The default value is '12h' = ['12h', '24h'] |
| ExtensionServiceFeatureInfoFeatureName | Feature name |
| ExtensionStatusInfoReason | Type of suspension |
| ExtensionUpdateRequestStatus | |
| ContactInfoUpdateRequest | |
| ExtensionRegionalSettingRequest | |
| CallQueueInfoRequest | For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| UserTransitionInfo | For NotActivated extensions only. Welcome email settings |
| SiteReference | |
| ExtensionUpdateRequestType | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| ExtensionUpdateRequestSubType | Extension subtype, if applicable. For any unsupported subtypes the 'Unknown' value will be returned |
| ExtensionCountryInfoRequest | |
| ExtensionTimezoneInfoRequest | |
| ExtensionLanguageInfoRequest | |
| ExtensionGreetingLanguageInfoRequest | |
| ExtensionFormattingLocaleInfoRequest | |
| ExtensionCurrencyInfoRequest | |
| ExtensionRegionalSettingRequestTimeFormat | Time format setting |
| GrantInfo | |
| ExtensionInfoGrants | Extension information |
| ExtensionInfoGrantsType | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| PhoneNumberInfoConferencing | |
| ConferencePhoneNumberInfo | |
| CallerIdByDevice | Caller ID settings by device |
| CallerIdByFeature | Caller ID settings by feature |
| CallerIdDeviceInfo | |
| CallerIdByDeviceInfo | |
| CallerIdPhoneInfo | |
| CallerIdByFeatureFeature | |
| CallerIdByFeatureInfo | |
| CallerIdByDeviceRequest | Caller ID settings by device |
| CallerIdByFeatureRequest | Caller ID settings by feature |
| CallerIdDeviceInfoRequest | |
| CallerIdByDeviceInfoRequest | |
| CallerIdPhoneInfoRequest | |
| CallerIdByFeatureRequestFeature | |
| CallerIdByFeatureInfoRequest | |
| EmailRecipientInfo | |
| VoicemailsInfo | |
| InboundFaxesInfo | |
| OutboundFaxesInfo | |
| InboundTextsInfo | |
| MissedCallsInfo | |
| EmailRecipientInfoStatus | Current state of an extension |
| Permission | Call queue manager permission |
| SyncInfoMessages | Sync type, token and time |
| MessageAttachmentInfo | |
| ConversationInfo | SMS and Pager only. Information about a conversation the message belongs to |
| FaxResolutionEnum | Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi |
| MessageStoreCallerInfoResponseFrom | Sender information |
| MessageStatusEnum | Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outbound message, a status for at least one recipient is 'Queued', then the 'Queued' value is returned. If a status for at least one recipient is 'SendingFailed', then the 'SendingFailed' value is returned. In other cases the 'Sent' status is returned |
| MessagePriorityEnum | Message priority |
| MessageStoreCallerInfoResponseTo | |
| GetMessageInfoResponseType | Message type |
| VmTranscriptionStatus | Voicemail only. Status of a voicemail to text transcription. If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned |
| MessageAttachmentTypeEnum | Type of message attachment |
| FaxErrorCodeEnum | |
| MessagingNavigationInfo | Information on navigation |
| MessagingPagingInfo | Information on paging |
| MessagingNavigationInfoUri | Canonical URI for the corresponding page of the list |
| IvrMenuListInfo | |
| IvrMenuSiteInfo | Site data |
| IvrMenuPromptInfo | Prompt metadata |
| IvrMenuActionsInfo | |
| IvrMenuPromptInfoMode | Prompt mode: custom media or text |
| AudioPromptInfo | For 'Audio' mode only. Prompt media reference |
| PromptLanguageInfo | For 'TextToSpeech' mode only. Prompt language metadata |
| IvrMenuActionsInfoAction | Internal identifier of an answering rule |
| IvrMenuExtensionInfo | For 'Connect' or 'Voicemail' actions only. Extension reference |
| CreateBridgeRequestType | Type of bridge. It specifies bridge life cycle. 1) Instant - The bridge will be used for a meeting only once immediately after creation. Then it will be deleted. 2) Scheduled - The bridge will be used for scheduled one or more meetings. If the bridge is not used for a long time after the last meeting, then it will be deleted. 3) PMI - The bridge will contain Personal Meeting Identifier owned by a user. It is the default user bridge. Each user may have only one default (PMI) bridge. Such bridge will be deleted only in case the user is deleted from the system. |
| BridgePins | |
| BridgeRequestSecurity | |
| BridgePreferences | |
| BridgePstnPins | |
| BridgeJoinPreferences | |
| PlayTones | Specifies enter and exit tones mode. 1) On - Enter and exit tones switched on. 2) Off - Enter and exit tones switched off. 3) ExitOnly - Only exit tones switched on. 4) EnterOnly - Only enter tones switched on. |
| RecordingsMode | Controls whether recordings are enabled automatically or by user decision |
| TranscriptionsMode | Controls whether transcriptions are enabled automatically or by user decision |
| RecordingsPreferences | Recordings preferences |
| WaitingRoomRequired | Specifies rules for the waiting room before the host starts the meeting. 1) Nobody - No waiting room. Participants are not waiting for meeting start. 2) Everybody - All participants are waiting for meeting start. 3) GuestsOnly - Only unauthenticated participants (guests) are waiting for meeting start. 4) OtherAccount - Only participants who have other account are waiting for meeting start. Default value depends on the bridge type: - PMI -> OtherAccount - Instant, Scheduled -> Nobody |
| BridgeJoinPstnPreferences | |
| EveryoneCanControl | Controls whether participants can start and pause recording |
| AutoShared | Controls whether recording can be auto shared |
| BridgeResponseType | Type of bridge. It specifies bridge life cycle. 1) Instant - The bridge will be used for a meeting only once immediately after creation. Then it will be deleted. 2) Scheduled - The bridge will be used for scheduled one or more meetings. If the bridge is not used for a long time after the last meeting, then it will be deleted. 3) PMI - The bridge will contain Personal Meeting Identifier owned by a user. It is the default user bridge. Each user may have only one default (PMI) bridge. Such bridge will be deleted only in case the user is deleted from the system. |
| User | |
| BridgePinsWithAliases | |
| BridgeResponseSecurity | |
| BridgeDiscovery | |
| BridgeResponseSecurityPassword | |
| BridgePinsWithoutPstn | |
| CloudRecording | Recording information |
| Paging | Paging information |
| Host | Meeting host |
| Delegate | |
| MeetingType | Meeting type |
| MeetingStatus | Meeting status |
| Rights | |
| Participant | Participant information |
| Recording | Recording information |
| RecordingStatus | Recording processing status |
| AvailabilityStatus | Availability status |
| GetTokenRequest_1 | |
| GetTokenRequest_2 | |
| GetTokenRequest_3 | |
| GetTokenRequest_4 | |
| GetTokenRequest_5 | |
| GetTokenRequest_6 | |
| GetTokenRequest_7 | |
| GetTokenRequest_8 | |
| GetTokenRequest_9 | |
| GetTokenRequest_1GrantType | Grant type |
| GetTokenRequest_1ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_2GrantType | Grant type |
| GetTokenRequest_2ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_3GrantType | Grant type |
| GetTokenRequest_3ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_4GrantType | Grant type |
| GetTokenRequest_4ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_5GrantType | Grant type |
| GetTokenRequest_5ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_6GrantType | Grant type |
| GetTokenRequest_6ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_7_1 | |
| GetTokenRequest_7_2 | |
| GetTokenRequest_7_1GrantType | Grant type |
| GetTokenRequest_7_1ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_7_2GrantType | Grant type |
| GetTokenRequest_7_2ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_8GrantType | Grant type |
| GetTokenRequest_8ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| GetTokenRequest_9GrantType | Grant type |
| GetTokenRequest_9ClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| TokenType | Type of the token. The only supported value is bearer. This value should be used when specifying access token in Authorization header of subsequent API requests |
| AuthorizeRequestResponseType | Determines authorization flow type. The only supported value is code which corresponds to OAuth 2.0 "Authorization Code Flow" |
| RevokeTokenRequestClientAssertionType | Client assertion type for the client_secret_jwt or private_key_jwt client authentication types, as defined by RFC-7523. This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types |
| AccountInfoStatus | Account status |
| AccountStatusInfo | Optional information to be used when account is moved to "Disabled" status |
| ServiceInfoV2 | Service Plan information (billing package, brand, etc.) |
| SystemUserContactInfo | |
| AccountStatusInfoReason | Type of suspension, voluntarily or not |
| ServiceInfoPackage | Billing package information |
| ServiceInfoBrand | Internal RC "brand" information |
| ServiceInfoCountryShortModel | |
| ServiceInfoUBrand | Account sub-brand information |
| ServiceInfoPlan | Information on account service plan |
| Version | Billing package version |
| ServiceInfoPlanFreemiumProductType | |
| AccountOperatorInfo | Operator extension information. This extension will receive all calls and messages addressed to an operator. |
| ServiceInfo | Account service information, including brand, sub-brand, service plan and billing plan |
| SetupWizardStateEnum | Initial configuration wizard state |
| SignupInfoResource | Account sign up data |
| GetAccountInfoResponseStatus | Status of the current account |
| AccountRegionalSettings | Account level region data (web service Auto-Receptionist settings) |
| AccountLimits | Limits which are effective for the account |
| BillingPlanInfo | Information on account billing plan |
| BrandInfo | Information on account brand |
| ServicePlanInfo | Information on account service plan |
| TargetServicePlanInfo | Information on account target service plan |
| UBrandInfo | Account sub-brand information |
| DurationUnit | Duration period |
| BillingPlanInfoType | Billing plan type |
| ServicePlanInfoFreemiumProductType | |
| TargetServicePlanInfoFreemiumProductType | |
| SignupState | |
| VerificationReason | |
| AccountRegionalSettingsTimeFormat | Time format setting. The default value is '12h' = ['12h', '24h'] |
| CurrencyInfo | Currency information |
| ServiceFeatureInfo | |
| PackageInfo | |
| ServiceFeatureInfoFeatureName | Feature name |
| BusinessAddressInfo | Company business address |
| ContractedCountryListResponseRecords | |
| AddDeviceToInventoryRequestType | Device type. Use OtherPhone to indicate BYOD (customer provided) device |
| AddDeviceToInventoryRequestSite | |
| AddDeviceToInventoryResponseDevices | |
| SiteBasicInfo | |
| DeleteDeviceFromInventoryRequestRecords | |
| DeleteDeviceFromInventoryResponseRecords | |
| RemoveLineResponseType | Device type |
| BulkAddDevicesItem | |
| BulkAddDevicesItemType | Device type. Only "OtherPhone" and "WebRTC" device types are supported at the moment |
| Emergency_1_2 | |
| Emergency_2_2 | |
| Emergency_2Location_2 | |
| BulkAddDevicesSuccessItem | |
| BulkAddDevicesErrorItem | |
| DeviceResourceType | Device type |
| DeviceResourceStatus | Device status |
| ModelInfo | HardPhone model information |
| ExtensionInfoIntId | This attribute can be omitted for unassigned devices |
| DeviceEmergencyInfo | Device emergency settings |
| EmergencyServiceAddressResource | Address for emergency cases. The same emergency address is assigned to all the numbers of one device |
| PhoneLinesInfo | |
| ShippingInfo | 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 |
| DeviceSiteInfo | Site data |
| LinePoolingEnum | Pooling type of device: - Host - device with a standalone paid phone line which can be linked to soft phone client instance; - Guest - device with a linked phone line; - None - device without a phone line or with a specific line (free, BLA, etc.) |
| BillingStatementInfo | Billing information. Returned for device update request if prestatement query parameter is set to 'true' |
| AddonInfo | |
| CommonEmergencyLocationAddressInfoDefault | |
| DeviceEmergencyLocationInfo | Company emergency response location details |
| DeviceEmergencyInfoAddressStatus | Emergency address status |
| DeviceEmergencyInfoVisibility | Visibility of an emergency response location. If Private is set, then location is visible only for the restricted number of users, specified in owners array |
| DeviceEmergencyInfoSyncStatus | Resulting status of the emergency address synchronization. Returned if syncEmergencyAddress parameter is set to true |
| DeviceEmergencyInfoAddressEditableStatus | Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner) |
| EmergencyServiceAddressResourceSyncStatus | Resulting status of emergency address synchronization. Returned if syncEmergencyAddress parameter is set to true |
| EmergencyServiceAddressResourceLineProvisioningStatus | Status of digital line provisioning |
| PhoneNumberInfoIntId | Phone number information |
| EmergencyAddress | |
| PhoneNumberCountryInfo | Brief information on a phone number country |
| DeviceProvisioningExtensionInfo | Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list |
| PhoneNumberInfoIntIdPaymentType | Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system |
| PhoneNumberInfoIntIdType | Phone number type |
| PhoneNumberInfoIntIdUsageType | Usage type of the phone number |
| EmergencyAddressLineProvisioningStatus | This status is associated with a phone line provision state |
| ShippingStatus | Order item shipping status. It is set to Initial when the order is submitted. Then it is changed to Accepted when a distributor starts processing the order. Finally, it is changed to Shipped which means that the distributor has shipped the device. |
| ShippingMethodInfo | |
| ShippingAddressInfo | Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default, the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case an order contains several devices, they can be delivered to different addresses |
| Id | Shipping method ID: - "1" - Ground Shipping (5-7 business days) - "2" - Expedited Shipping (2-days) - "3" - Overnight Shipping |
| ShippingMethodInfoName | Method name, corresponding to the identifier |
| BillingStatementCharges | |
| BillingStatementFees | |
| EmergencyServiceAddressResourceRequest | Address for emergency cases. The same emergency address is assigned to all numbers of a single device. If the emergency address is also specified in emergency resource, then this value is ignored |
| DeviceUpdateExtensionInfo | Information on extension that the device is assigned to |
| DeviceUpdatePhoneLinesInfo | Information on phone lines added to a device |
| UpdateDevicePhoneInfo | |
| OutboundProxyInfo | |
| AccountPhoneNumberInfoExtension | Reference to the extension this number is assigned to. Omitted for company numbers |
| DeletePhoneNumbersRequestItem | The indication of a number to be deleted - either "id" or "phoneNumber" must be specified. |
| DeletePhoneNumbersResponseItem | |
| AssignPhoneNumberRequestUsageType | Target usage type of phone number (only listed values are supported) |
| AssignPhoneNumberRequestExtension | |
| AddPhoneNumberRequestItem | |
| AddPhoneNumberRequestItemUsageType | Usage type of phone number. Currently, we support the following values: Inventory, InventoryPartnerBusinessMobileNumber and PartnerBusinessMobileNumber. Later we may support some other values like ForwardedNumber, etc. |
| AddPhoneNumbersResponseItem | |
| UserPhoneNumberInfo | |
| CountryInfoBasicModel | |
| ContactCenterProvider | CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1' |
| UserPhoneNumberExtensionInfo | Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list |
| UserPhoneNumberInfoStatus | Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral |
| UserPhoneNumberInfoType | Phone number type |
| UserPhoneNumberInfoSubType | Extension subtype, if applicable. For any unsupported subtypes the 'Unknown' value will be returned |
| UserPhoneNumberInfoUsageType | Usage type of phone number. Numbers of 'NumberPool' type will not be returned for phone number list requests |
| UserPhoneNumberInfoFeatures | |
| UserPhoneNumberExtensionInfoType | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| ExtensionInfo | Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list |
| CompanyPhoneNumberInfoStatus | Status of a phone number. If the value is 'Normal', the phone number is ready to be used. If the value is 'Pending' it is an external number not yet ported to RingCentral. |
| CompanyPhoneNumberInfoType | Phone number type |
| CompanyPhoneNumberInfoUsageType | Usage type of phone number. Usage type of phone number. Numbers of 'NumberPool' type are not returned in phone number list requests |
| TemporaryNumberInfo | Temporary phone number, if any. Returned for phone numbers in Pending porting status only |
| GetCountryInfoNumberParser | |
| PhoneNumberInfoNumberParser | |
| CompanyBusinessHoursScheduleInfo | Schedule when an answering rule is applied |
| WeeklyScheduleInfo | Weekly schedule |
| TimeInterval | |
| ScheduleInfoUserBusinessHours | Schedule when an answering rule is applied |
| UserBusinessHoursScheduleInfo | Schedule when an answering rule is applied |
| CustomFieldModelCategory | Object category to attach custom fields |
| CustomFieldCreateRequestCategory | Object category to attach custom fields |
| OnDemandResource | |
| AutomaticRecordingResource | |
| GreetingResource | |
| GreetingResourceType | |
| GreetingResourceMode | Here Default indicates that all greetings of that type (in all languages) are default. If at least one greeting (in any language) of the specified type is custom, then Custom is returned. |
| CallRecordingCustomGreeting | |
| CallRecordingCustomGreetingType | |
| CallRecordingCustomGreetingData | Custom greeting data |
| CallRecordingCustomGreetingLanguage | Custom greeting language |
| CallRecordingExtensionResource | |
| CallDirection | Direction of call |
| CallRecordingExtensionInfo | |
| MakeCallOutCallerInfoRequestFrom | Instance id of the caller. It corresponds to the 1st leg of the CallOut call. |
| MakeCallOutCallerInfoRequestTo | Phone number of the called party. This number corresponds to the 2nd leg of a CallOut call |
| OriginInfo | Session origin details |
| OriginInfoType | Session origin type |
| CallStatusInfo | Status data of a call session |
| ParkInfo | Call park information |
| PartyInfo | |
| OwnerInfo | Deprecated. Information on a call owner |
| CallPartyDirection | Direction of a call |
| CallPartyConferenceRole | A party's role in the conference scenarios. For calls of 'Conference' type only |
| CallPartyRingOutRole | A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only |
| CallPartyRingMeRole | A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only |
| RecordingInfo | |
| CallStatusInfoCode | Status code of a call |
| PeerInfo | Peer session/party details. Valid in 'Gone' state of a call |
| CallStatusInfoReason | Reason for call termination. For 'Disconnected' code only |
| PartyUpdateInfo | Party update data |
| ReplyWithPattern | |
| Pattern | Predefined reply pattern name. |
| TimeUnit | Time unit name. |
| ReplyPartyDirection | Direction of a call |
| PartySuperviseRequestMode | Supervising mode |
| PartySuperviseRequestMediaSdp | Specifies session description protocol (SDP) setting. The possible values are 'sendOnly' (only sending) meaning one-way audio streaming; and 'sendRecv' (sending/receiving) meaning two-way audio streaming |
| PartySuperviseResponseDirection | Direction of a call |
| Proto | Protocol for hold mode initiation |
| ForwardCallPartyResponseDirection | Direction of a call |
| ForwardCallPartyResponseConferenceRole | A party's role in the conference scenarios. For calls of 'Conference' type only |
| ForwardCallPartyResponseRingOutRole | A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only |
| ForwardCallPartyResponseRingMeRole | A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only |
| SuperviseCallSessionRequestMode | Supervising mode |
| SuperviseCallSessionRequestMediaSdp | Specifies session description protocol setting |
| SuperviseCallSessionResponseDirection | Direction of a call |
| Site | Specifies a site that message template is associated with. Supported only if the Sites feature is enabled. The default is main-site value. |
| ExtensionInfoCallLog | Information about extension on whose behalf a call is initiated. For Secretary call log the Boss extension info is returned |
| CallLogRecordTransferTarget | |
| CallLogRecordTransferee | |
| CallLogFromParty | |
| CallLogToParty | |
| CallLogRecordMessage | Linked message (Fax/Voicemail) |
| CallLogDelegateInfo | Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension |
| DelegationTypeEnum | Call delegation type |
| CallActionEnum | The internal action corresponding to the call operation |
| CallResultEnum | The result of the call operation |
| CallResultReasonEnum | The reason of the call result: - Accepted - The call was connected to and accepted by this number - Connected - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push "1" to accept) - Line Busy - The phone number you dialed was busy - Not Answered - The phone number you dialed was not answered - No Answer - You did not answer the call - Hang Up - The caller hung up before the call was answered - Stopped - This attempt was stopped because the call was answered by another phone - Internal Error - An internal error occurred when making the call. Please try again - No Credit - There was not enough Calling Credit on your account to make this call - Restricted Number - The number you dialed is restricted by RingCentral - Wrong Number - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again - International Disabled - International calling is not enabled on your account. Contact customer service to activate International Calling - International Restricted - The country and/or area you attempted to call has been prohibited by your administrator - Bad Number - An error occurred when making the call. Please check the number before trying again - Info 411 Restricted - Calling to 411 Information Services is restricted - Customer 611 Restricted - 611 customer service is not supported. Please contact customer service at ```(888) 555-1212```` - No Digital Line- This DigitalLine was either not plugged in or did not have an internet connection -Failed Try Again- Call failed. Please try again -Max Call Limit- The number of simultaneous calls to your account has reached its limit -Too Many Calls- The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service -Calls Not Accepted- Your account was not accepting calls at this time -Number Not Allowed- The number that was dialed to access your account is not allowed -Number Blocked- This number is in your Blocked Numbers list -Number Disabled- The phone number and/or area you attempted to call has been prohibited by your administrator -Resource Error- An error occurred when making the call. Please try again -Call Loop- A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account -Fax Not Received- An incoming fax could not be received because a proper connection with the sender's fax machine could not be established -Fax Partially Sent- The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped -Fax Not Sent- An attempt to send the fax was made, but could not connect with the receiving fax machine -Fax Poor Line- An attempt to send the fax was made, but the phone line quality was too poor to send the fax -Fax Prepare Error- An internal error occurred when preparing the fax. Please try again -Fax Save Error- An internal error occurred when saving the fax. Please try again -Fax Send Error- An error occurred when sending the fax. Please try again -Emergency Address not defined- The call was rejected due to no E911 address -Carrier is not active- The call was rejected due to carrier inactivity -EDGE trunk misconfigured- The call was rejected due to error in EDGE trunk configuration -Internal Call Error- An internal error occurred when making the call. Please try again -Receive Error - Fax receive error |
| CallLogRecordingInfo | Call recording data. Returned if the call was recorded |
| BillingInfo | Billing information related to the call. Returned for 'Detailed' view only |
| CallInternalTypeEnum | The internal type of the call |
| CallLogRecordLegInfo | |
| CallLogRecordDeviceInfo | |
| CallLogRecordingInfoType | Indicates recording mode used |
| CallLogRecordLegInfoTransferTarget | |
| CallLogRecordLegInfoTransferee | |
| CallLegTypeEnum | Leg type |
| CallLogSyncInfo | |
| CallLogSyncTypeEnum | Type of call log synchronization request: full or incremental sync |
| ExtensionBulkUpdateInfo | |
| ExtensionBulkUpdateInfoStatus | |
| ExtensionBulkUpdateInfoType | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| ExtensionBulkUpdateTaskResourceStatus | Task status |
| ExtensionBulkUpdateTaskResult | Result record on multiple extension update task |
| ExtensionUpdateShortResult | |
| ErrorEntity | |
| ExtensionUpdateShortResultStatus | Extension update status |
| GetExtensionListInfoResponse | |
| GetExtensionListInfoResponseStatus | Extension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned |
| GetExtensionListInfoResponseType | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| GetExtensionListInfoResponseSubType | Extension subtype, if applicable. For any unsupported subtypes the Unknown value will be returned |
| ContactInfoCreationRequest | Contact Information |
| ExtensionCreationRequestStatus | Extension current state |
| ExtensionCreationRequestType | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| OperatorInfo | Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled |
| ExtensionCreationResponseStatus | Extension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned |
| ExtensionCreationResponseType | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| MessageStatusCounts | Message status parameters |
| MessageListMessageResponse | The short detail of the message in the get batch response |
| PagingResource | Pagination details |
| SmsStatusEnum | Current status of a message |
| OptOutResponse | Opt-out record |
| OptOutResponseStatus | Status of a phone number |
| Source | |
| OptIns | Contains successful and failed opt-ins |
| OptOuts | Contains successful and failed opt-outs |
| OptOutBulkAssignFailedEntry | Represents a failure of adding opt-out / opt-in. A pair of a recipient phone number and an error message |
| MessageBatchResponseStatus | Current status of a message batch |
| RejectedRecipientResponseResource | The rejected recipient details |
| MessageCreateRequest | Single individual SMS resource |
| ListCompanyAnsweringRuleInfo | |
| ListCompanyAnsweringRuleInfoType | Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom'] |
| CalledNumberInfo | |
| CompanyAnsweringRuleExtensionInfo | |
| CompanyAnsweringRuleRequestType | Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom'] |
| CompanyAnsweringRuleCallersInfoRequest | |
| CompanyAnsweringRuleCalledNumberInfo | |
| CompanyAnsweringRuleScheduleInfoRequest | Schedule when an answering rule should be applied |
| CompanyAnsweringRuleRequestCallHandlingAction | Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass'] |
| CompanyAnsweringRuleExtensionInfoRequest | Extension to which the call is forwarded in 'Bypass' mode |
| GreetingInfo | |
| CompanyAnsweringRuleWeeklyScheduleInfoRequest | Weekly schedule. If specified, ranges cannot be specified |
| RangesInfo | |
| CompanyAnsweringRuleScheduleInfoRequestRef | Reference to Business Hours or After Hours schedule |
| CompanyAnsweringRuleTimeIntervalRequest | |
| PresetInfo | |
| CustomGreetingInfoRequest | |
| CompanyAnsweringRuleInfoType | Type of an answering rule |
| CompanyAnsweringRuleCalledNumberInfoRequest | |
| CompanyAnsweringRuleScheduleInfo | Schedule when an answering rule should be applied |
| CompanyAnsweringRuleInfoCallHandlingAction | Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass'] |
| CompanyAnsweringRuleScheduleInfoRef | Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours'] |
| CompanyAnsweringRuleUpdateCallHandlingAction | Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect','Bypass'] |
| CompanyAnsweringRuleUpdateType | Type of an answering rule |
| IvrCallHandlingActionEnum | Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass'] |
| ExtensionShortInfoResource | |
| ForwardAllCallsReason | |
| ForwardAllCallsReasonCode | Specifies the type of limitation. ExtensionLimitation means that the feature is turned off for this particular extension. FeatureLimitation means that the user may enable this feature and setup the rule via the Service Web UI |
| AnsweringRuleInfoType | Type of an answering rule |
| ScheduleInfo | Schedule when an answering rule should be applied |
| CallersInfo | |
| AnsweringRuleInfoCallHandlingAction | Specifies how incoming calls are forwarded |
| ForwardingInfo | Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded |
| UnconditionalForwardingInfo | Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' value is specified for the callHandlingAction parameter |
| QueueInfo | Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action |
| TransferredExtensionInfo | |
| VoicemailInfo | Specifies whether to take a voicemail and who should do it |
| AnsweringRuleInfoScreening | Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off' |
| SharedLinesInfo | SharedLines call handling action settings |
| MissedCallInfo | Specifies behavior for the missed call scenario. Returned only if enabled parameter of a voicemail is set to 'false' |
| ScheduleInfoRef | The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method |
| ForwardingInfoRingingMode | Specifies the order in which the forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time |
| ForwardingRuleInfo | |
| CreateAnsweringRuleForwardingNumberInfo | |
| CreateAnsweringRuleForwardingNumberInfoType | Type of forwarding number |
| UnconditionalForwardingInfoAction | Event that initiates forwarding to the specified phone number |
| TransferMode | Specifies how calls are transferred to group members |
| TransferInfo | |
| NoAnswerAction | Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported |
| FixedOrderAgents | |
| HoldAudioInterruptionMode | Connecting audio interruption mode |
| HoldTimeExpirationAction | Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in transfer field is used. The default value is Voicemail |
| MaxCallersAction | Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum |
| TransferExtensionInfo | |
| TransferInfoAction | Event that initiates transferring to the specified extension |
| FixedOrderAgentsExtensionInfo | |
| TransferredExtension | Transfer extension settings, set/returned if callHandlingAction is specified as TransferToExtension |
| RecipientInfo | Recipient data |
| ActionType | Specifies the action that should be executed on a missed call. It can either be playing greeting message and disconnection, or sending call to a calling group. If 'ConnectToExtension' is set, then calling group extension should be specified |
| MissedCallExtensionInfo | Specifies an extension (a calling group) which should be used for the missed call transfer. Returned only if the actionType is set to 'ConnectToExtension' |
| MissedCallExtensionInfoExternalNumber | Specifies an external PSTN number which should be used for the missed call transfer. Returned only if the actionType is set to ConnectToExternalNumber |
| CallersInfoRequest | |
| CreateAnsweringRuleRequestCallHandlingAction | Specifies how incoming calls are forwarded |
| CreateAnsweringRuleRequestScreening | Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off' |
| CustomAnsweringRuleInfoType | Type of an answering rule |
| CustomAnsweringRuleInfoCallHandlingAction | Specifies how incoming calls are forwarded |
| CustomAnsweringRuleInfoScreening | Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off' |
| ForwardingInfoCreateRuleRequest | Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded |
| UpdateAnsweringRuleRequestCallHandlingAction | Specifies how incoming calls are forwarded |
| UpdateAnsweringRuleRequestType | Type of an answering rule |
| UpdateAnsweringRuleRequestScreening | Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off' |
| ForwardingInfoCreateRuleRequestRingingMode | Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially' |
| ForwardingRuleCreateRequest | |
| ForwardingNumberInfoRulesCreateRuleRequest | |
| ForwardingNumberInfoRulesCreateRuleRequestType | Forwarding phone number type |
| AddressBookBulkUploadResource | |
| AddressBookBulkContactResource | |
| AddressBookBulkContactAddressInfo | |
| AddressBookBulkUploadResponseStatus | Task status |
| AddressBookBulkUploadTaskResult | |
| FavoriteContactResource | |
| UserContactsNavigationInfo | Information on navigation |
| UserContactsPagingInfo | Information on paging |
| UserContactsGroupsInfo | Information on address book groups |
| PersonalContactResourceAvailability | This property has a special meaning only on Address Book Sync (e.g. a contact can be Deleted). For simple contact list reading it has always the default value - Alive |
| ContactAddressInfo | |
| UserContactsNavigationInfoUri | Canonical URI for a corresponding page of a list |
| SyncInfo | |
| SyncInfoSyncType | |
| CallQueueInfo | |
| CallQueueInfoStatus | Call queue status |
| CallQueueInfoSubType | Indicates whether it is an emergency call queue extension or not |
| CallQueueDetailsStatus | Call queue status |
| CallQueueDetailsSubType | Indicates whether it is an emergency call queue extension or not |
| CallQueueServiceLevelSettings | Call queue service level settings |
| AlertTimer | Alert timer or pickup setting. Delay time in seconds before call queue group members are notified when calls are queued |
| CallQueueMemberInfo | |
| BulkAssignItem | |
| QueueShortInfoResource | |
| CallQueueIdResource | |
| CallQueueMemberPresence | |
| CallQueueMember | Call queue member information |
| SiteResource | Site extension information |
| CallQueueUpdateMemberPresence | |
| CallQueueMemberId | Call queue member information |
| PresenceNavigationInfo | Information on navigation |
| PresencePagingInfo | Information on paging |
| GetPresenceInfoCallerIdVisibility | Configures the user presence visibility. When the allowSeeMyPresence parameter is set to true, the following visibility options are supported via this parameter - All, None, PermittedUsers |
| GetPresenceInfoDndStatus | Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only. |
| GetPresenceExtensionInfo | Information on extension, for which this presence data is returned |
| GetPresenceInfoPresenceStatus | Aggregated presence status, calculated from a number of sources |
| GetPresenceInfoTelephonyStatus | Telephony presence status |
| GetPresenceInfoUserStatus | User-defined presence status (as previously published by the user) |
| GetPresenceInfoMeetingStatus | RingCentral Meetings presence |
| ActiveCallInfo | |
| ActiveCallInfoDirection | |
| ActiveCallInfoTelephonyStatus | Telephony presence status |
| DetailedCallInfo | |
| CallInfoCq | Primary/additional CQ information |
| PrimaryCqInfo | Primary call session information. Supported for Call Queues only |
| AdditionalCqInfo | Additional call session information. Supported for Call Queues only |
| PrimaryCqInfoType | Call information to be displayed as 'Line 1' for a call queue call session |
| AdditionalCqInfoType | Call information to be displayed as 'Line 2' for a call queue call session |
| PresenceNavigationInfoUri | Canonical URI for the corresponding page of the list |
| ExtensionCallQueuePresence | |
| PresenceCallQueueInfo | Call queue information |
| ExtensionCallQueueUpdatePresence | |
| CallQueueId | Call queue information |
| PresenceInfoRequestUserStatus | |
| PresenceInfoRequestDndStatus | |
| PresenceInfoRequestCallerIdVisibility | Configures the user presence visibility. When the allowSeeMyPresence parameter is set to true, the following visibility options are supported via this parameter - All, None, PermittedUsers |
| PresenceInfoResponseUserStatus | |
| PresenceInfoResponseDndStatus | |
| PresenceInfoResponseCallerIdVisibility | Configures the user presence visibility. When the allowSeeMyPresence parameter is set to true, the following visibility options are supported via this parameter - All, None, PermittedUsers |
| PresenceInfoResponseMeetingStatus | Meetings presence status |
| PresenceInfoResponseTelephonyStatus | Telephony presence status. Returned if telephony status is changed |
| PresenceInfoResponsePresenceStatus | Aggregated presence status, calculated from a number of sources |
| UnifiedPresenceStatus | Aggregated presence status of the user |
| UnifiedPresenceGlip | Returned if Glip feature is switched on |
| UnifiedPresenceTelephony | Returned if BLF feature is switched on |
| UnifiedPresenceMeeting | Returned if Meetings feature is switched on |
| UnifiedPresenceGlipStatus | Glip connection status calculated from all user's apps. Returned always for the requester's extension; returned for another users if their glip visibility is set to 'Visible' |
| UnifiedPresenceGlipVisibility | Visibility setting allowing other users to see the user's Glip presence status; returned only for requester's extension |
| UnifiedPresenceGlipAvailability | Shows whether user wants to receive Glip notifications or not. |
| UnifiedPresenceTelephonyStatus | Telephony status calculated from all user's phone numbers. Returned always for the requester's extension; returned for another users if their telephony visibility is set to 'Visible' |
| UnifiedPresenceTelephonyVisibility | Specifies if the user's phone presence status is visible to other users; returned only for requester's extension |
| UnifiedPresenceTelephonyAvailability | Telephony DND status. Returned if DND feature is switched on |
| UnifiedPresenceMeetingStatus | Meeting status calculated from all user`s meetings |
| UpdateUnifiedPresenceGlip | |
| UpdateUnifiedPresenceTelephony | |
| UpdateUnifiedPresenceGlipVisibility | Visibility setting allowing other users to see Glip presence status |
| UpdateUnifiedPresenceGlipAvailability | Availability setting specifying whether to receive Glip notifications or not |
| UpdateUnifiedPresenceTelephonyAvailability | Telephony DND status |
| EmergencyLocationsPaging | |
| CommonEmergencyLocationAddressInfo | |
| ShortSiteInfo | |
| AddressStatus | Emergency address status |
| UsageStatus | Status of emergency response location usage. |
| SyncStatus | Resulting status of emergency address synchronization. Returned if syncEmergencyAddress parameter is set to true |
| EmergencyAddressType | |
| Visibility | Visibility of an emergency response location. If Private is set, then location is visible only for the restricted number of users, specified in owners array |
| LocationOwnerInfo | |
| CommonEmergencyLocationAddressInfoAu | |
| CommonEmergencyLocationAddressInfoFr | |
| EmergencyLocationRequestResourceAddressStatus | Emergency address status |
| EmergencyLocationRequestResourceUsageStatus | Status of an emergency response location usage. |
| EmergencyLocationRequestResourceVisibility | Visibility of an emergency response location. If Private is set, then a location is visible only for restricted number of users, specified in owners array |
| GetLocationDeletionMultiResponseDeletion | |
| Reassignment | |
| LocationDeletionInfo | |
| LocationDeletionInfoDeletion | Identifies the possibility and status of emergency location deletion |
| LocationDeletionErrorInfo | |
| AutomaticLocationUpdatesTaskInfoStatus | Status of a task |
| AutomaticLocationUpdatesTaskInfoType | Type of task |
| TaskResultInfo | Task detailed result. Returned for failed and completed tasks |
| TaskResultRecord | |
| TaskResultRecordErrorsInfo | |
| AutomaticLocationUpdatesUserInfo | |
| AutomaticLocationUpdatesUserInfoType | User extension type |
| AutomaticLocationUpdatesSiteInfo | Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to main-site |
| EmergencyAddressAutoUpdateSiteInfo | |
| EmergencyAddressInfo | |
| EmergencyLocationInfo | Emergency response location information |
| EmergencyAddressInfo_1 | |
| EmergencyAddressInfo_2 | |
| EmergencyAddressInfo_3 | |
| EmergencyAddressInfo_1SyncStatus | Resulting status of emergency address synchronization. Returned for 'Get Device Info' request if syncEmergencyAddress parameter is set to true |
| EmergencyAddressInfo_2SyncStatus | Resulting status of emergency address synchronization. Returned for 'Get Device Info' request if syncEmergencyAddress parameter is set to true |
| EmergencyAddressInfo_3SyncStatus | Resulting status of emergency address synchronization. Returned for 'Get Device Info' request if syncEmergencyAddress parameter is set to true |
| BulkTaskInfo | |
| BulkTaskInfoStatus | Status of a task |
| PublicIpRangeInfo | |
| PrivateIpRangeInfo | |
| PrivateIpRangeInfoRequest | |
| LocationUpdatesEmergencyAddressInfoRequest | Emergency address assigned to the switch. Only one of a pair emergencyAddress or emergencyLocationId should be specified, otherwise the error is returned |
| ErlLocationInfo | Emergency response location information |
| SwitchSiteInfo | |
| SwitchValidated | |
| SwitchValidatedStatus | Validation result status |
| ValidationError | |
| WirelessPointValidated | |
| WirelessPointValidatedStatus | Validation result status |
| AutomaticLocationUpdatesDeviceInfo | |
| AutomaticLocationUpdatesDeviceType | Device type |
| AutomaticLocationUpdatesModelInfo | HardPhone model information |
| AutomaticLocationUpdatesPhoneLine | |
| AutomaticLocationUpdatesModelFeature | |
| AutomaticLocationUpdatesPhoneLineType | |
| AutomaticLocationUpdatesPhoneNumberInfo | |
| ScheduleMeetingResponse | |
| AccountLockSettingRecordResponse | |
| MeetingResponseResourceMeetingType | |
| MeetingLinks | Meeting links |
| MeetingScheduleResource | Timing of a meeting |
| HostInfoRequest | Meeting host information |
| MeetingResponseResourceAudioOptions | |
| RecurrenceInfo | |
| MeetingResponseResourceAutoRecordType | Automatic record type |
| MeetingOccurrenceInfo | |
| MeetingsTimezoneResource | |
| MeetingFrequency | Recurrence time frame |
| WeekDay | This field is used only if you're scheduling a recurring meeting of type 3 to state a specific day in a week when the monthly meeting should recur; it works together with MonthlyByWeek field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday |
| MonthlyWeek | Supported together with weeklyByDay |
| MeetingRecordings | |
| MeetingRecordingsPagingInfo | |
| MeetingRecordingsNavigationInfo | |
| MeetingInfo | |
| MeetingRecordingInfo | |
| MeetingRecordingInfoContentType | |
| MeetingRecordingInfoStatus | |
| MeetingRecordingsNavigationInfoUri | Canonical URI for the corresponding page of the list |
| MeetingsPagingInfo | |
| MeetingsNavigationInfo | |
| MeetingsNavigationInfoUri | |
| MeetingRequestResourceMeetingType | |
| MeetingRequestResourceAudioOptions | |
| MeetingRequestResourceAutoRecordType | Automatic record type |
| UserMeetingRecordingSetting | Meeting recording settings locked on account level |
| ScheduleUserMeetingInfo | Scheduling meeting settings locked on account level || Settings defining how to schedule user meetings |
| TelephonyUserMeetingSettings | |
| UserInMeetingResponse | |
| AutoRecording | Automatic recording (local/cloud/none) of meetings as they start |
| ScheduleUserMeetingInfoAudioOptions | |
| RequirePasswordForPmiMeetings | Specifies whether to require a password for meetings using Personal Meeting ID (PMI). The supported values are: 'none', 'all' and 'jbhOnly' (joined before host only) |
| GlobalDialInCountryResponse | |
| MeetingExternalUserInfoResource | |
| DialInNumberResource | |
| MeetingsCountryResource | |
| AssistedUserResource | |
| AssistantResource | |
| ExtensionWithRolesResource | |
| AssignedRoleResource | |
| Scope | Specifies resource for permission |
| PermissionIdResource | |
| PermissionIdResourceSiteCompatible | Site compatibility flag set for permission |
| PermissionsCapabilities | Advanced permissions capabilities. Returned if advancedPermissions query parameter is set to true. |
| CallMonitoringExtensionInfo | |
| CallMonitoringExtensionInfoPermissions | |
| CallMonitoringGroupMemberInfo | |
| CallMonitoringGroupMemberInfoPermissions | Call monitoring permission; multiple values are allowed: - Monitoring - User can monitor a group; - Monitored - User can be monitored. |
| ActionIds | |
| ExcludeActionIds | |
| AccountHistoryPublicRecord | |
| AccountHistoryPaging | |
| AccountHistoryRecordPublicInitiator | Event initiator info |
| AccountHistoryRecordTarget | Action target object (company/extension) |
| AccountHistoryRecordPublicDetails | |
| ObjectType | Type of the entity. |
| AccountHistoryRecordDetailsParameters | |
| PicMessageTypeEnum | Type of messages to be collected |
| MessageStoreReportStatus | Status of a message store report task |
| ArchiveInfo | |
| ContactResourceType | Contact type |
| ContactResourceStatus | Contact status |
| AccountResource | |
| PhoneNumberResource | |
| AccountDirectoryProfileImageResource | |
| BusinessSiteResource | |
| DirectoryRoleResource | |
| CallQueueResource | |
| CustomFieldResource | |
| GroupResource | |
| CostCenterResource | |
| ExternalIntegrationResource | |
| ContactSubTypeEnum | Extension subtype |
| PhoneNumberResourceUsageType | Usage type of phone number |
| PerPage_2 | |
| SearchFields | |
| SearchDirectoryContactType | Type of directory contact to filter |
| ExtensionStatuses | |
| OrderBy | |
| FieldName | Field name by which to sort the contacts |
| OrderByDirection | Sorting direction |
| FederatedAccountResource | |
| FederationType | Federation type |
| PagingGroupExtensionInfo | |
| PagingDeviceInfo | |
| SiteOperatorReference | Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled |
| SiteMemberInfo | |
| SiteIvrTopMenu | Top IVR Menu extension. Mandatory for MultiLevel mode |
| SiteIvrActions | Keys handling settings |
| SiteIvrActionsInput | |
| SiteIvrActionsAction | Key handling action: - Repeat - repeat menu greeting, for Star and Hash only; - ReturnToRoot - return to root IVR menu, for Star and Hash only; - ReturnToPrevious - return to previous IVR menu, for Star and Hash only; - Connect - connect to specific extension, for NoInput only; - Disconnect - end call, for NoInput only. |
| SiteIvrActionsExtensionInfo | Extension information |
| SiteIvrTopMenuUpdate | Top IVR Menu extension |
| SiteIvrActionsUpdate | Keys handling settings |
| SiteIvrActionsUpdateInput | |
| SiteIvrActionsUpdateAction | Key handling action: - Repeat - repeat menu greeting, for Star and Hash only; - ReturnToRoot - return to root IVR menu, for Star and Hash only; - ReturnToPrevious - return to previous IVR menu, for Star and Hash only; - Connect - connect to specific extension, for NoInput and "0" (zero) only; - Disconnect - end call, for NoInput only. |
| SiteIvrActionsExtensionInfoUpdate | Extension information |
| Provider | Video provider of the user |
| UserLicenseType | Specifies if the user is 'paid' (has meeting license) or 'free' (w/o meeting license) |
| PagerCallerInfoRequest | Sender of a pager message. |
| GetInternalTextMessageInfoResponseType | Message type |
| ActivePermissionResource | |
| RoleIdResource | |
| Scopes | |
| PermissionResourceSiteCompatible | Site compatibility flag set for permission |
| PermissionCategoryIdResource | |
| ForwardingNumberInfoFeatures | |
| CreateForwardingNumberDeviceInfo | Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter |
| ForwardingNumberInfoType | Forwarding phone number type |
| ForwardingNumberInfoExtension | Extension information. Returned only if extension type is 'ExtensionApps' |
| CreateForwardingNumberRequestType | Forwarding/Call flip phone type. If specified, 'label' attribute value is ignored. The default value is 'Other' |
| ForwardingNumberId | |
| ForwardingNumberResourceFeatures | |
| ForwardingNumberResourceType | Forwarding phone number type |
| UpdateForwardingNumberRequestType | Forwarding phone number type |
| FaxRequestTo | |
| FaxResponseType | Message type - 'Fax' |
| FaxResponseTo | |
| MessageAttachmentInfoIntId | |
| MessageAttachmentInfoIntIdType | Type of message attachment |
| FaxCoverPageInfo | |
| MakeRingOutCallerInfoRequestFrom | Phone number of a caller. This number corresponds to the 1st leg of a RingOut call. This number can be one of the user's configured forwarding numbers or an arbitrary number |
| MakeRingOutCallerInfoRequestTo | Phone number of a called party. This number corresponds to the 2nd leg of a RingOut call |
| MakeRingOutCallerIdInfo | Phone number which will be displayed to the called party |
| MakeRingOutCountryInfo | Optional. Dialing plan country data. If not specified, then an extension home country is applied by default |
| RingOutStatusInfo | RingOut status information |
| CallStatus | Status of a call |
| CallerStatus | Status of a calling party |
| CalleeStatus | Status of a called party |
| RolesBusinessSiteResource | |
| BasicExtensionInfoResource | |
| RolesRegionalSettingsResource | |
| ContactAddressInfoResource | |
| RolesTimezoneResource | |
| RolesCountryResource | |
| RolesLanguageResource | |
| RolesRegionalSettingsResourceTimeFormat | |
| CurrencyResource | |
| MessageStoreCallerInfoRequest | Message sender information. The phoneNumber value should be one the account phone numbers allowed to send the current type of messages |
| SmsRequestCountryInfo | Target number country information. Either id or isoCode can be specified. |
| GetSmsMessageInfoResponseType | Message type |
| FeatureInfo | |
| ParamsInfo | |
| ReasonInfo | Reason for the feature unavailability. Returned only if available is set to false |
| ReasonInfoCode | Reason code |
| CallerBlockingSettingsMode | Call blocking options: either specific or all calls and faxes |
| CallerBlockingSettingsNoCallerId | Determines how to handle calls with no caller ID in Specific mode |
| CallerBlockingSettingsPayPhones | Blocking settings for pay phones |
| BlockedCallerGreetingInfo | |
| CallerBlockingSettingsUpdateMode | Call blocking options: either specific or all calls and faxes |
| CallerBlockingSettingsUpdateNoCallerId | Determines how to handle calls with no caller ID in 'Specific' mode |
| CallerBlockingSettingsUpdatePayPhones | Blocking settings for pay phones |
| NotificationDeliveryModeRequest | Notification delivery transport information |
| MobileDeliveryModeRequest | |
| PubNubDeliveryModeRequest | |
| MobileDeliveryModeRequestTransportType | The transport type for this subscription, or the channel by which an app should be notified of an event |
| PubNubDeliveryModeRequestTransportType | The transport type for this subscription, or the channel by which an app should be notified of an event |
| CountryInfoMinimalModel | |
| LocationInfo | |
| LocationStateInfo | Information on a state this location belongs to |
| DeviceInfoRequest | Device information |
| SipInfoRequest | |
| SoftPhoneLineReassignment | Supported for Softphone clients only. If 'SoftphoneLineReassignment' feature is enabled the reassignment process can be initialized, however if there is no DL for the given user's device then SPR-131 error code will be returned. |
| SipInfoRequestTransport | Supported transport. SIP info will be returned for this transport if supported |
| SipRegistrationDeviceInfo | |
| SipInfoResponse | |
| SipFlagsResponse | SIP flags information |
| SipRegistrationDeviceInfoType | Device type |
| SipRegistrationDeviceInfoStatus | |
| DeviceModelInfo | HardPhone model information |
| DeviceExtensionInfo | |
| DeviceEmergencyServiceAddressResourceDefault | Address for emergency cases. The same emergency address is assigned to all the numbers of one device |
| SipRegistrationDeviceEmergencyInfo | Emergency response location settings of a device |
| DevicePhoneLinesInfo | |
| DeviceAddonInfo | |
| DeviceModelInfoFeatures | |
| SipRegistrationDeviceLocationInfo | Company emergency response location details |
| SipRegistrationDeviceEmergencyInfoAddressStatus | Emergency address status |
| SipRegistrationDeviceEmergencyInfoVisibility | Specifies whether to return only private or only public (company) ERLs (Emergency Response Locations) |
| SipRegistrationDeviceEmergencyInfoSyncStatus | Resulting status of emergency address synchronization. Returned if syncEmergencyAddress parameter is set to true |
| SipRegistrationDeviceEmergencyInfoAddressEditableStatus | Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner) |
| DeviceEmergencyServiceAddressResourceAu | Address for emergency cases. The same emergency address is assigned to all the numbers of one device |
| DeviceEmergencyServiceAddressResourceFr | Address for emergency cases. The same emergency address is assigned to all the numbers of one device |
| LineType | Type of phone line |
| DevicePhoneLinesEmergencyAddressInfo | |
| DevicePhoneNumberInfo | Phone number information |
| DevicePhoneNumberCountryInfo | Brief information on a phone number country |
| DevicePhoneNumberInfoPaymentType | Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local'] |
| DevicePhoneNumberInfoUsageType | |
| DevicePhoneNumberInfoType | Type of phone number |
| AuthorizationType | |
| SipInfoResponseTransport | Preferred transport. SIP info will be returned for this transport if supported |
| JobStatusResponse_1 | |
| JobStatusResponse_2 | |
| JobStatusResponse_3 | |
| JobStatusResponse_4 | |
| JobStatusResponse_5 | |
| JobStatusResponse_6 | |
| JobStatusResponse_7 | |
| JobStatusResponse_1Status | |
| SummaryOutput | |
| CaiErrorResponse | |
| SummaryOutputUnit | |
| SummaryOutputUnitName | |
| SummaryTimingsUnit | |
| CaiErrorCodeResponse | |
| ErrorCode | |
| JobStatusResponse_2Status | |
| PunctuateOutput | |
| JobStatusResponse_3Status | |
| DiarizedObject | |
| DiarizeSegment | |
| JobStatusResponse_4Status | |
| SpeakerIdentificationObject | |
| JobStatusResponse_5Status | |
| TranscribedObject | |
| UtteranceObject | |
| WordSegment | |
| WordTimingsUnit | |
| JobStatusResponse_6Status | |
| EmotionSegment | |
| Emotion | |
| JobStatusResponse_7Status | |
| InteractionObject | |
| UtteranceInsightsObject | |
| SpeakerInsightsObject | |
| ConversationalInsightsUnit | |
| UtteranceInsightsUnit | |
| UtteranceInsightsUnitName | |
| SpeakerInsightsUnit | |
| SpeakerInsightsUnitName | |
| SpeakerInsightsValuesItems | |
| ConversationalInsightsUnitName | |
| ConversationalInsightsUnitValues | |
| SummaryType | Type of summary to be computed |
| SummaryUnit | |
| PagingSchema | |
| EnrollmentQuality | Quality of the enrollment. |
| EnrollmentInputEncoding | The encoding of the original audio |
| EnrollmentPatchInputEncoding | The encoding of the original audio |
| AsrInputEncoding | The encoding of the original audio |
| AsrInputAudioType | Type of the audio |
| SpeechContextPhrasesInput | |
| DiarizeInputEncoding | The encoding of the original audio |
| DiarizeInputAudioType | Type of the audio |
| IdentifyInputEncoding | The encoding of the original audio |
| IdentifyInputAudioType | Type of the audio |
| InteractionInputEncoding | The encoding of the original audio |
| InteractionInputAudioType | Type of the audio |
| InsightsEnum | |
| NonEnumeratedPagingModel | |
| ContentAttachment | |
| ContentBodyFormatted | Text and HTML formatted versions of the content body. |
| ContentBodyInputFormat | Values can be Text or Html. |
| ContentCreatedFrom | Created from of the content. |
| ContentSourceType | Type of the channel. |
| ContentType | Type of the content. |
| To | |
| ContentComponents | |
| Parameters | |
| SocMsgGender | Gender. |
| IdentityType | Type of the identity. |
| ScimSchemaSearchResponseSchemas | |
| ScimSchemaAttribute | |
| ScimMeta | Resource metadata |
| ScimSchemaAttributeType | |
| Mutability | Indicates the circumstances under which the value of the attribute can be (re)defined |
| Returned | Indicates when an attribute and associated values are returned |
| Uniqueness | Specifies how the service provider enforces uniqueness of attribute values |
| ResourceType | |
| ScimUserSearchResponseSchemas | |
| ScimUserAddress | |
| ScimEmail | |
| ScimName | |
| ScimPhoneNumber | |
| ScimPhoto | |
| ScimUserResponseSchemas | |
| ScimEnterpriseUser | |
| ScimUserAddressType | |
| ScimEmailType | |
| ScimPhoneNumberType | |
| ScimPhotoType | |
| ScimUserSchemas | |
| ScimSearchRequestSchemas | |
| ScimPatchOperation | |
| ScimUserPatchSchemas | |
| Op | |
| ScimAuthenticationScheme | |
| ScimBulkSupported | |
| ScimSupported | |
| ScimFilterSupported | |
| ScimProviderConfigSchemas | |
| ScimResourceTypeSearchResponseSchemas | |
| ScimResourceTypeResponseSchema | |
| ScimSchemaExtension | |
| ScimSchemaExtensionSchema | |
| TimeSettings | Date-time range for the calls. The call is considered to be within time range if it started within time range. Both borders are inclusive |
| CallFilters | Optional filters that limit the scope of calls (joined via AND) |
| AggregationResponseOptions | This field provides mapping of possible breakdown options for call aggregation and aggregation formula |
| DirectGrouping | This grouping allows to specify the groupBy option by which the data in the response will be grouped |
| GroupingByMembers | This grouping allows to specify the groupByMembers option. The response data will be grouped by users and will only include users that belong to the scope selected in groupByMembers field |
| GroupingOptions | The selected grouping option |
| MembersGroupingOptions | The selected data scope |
| TimeRange | Time range for the request |
| AdvancedTimeSettings | Allows more granular control over time included in the report |
| DayOfWeek | |
| HoursInterval | |
| ExtensionFilters | Specifies filtering based on extension ids |
| Direction | |
| Origin | |
| CallResponse | |
| CallResult | |
| CallSegmentFilter | |
| CallAction | |
| CompanyHoursOptions | |
| CallDurationFilter | Filtering of calls based on the overall call length |
| TimeSpentFilter | Filtering of calls based on the time spent by specified mailbox(es) on call |
| QueueSlaOptions | |
| CallType | |
| CallSegmentOptions | Call segment for filtering |
| CallSegmentLengthFilter | Duration bounds for the segment |
| AggregationResponseOptionsCounters | The formula is defined by aggregationType and aggregationInterval for every counter individually. If aggregationType is Sum or Percent, aggregationInterval is not supported. If aggregationType is Min, Max or Average, aggregationInterval is required |
| AggregationResponseOptionsTimers | The formula is defined by aggregationType and aggregationInterval for every timer individually. If aggregationType is Sum or Percent, aggregationInterval is not supported. If aggregationType is Min, Max or Average, aggregationInterval is supported, but not required. If left empty, aggregation will be performed on per-call basis |
| AggregationResponseOptionsCountersAllCalls | Aggregation of all calls count |
| AggregationResponseOptionsCountersCallsByDirection | Aggregation of calls count by direction (Inbound, Outbound) |
| AggregationResponseOptionsCountersCallsByOrigin | Aggregation of calls count by origin (Internal, External) |
| AggregationResponseOptionsCountersCallsByResponse | Aggregation of calls count by response (Answered, NotAnswered, Connected, NotConnected) |
| CallsSegments | Aggregation of calls count by segments (Ringing, LiveTalk, Hold, Park, Transfer, IvrPrompt, Voicemail, VmGreeting, Setup) |
| AggregationResponseOptionsCountersCallsByResult | Aggregation of calls count by result (Completed, Abandoned, Voicemail, Unknown, Missed, Accepted) |
| AggregationResponseOptionsCountersCallsByCompanyHours | Aggregation of calls count by company hours (BusinessHours, AfterHours) |
| AggregationResponseOptionsCountersCallsByQueueSla | Aggregation of calls count by queue SLA (InSLA, OutSLA). This counter is only applicable to Queues grouping |
| AggregationResponseOptionsCountersCallsByActions | Aggregation of calls count by action (HoldOff, HoldOn, ParkOn, ParkOff, BlindTransfer, WarmTransfer, DTMFTransfer) |
| AggregationResponseOptionsCountersCallsByType | Aggregation of calls count by type (Direct, FromQueue, ParkRetrieval, Transferred, Outbound) |
| AggregationResponseOptionsCountersQueueOpportunities | Aggregation of calls count by the total number of times a Queue call was presented to the user. It is limited to groupBy Users and groupByMembers (Department, Queue, Site, UserGroup) grouping. Only the listed below options for call filters are applicable to queueOpportunities and provide meaningful results: queues (selected queue extension ids), callResults (Missed, Abandoned), callResponses (Answered, NotAnswered), origins (Internal, External) |
| AggregationType | Counter aggregation type. Can be Sum, Average, Min, Max or Percent |
| AggregationInterval | Time interval which will be used for aggregation. Can be Hour, Day, Week or Month |
| QueueOpportunitiesAggregationType | Counter aggregation type for queue opportunities, limited to Sum only. |
| AllCallsDuration | Aggregation of all calls duration |
| CallsDurationByDirection | Aggregation of calls duration by direction (Inbound, Outbound) |
| CallsDurationByOrigin | Aggregation of calls duration by origin (Internal, External) |
| CallsDurationByResponse | Aggregation of calls duration by response (Answered, NotAnswered, Connected, NotConnected) |
| CallsSegmentsDuration | Aggregation of calls duration by segments (Ringing, LiveTalk, Hold, Park, Transfer, IvrPrompt, Voicemail, VmGreeting, Setup) |
| CallsDurationByResult | Aggregation of calls duration by result (Completed, Abandoned, Voicemail, Unknown, Missed, Accepted) |
| CallsDurationByCompanyHours | Aggregation of calls duration by company hours (BusinessHours, AfterHours) |
| CallsDurationByQueueSla | Aggregation of calls duration by queue SLA (InSLA, OutSLA). This timer is only applicable to Queues grouping |
| CallsDurationByType | Aggregation of calls duration by type (Direct, FromQueue, ParkRetrieval, Transferred, Outbound) |
| ResponsePaging | Paging information |
| AggregationResponseData | Aggregation result |
| AggregationResponseRecord | |
| KeyInfo | Additional info about the key |
| CallsTimers | Call length data for the specified grouping |
| CallsCounters | Call volume data for the specified grouping |
| AllCalls | Data for all calls |
| CallsByDirection | Data for calls with breakdown by direction (Inbound, Outbound) |
| CallsByOrigin | Data for calls with breakdown by origin (Internal, External) |
| CallsByResponse | Data for calls with breakdown by response (Answered, NotAnswered, Connected, NotConnected) |
| CallsBySegments | Data for calls with breakdown by segments (Ringing, LiveTalk, Hold, Park, Transfer, IvrPrompt, Voicemail, VmGreeting, Setup) |
| CallsByResult | Data for calls with breakdown by result (Completed, Abandoned, Voicemail, Unknown, Missed, Accepted) |
| CallsByCompanyHours | Data for calls with breakdown by company hours (BusinessHours, AfterHours) |
| CallsByQueueSla | Data for calls with breakdown by queue SLA (InSLA, OutSLA). This counter is only applicable to Queues grouping |
| CallsByType | Data for calls with breakdown by type (Direct, FromQueue, ParkRetrieval, Transferred, Outbound, Overflow) |
| ValueType | Unit of the result value |
| CallsByDirectionBreakdown | Result breakdown by direction |
| CallsByOriginBreakdown | Result breakdown by origin |
| CallsByResponseBreakdown | Result breakdown by response |
| CallsBySegmentsBreakdown | Result breakdown by segments |
| CallsByResultBreakdown | Result breakdown by call result |
| CallsByCompanyHoursBreakdown | Result breakdown by company hours |
| CallsByQueueSlaBreakdown | Result breakdown by queue SLA |
| CallsByTypeBreakdown | Result breakdown by type |
| CallsByActions | Data for calls with breakdown by action (HoldOff, HoldOn, ParkOn, ParkOff, BlindTransfer, WarmTransfer, DTMFTransfer) |
| QueueOpportunities | Queue opportunities data for the specified grouping |
| CallsByActionsBreakdown | Result breakdown by actions |
| TimelineResponseOptions | Counters and timers options for calls breakdown |
| TimelineResponseOptionsCounters | Options for selecting breakdown for calls count |
| TimelineResponseOptionsTimers | Options for selecting breakdown for calls duration |
| TimelineResponseData | A list of time-value points of call data as per the grouping and filtering options specified in the request |
| TimelineResponseRecord | |
| TimelineResponsePoint | |
| TmTaskInfoType | Task type |
| Creator | |
| TmTaskInfoStatus | Task execution status |
| TmTaskInfoAssignees | |
| TmTaskInfoCompletenessCondition | How the task completeness should be determined |
| TmTaskInfoColor | Font color of a post with the current task |
| TaskRecurrenceInfo | Task information |
| TaskAttachment | |
| AssigneesStatus | Task execution status by assignee |
| TaskRecurrenceInfoSchedule | Recurrence settings of a task. None for non-periodic tasks |
| TaskRecurrenceInfoEndingCondition | Ending condition of a task |
| TaskAttachmentType | Possible value - File. Attachment type (currently, only File is possible) |
| TmUpdateTaskRequestAssignees | |
| TmUpdateTaskRequestCompletenessCondition | |
| TmUpdateTaskRequestColor | |
| TmAttachmentInfo | |
| TmAttachmentInfoType | Type of an attachment |
| TmNavigationInfo | |
| TmCompleteTaskRequestStatus | Completeness status |
| TmCompleteTaskRequestAssignees | |
| TmCreateTaskRequestAssignees | |
| TmCreateTaskRequestCompletenessCondition | |
| TmCreateTaskRequestColor | |
| EventRecurrenceInfo | |
| TmEventInfoColor | Color of Event title (including its presentation in Calendar) |
| EventRecurrenceInfoSchedule | Event recurrence settings. For non-periodic events the value is None. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year |
| EventRecurrenceInfoEndingCondition | Condition of ending an event |
| TmCreateEventRequestColor | Color of Event title (including its presentation in Calendar) |
| TmChatInfoType | Type of chat |
| TmChatInfoStatus | For 'Team' chat type only. Team status. |
| TmChatMemberInfo | |
| TmPostInfoType | Type of post |
| TmMessageAttachmentInfo | |
| TmMentionsInfo | |
| TmMessageAttachmentInfoType | Type of an attachment |
| TmAttachmentAuthorInfo | |
| TmAttachmentFieldsInfo | |
| TmAttachmentFootnoteInfo | |
| TmMessageAttachmentInfoColor | Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card |
| Style | Style of width span applied to a field |
| TmMentionsInfoType | Type of mention |
| AdaptiveCardRequestType | Type of attachment. This field is mandatory and filled on server side - will be ignored if set in request body |
| AdaptiveCardInfoRequest | |
| AdaptiveCardAction | |
| AdaptiveCardSelectAction | An action that will be invoked when the card is tapped or selected. Action.ShowCard is not supported |
| AdaptiveCardRequestLang | The 2-letter ISO-639-1 language used in the card. Used to localize any date/time functions |
| VerticalContentAlignment | Defines how the content should be aligned vertically within the container. Only relevant for fixed-height cards, or cards with a minHeight specified |
| AdaptiveCardInfoRequestType | |
| AdaptiveCardInfoRequestItem | |
| AdaptiveCardInfoRequestItemType | |
| AdaptiveCardColumnInfo | |
| AdaptiveCardColumnItemInfo | |
| AdaptiveCardActionType | |
| ActionAdaptiveCardInfo | |
| ActionAdaptiveCardInfoType | |
| ActionCardBody | |
| ActionCardBodyType | |
| AdaptiveCardSelectActionType | |
| BackgroundImage | Specifies a background image oa a card. Acceptable formats are PNG, JPEG, and GIF |
| BackgroundImageType | Must be BackgroundImage |
| ImageFillMode | Describes how the image should fill the area |
| HorizontalAlignment | Describes how the image should be aligned if it must be cropped or if using repeat fill mode |
| VerticalAlignment | Describes how the image should be aligned if it must be cropped or if using repeat fill mode |
| ImageFillMode_1 | |
| HorizontalAlignment_1 | |
| VerticalAlignment_1 | |
| VerticalContentAlignment_1 | |
| AdaptiveCardShortInfoType | |
| AdaptiveCardCreator | |
| AdaptiveCardInfoType | |
| AdaptiveCardInfoLang | The 2-letter ISO-639-1 language used in the card. Used to localize any date/time functions |
| TmCreatorInfo | Note creator information |
| LastModifiedByInfo | Note last modification information |
| LockedByInfo | Returned for the note being edited (locked) at the current moment. Information on the user editing the note |
| TmNoteInfoStatus | Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active' |
| TmNoteInfoType | |
| TmNoteWithBodyInfoStatus | Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active' |
| TmNoteWithBodyInfoType | |
| TmWebhookInfoStatus | Current status of a webhook |
| TmConversationInfoType | Type of conversation |
| CreateConversationRequestMembers | |
| GlipDataExportNavigationInfo | |
| GlipDataExportPagingInfo | |
| DataExportTaskStatus | Task status |
| CreatorInfo | Task creator information |
| SpecificInfo | Information specified in request |
| ExportTaskResultInfo | |
| DataExportTaskContactInfo | List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported. |
| GlipDataExportNavigationInfoUri | |
| EveryoneTeamInfoType | Type of chat |
| TmTeamInfoType | Type of chat |
| TmTeamInfoStatus | Team status |
| TmCreateTeamRequestMembers | |
| TmRemoveTeamMembersRequestMembers | |
| TmAddTeamMembersRequestMembers | Conversation is opened |
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs