From c754fbad64fd22a461dca0d6913d9da281ebee4f Mon Sep 17 00:00:00 2001 From: Tyler Liu Date: Fri, 17 Jan 2025 09:24:35 -0800 Subject: [PATCH] New spec, new code --- packages/core/src/definitions/AIInsights.ts | 34 + .../src/definitions/AIScoreInsightUnit.ts | 10 + .../definitions/AccountPresenceEventBody.ts | 7 +- .../core/src/definitions/BaseCallLogRecord.ts | 9 +- .../core/src/definitions/BaseTokenRequest.ts | 2 +- .../BatchProvisionUsersRequestItem.ts | 7 - .../BatchProvisionUsersRequestItemContact.ts | 6 + .../definitions/BulletedSummaryInsightUnit.ts | 10 + .../core/src/definitions/CallLogRecord.ts | 9 +- .../src/definitions/CallLogRecordLegInfo.ts | 13 +- .../src/definitions/CallMonitoringGroup.ts | 6 + .../definitions/CallMonitoringGroupSite.ts | 13 + .../core/src/definitions/CallQueueResource.ts | 13 - .../src/definitions/CallSessionStatusInfo.ts | 26 - .../core/src/definitions/CallStatusInfo.ts | 28 +- .../core/src/definitions/ContactResource.ts | 26 - .../src/definitions/ContentBodyFormatted.ts | 14 - .../src/definitions/ContentContextData.ts | 9 - packages/core/src/definitions/ContentList.ts | 16 - packages/core/src/definitions/ContentModel.ts | 299 - .../src/definitions/CostCenterResource.ts | 18 - .../CreateCallMonitoringGroupRequest.ts | 6 + .../CreateCallMonitoringGroupRequestSite.ts | 8 + .../CreateSocialMessagingContentRequest.ts | 126 - .../core/src/definitions/DefaultUserRole.ts | 5 + .../core/src/definitions/DeviceResource.ts | 5 + .../src/definitions/DirectoryRoleResource.ts | 20 - .../definitions/ExtensionCreationRequest.ts | 6 + .../ExtensionRegionalSettingRequest.ts | 5 + .../src/definitions/GetMessageInfoResponse.ts | 5 + .../GetRecordingInsightsParameters.ts | 11 + .../core/src/definitions/GetTokenRequest.ts | 2 +- .../core/src/definitions/GroupResource.ts | 13 - .../src/definitions/HighlightsInsightUnit.ts | 33 + .../core/src/definitions/IdentitiesList.ts | 16 - .../src/definitions/IdentityExtraValues.ts | 7 - .../core/src/definitions/IdentityModel.ts | 248 - .../src/definitions/InternalDeliveryMode.ts | 16 + .../ListCallMonitoringGroupsParameters.ts | 2 +- .../ListDirectoryEntriesParameters.ts | 4 +- .../ListExtensionDevicesParameters.ts | 4 +- .../ListSocialMessagingContentsParameters.ts | 85 - ...ListSocialMessagingIdentitiesParameters.ts | 61 - .../ListUserTemplatesParameters.ts | 2 +- .../src/definitions/NextStepsInsightUnit.ts | 33 + .../definitions/NotificationDeliveryMode.ts | 9 +- .../src/definitions/PartySuperviseResponse.ts | 4 +- packages/core/src/definitions/PeerInfo.ts | 2 +- .../RSConversationalInsightsUnit.ts | 33 + .../ReadDirectoryEntryParameters.ts | 4 +- ...tichannelCallRecordingContentParameters.ts | 16 + .../core/src/definitions/RecordingInsights.ts | 92 + .../src/definitions/ScimUserSearchResponse.ts | 4 +- .../core/src/definitions/ScimUserShortInfo.ts | 62 + .../SearchDirectoryEntriesParameters.ts | 4 +- ...erviceInfoPlan.ts => ServiceInfoPlanV2.ts} | 8 +- .../core/src/definitions/ServiceInfoV2.ts | 4 +- packages/core/src/definitions/ShippingInfo.ts | 2 +- packages/core/src/definitions/SipData.ts | 23 + .../definitions/SocMsgContentAttachment.ts | 86 - .../src/definitions/SummaryInsightUnit.ts | 26 + .../SyncAccountCallLogParameters.ts | 5 +- .../src/definitions/SyncMessagesParameters.ts | 6 +- .../definitions/SyncUserCallLogParameters.ts | 7 +- .../definitions/TMMessageAttachmentInfo.ts | 11 + .../TelephonySessionsEventPartyInfo.ts | 59 +- packages/core/src/definitions/TemplateInfo.ts | 7 +- .../src/definitions/TranscriptInsightUnit.ts | 36 + .../core/src/definitions/TransitionInfo.ts | 16 + packages/core/src/definitions/UiCallInfo.ts | 16 + .../core/src/definitions/UiCallInfoRecord.ts | 14 + .../src/definitions/VoicemailOwnerResource.ts | 16 + .../Domains/Records/Insights/index.ts | 31 + .../Public/Accounts/Domains/Records/index.ts | 25 + .../V1/Public/Accounts/Domains/index.ts | 25 + .../Ai/Ringsense/V1/Public/Accounts/index.ts | 25 + .../src/paths/Ai/Ringsense/V1/Public/index.ts | 20 + .../Ringsense}/V1/index.ts | 11 +- .../SocialMessaging => Ai/Ringsense}/index.ts | 2 +- packages/core/src/paths/Ai/index.ts | 5 + .../Cx/SocialMessaging/V1/Contents/index.ts | 101 - .../Cx/SocialMessaging/V1/Identities/index.ts | 58 - packages/core/src/paths/Cx/index.ts | 18 - .../paths/Restapi/Account/CallLog/index.ts | 4 +- .../Extension/AddressBook/Contact/index.ts | 6 +- .../CallerBlocking/PhoneNumbers/index.ts | 8 +- .../Restapi/Account/Extension/Device/index.ts | 4 +- .../Account/Extension/MessageStore/index.ts | 25 +- .../Account/Extension/Presence/index.ts | 2 +- .../Restapi/Account/PhoneNumber/index.ts | 2 +- .../MultichannelRecordings/Content/index.ts | 33 + .../Metadata/MultichannelRecordings/index.ts | 25 + .../Account/Telephony/Metadata/index.ts | 20 + .../Sessions/Parties/Recordings/index.ts | 4 +- .../paths/Restapi/Account/Telephony/index.ts | 5 + .../paths/TeamMessaging/V1/Persons/index.ts | 4 +- packages/core/src/samples.md | 9366 ++++++++--------- 97 files changed, 5629 insertions(+), 6070 deletions(-) create mode 100644 packages/core/src/definitions/AIInsights.ts create mode 100644 packages/core/src/definitions/AIScoreInsightUnit.ts create mode 100644 packages/core/src/definitions/BulletedSummaryInsightUnit.ts create mode 100644 packages/core/src/definitions/CallMonitoringGroupSite.ts delete mode 100644 packages/core/src/definitions/CallQueueResource.ts delete mode 100644 packages/core/src/definitions/CallSessionStatusInfo.ts delete mode 100644 packages/core/src/definitions/ContentBodyFormatted.ts delete mode 100644 packages/core/src/definitions/ContentContextData.ts delete mode 100644 packages/core/src/definitions/ContentList.ts delete mode 100644 packages/core/src/definitions/ContentModel.ts delete mode 100644 packages/core/src/definitions/CostCenterResource.ts create mode 100644 packages/core/src/definitions/CreateCallMonitoringGroupRequestSite.ts delete mode 100644 packages/core/src/definitions/CreateSocialMessagingContentRequest.ts delete mode 100644 packages/core/src/definitions/DirectoryRoleResource.ts create mode 100644 packages/core/src/definitions/GetRecordingInsightsParameters.ts delete mode 100644 packages/core/src/definitions/GroupResource.ts create mode 100644 packages/core/src/definitions/HighlightsInsightUnit.ts delete mode 100644 packages/core/src/definitions/IdentitiesList.ts delete mode 100644 packages/core/src/definitions/IdentityExtraValues.ts delete mode 100644 packages/core/src/definitions/IdentityModel.ts create mode 100644 packages/core/src/definitions/InternalDeliveryMode.ts delete mode 100644 packages/core/src/definitions/ListSocialMessagingContentsParameters.ts delete mode 100644 packages/core/src/definitions/ListSocialMessagingIdentitiesParameters.ts create mode 100644 packages/core/src/definitions/NextStepsInsightUnit.ts create mode 100644 packages/core/src/definitions/RSConversationalInsightsUnit.ts create mode 100644 packages/core/src/definitions/ReadMultichannelCallRecordingContentParameters.ts create mode 100644 packages/core/src/definitions/RecordingInsights.ts create mode 100644 packages/core/src/definitions/ScimUserShortInfo.ts rename packages/core/src/definitions/{ServiceInfoPlan.ts => ServiceInfoPlanV2.ts} (59%) create mode 100644 packages/core/src/definitions/SipData.ts delete mode 100644 packages/core/src/definitions/SocMsgContentAttachment.ts create mode 100644 packages/core/src/definitions/SummaryInsightUnit.ts create mode 100644 packages/core/src/definitions/TranscriptInsightUnit.ts create mode 100644 packages/core/src/definitions/TransitionInfo.ts create mode 100644 packages/core/src/definitions/UiCallInfo.ts create mode 100644 packages/core/src/definitions/UiCallInfoRecord.ts create mode 100644 packages/core/src/definitions/VoicemailOwnerResource.ts create mode 100644 packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/Insights/index.ts create mode 100644 packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/index.ts create mode 100644 packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.ts create mode 100644 packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/index.ts create mode 100644 packages/core/src/paths/Ai/Ringsense/V1/Public/index.ts rename packages/core/src/paths/{Cx/SocialMessaging => Ai/Ringsense}/V1/index.ts (55%) rename packages/core/src/paths/{Cx/SocialMessaging => Ai/Ringsense}/index.ts (87%) delete mode 100644 packages/core/src/paths/Cx/SocialMessaging/V1/Contents/index.ts delete mode 100644 packages/core/src/paths/Cx/SocialMessaging/V1/Identities/index.ts delete mode 100644 packages/core/src/paths/Cx/index.ts create mode 100644 packages/core/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/Content/index.ts create mode 100644 packages/core/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/index.ts create mode 100644 packages/core/src/paths/Restapi/Account/Telephony/Metadata/index.ts diff --git a/packages/core/src/definitions/AIInsights.ts b/packages/core/src/definitions/AIInsights.ts new file mode 100644 index 000000000..79bbaeaef --- /dev/null +++ b/packages/core/src/definitions/AIInsights.ts @@ -0,0 +1,34 @@ +import type TranscriptInsightUnit from './TranscriptInsightUnit'; +import type SummaryInsightUnit from './SummaryInsightUnit'; +import type HighlightsInsightUnit from './HighlightsInsightUnit'; +import type NextStepsInsightUnit from './NextStepsInsightUnit'; +import type BulletedSummaryInsightUnit from './BulletedSummaryInsightUnit'; +import type AIScoreInsightUnit from './AIScoreInsightUnit'; + +interface AIInsights { + /** + */ + Transcript?: TranscriptInsightUnit[]; + + /** + */ + Summary?: SummaryInsightUnit[]; + + /** + */ + Highlights?: HighlightsInsightUnit[]; + + /** + */ + NextSteps?: NextStepsInsightUnit[]; + + /** + */ + BulletedSummary?: BulletedSummaryInsightUnit[]; + + /** + */ + AIScore?: AIScoreInsightUnit[]; +} + +export default AIInsights; diff --git a/packages/core/src/definitions/AIScoreInsightUnit.ts b/packages/core/src/definitions/AIScoreInsightUnit.ts new file mode 100644 index 000000000..81ecb37de --- /dev/null +++ b/packages/core/src/definitions/AIScoreInsightUnit.ts @@ -0,0 +1,10 @@ +interface AIScoreInsightUnit { + /** + * Value of the score + * Required + * Example: 7 + */ + value?: string; +} + +export default AIScoreInsightUnit; diff --git a/packages/core/src/definitions/AccountPresenceEventBody.ts b/packages/core/src/definitions/AccountPresenceEventBody.ts index 9ad199d3f..5bc0c63bf 100644 --- a/packages/core/src/definitions/AccountPresenceEventBody.ts +++ b/packages/core/src/definitions/AccountPresenceEventBody.ts @@ -9,7 +9,7 @@ interface AccountPresenceEventBody { extensionId?: string; /** - * Telephony presence status. Returned if telephony status is changed. + * Telephony presence status. Returned if telephony status is changed */ telephonyStatus?: 'NoCall' | 'CallConnected' | 'Ringing' | 'OnHold' | 'ParkedCall'; @@ -34,6 +34,11 @@ interface AccountPresenceEventBody { */ dndStatus?: 'TakeAllCalls' | 'DoNotAcceptAnyCalls' | 'DoNotAcceptDepartmentCalls' | 'TakeDepartmentCallsOnly'; + /** + * Meetings presence status. Specifies if a user is on a meeting + */ + meetingStatus?: 'Connected' | 'Disconnected'; + /** * If `true` enables other extensions to see the extension presence status */ diff --git a/packages/core/src/definitions/BaseCallLogRecord.ts b/packages/core/src/definitions/BaseCallLogRecord.ts index d916c3c79..8a6d8d186 100644 --- a/packages/core/src/definitions/BaseCallLogRecord.ts +++ b/packages/core/src/definitions/BaseCallLogRecord.ts @@ -263,15 +263,13 @@ interface BaseCallLogRecord { /** * Call duration in seconds - * Required - * Format: int32 + * Format: int64 */ duration?: number; /** * Call duration in milliseconds - * Required - * Format: int32 + * Format: int64 */ durationMs?: number; @@ -304,7 +302,8 @@ interface BaseCallLogRecord { | 'Vma' | 'LocalNumber' | 'ImsOutgoing' - | 'ImsIncoming'; + | 'ImsIncoming' + | 'Unknown'; } export default BaseCallLogRecord; diff --git a/packages/core/src/definitions/BaseTokenRequest.ts b/packages/core/src/definitions/BaseTokenRequest.ts index 1535ebced..2b90b4c66 100644 --- a/packages/core/src/definitions/BaseTokenRequest.ts +++ b/packages/core/src/definitions/BaseTokenRequest.ts @@ -49,7 +49,7 @@ interface BaseTokenRequest { /** * Refresh token lifetime in seconds - * Maximum: 604800 + * Maximum: 2592000 * Format: int32 * Default: 604800 */ diff --git a/packages/core/src/definitions/BatchProvisionUsersRequestItem.ts b/packages/core/src/definitions/BatchProvisionUsersRequestItem.ts index 7dbc72f3e..a21b45d5e 100644 --- a/packages/core/src/definitions/BatchProvisionUsersRequestItem.ts +++ b/packages/core/src/definitions/BatchProvisionUsersRequestItem.ts @@ -38,13 +38,6 @@ interface BatchProvisionUsersRequestItem { /** */ devices?: BatchProvisionUsersRequestItemDevices[]; - - /** - * Specifies if a welcome/activation email is sent to the new users (within extension status changing from - * 'Unassigned' to 'NotActivated/Disabled') - * Default: true - */ - sendWelcomeEmail?: boolean; } export default BatchProvisionUsersRequestItem; diff --git a/packages/core/src/definitions/BatchProvisionUsersRequestItemContact.ts b/packages/core/src/definitions/BatchProvisionUsersRequestItemContact.ts index 42a1a8aed..7c5d171f1 100644 --- a/packages/core/src/definitions/BatchProvisionUsersRequestItemContact.ts +++ b/packages/core/src/definitions/BatchProvisionUsersRequestItemContact.ts @@ -1,3 +1,5 @@ +import type TransitionInfo from './TransitionInfo'; + interface BatchProvisionUsersRequestItemContact { /** * Given name @@ -30,6 +32,10 @@ interface BatchProvisionUsersRequestItemContact { * Default: true */ emailAsLoginName?: boolean; + + /** + */ + transition?: TransitionInfo; } export default BatchProvisionUsersRequestItemContact; diff --git a/packages/core/src/definitions/BulletedSummaryInsightUnit.ts b/packages/core/src/definitions/BulletedSummaryInsightUnit.ts new file mode 100644 index 000000000..6625d81e9 --- /dev/null +++ b/packages/core/src/definitions/BulletedSummaryInsightUnit.ts @@ -0,0 +1,10 @@ +interface BulletedSummaryInsightUnit { + /** + * Value of the summary + * Required + * Example: conversational insights text + */ + value?: string; +} + +export default BulletedSummaryInsightUnit; diff --git a/packages/core/src/definitions/CallLogRecord.ts b/packages/core/src/definitions/CallLogRecord.ts index 5631b432a..eec44acff 100644 --- a/packages/core/src/definitions/CallLogRecord.ts +++ b/packages/core/src/definitions/CallLogRecord.ts @@ -264,15 +264,13 @@ interface CallLogRecord { /** * Call duration in seconds - * Required - * Format: int32 + * Format: int64 */ duration?: number; /** * Call duration in milliseconds - * Required - * Format: int32 + * Format: int64 */ durationMs?: number; @@ -305,7 +303,8 @@ interface CallLogRecord { | 'Vma' | 'LocalNumber' | 'ImsOutgoing' - | 'ImsIncoming'; + | 'ImsIncoming' + | 'Unknown'; /** * Internal identifier of a call log record diff --git a/packages/core/src/definitions/CallLogRecordLegInfo.ts b/packages/core/src/definitions/CallLogRecordLegInfo.ts index 221620328..66b91cd30 100644 --- a/packages/core/src/definitions/CallLogRecordLegInfo.ts +++ b/packages/core/src/definitions/CallLogRecordLegInfo.ts @@ -263,15 +263,13 @@ interface CallLogRecordLegInfo { /** * Call duration in seconds - * Required - * Format: int32 + * Format: int64 */ duration?: number; /** * Call duration in milliseconds - * Required - * Format: int32 + * Format: int64 */ durationMs?: number; @@ -304,7 +302,8 @@ interface CallLogRecordLegInfo { | 'Vma' | 'LocalNumber' | 'ImsOutgoing' - | 'ImsIncoming'; + | 'ImsIncoming' + | 'Unknown'; /** * Leg type @@ -340,6 +339,7 @@ interface CallLogRecordLegInfo { | 'Hunting' | 'OutgoingFreeSpDl' | 'ParkLocation' + | 'CallMeCallOut' | 'ConferenceCall' | 'MobileApp' | 'MoveToConference' @@ -350,7 +350,8 @@ interface CallLogRecordLegInfo { | 'Pickup' | 'ImsCall' | 'JoinCall' - | 'TextRelay'; + | 'TextRelay' + | 'IvaCall'; /** * Returned for 'Detailed' call log. Specifies if the leg is master-leg diff --git a/packages/core/src/definitions/CallMonitoringGroup.ts b/packages/core/src/definitions/CallMonitoringGroup.ts index 8f75a44a3..1fbf6add7 100644 --- a/packages/core/src/definitions/CallMonitoringGroup.ts +++ b/packages/core/src/definitions/CallMonitoringGroup.ts @@ -1,3 +1,5 @@ +import type CallMonitoringGroupSite from './CallMonitoringGroupSite'; + interface CallMonitoringGroup { /** * Link to a call monitoring group resource @@ -14,6 +16,10 @@ interface CallMonitoringGroup { * Name of a group */ name?: string; + + /** + */ + site?: CallMonitoringGroupSite; } export default CallMonitoringGroup; diff --git a/packages/core/src/definitions/CallMonitoringGroupSite.ts b/packages/core/src/definitions/CallMonitoringGroupSite.ts new file mode 100644 index 000000000..d21c768c2 --- /dev/null +++ b/packages/core/src/definitions/CallMonitoringGroupSite.ts @@ -0,0 +1,13 @@ +interface CallMonitoringGroupSite { + /** + * Identifier of a site + */ + id?: string; + + /** + * Name of a site + */ + name?: string; +} + +export default CallMonitoringGroupSite; diff --git a/packages/core/src/definitions/CallQueueResource.ts b/packages/core/src/definitions/CallQueueResource.ts deleted file mode 100644 index 94122ee54..000000000 --- a/packages/core/src/definitions/CallQueueResource.ts +++ /dev/null @@ -1,13 +0,0 @@ -interface CallQueueResource { - /** - * Example: 873014540006 - */ - id?: string; - - /** - * Example: Sales CQ - */ - name?: string; -} - -export default CallQueueResource; diff --git a/packages/core/src/definitions/CallSessionStatusInfo.ts b/packages/core/src/definitions/CallSessionStatusInfo.ts deleted file mode 100644 index 59785dede..000000000 --- a/packages/core/src/definitions/CallSessionStatusInfo.ts +++ /dev/null @@ -1,26 +0,0 @@ -import type PeerInfo from './PeerInfo'; -import type MobilePickupData from './MobilePickupData'; - -interface CallSessionStatusInfo { - /** - */ - code?: string; - - /** - */ - reason?: string; - - /** - */ - parkData?: string; - - /** - */ - peerId?: PeerInfo; - - /** - */ - mobilePickupData?: MobilePickupData; -} - -export default CallSessionStatusInfo; diff --git a/packages/core/src/definitions/CallStatusInfo.ts b/packages/core/src/definitions/CallStatusInfo.ts index b720dce2d..985ec7d3a 100644 --- a/packages/core/src/definitions/CallStatusInfo.ts +++ b/packages/core/src/definitions/CallStatusInfo.ts @@ -1,4 +1,5 @@ import type PeerInfo from './PeerInfo'; +import type MobilePickupData from './MobilePickupData'; /** * Status data of a call session @@ -21,11 +22,7 @@ interface CallStatusInfo { | 'VoiceMailScreening'; /** - */ - peerId?: PeerInfo; - - /** - * Reason for call termination. For 'Disconnected' code only + * Reason for a call status, might be specified for some codes */ reason?: | 'Pickup' @@ -56,12 +53,31 @@ interface CallStatusInfo { | 'CallReplied' | 'CallSwitch' | 'CallFinished' - | 'CallDropped'; + | 'CallDropped' + | 'Voicemail'; /** * Optional message */ description?: string; + + /** + * Call park data. Returned for calls in 'Parked' state + */ + parkData?: string; + + /** + */ + peerId?: PeerInfo; + + /** + */ + mobilePickupData?: MobilePickupData; + + /** + * Specifies if it's a conference call + */ + rcc?: boolean; } export default CallStatusInfo; diff --git a/packages/core/src/definitions/ContactResource.ts b/packages/core/src/definitions/ContactResource.ts index 5db4a29a3..2e5f031ee 100644 --- a/packages/core/src/definitions/ContactResource.ts +++ b/packages/core/src/definitions/ContactResource.ts @@ -2,11 +2,7 @@ import type AccountResource from './AccountResource'; import type PhoneNumberResource from './PhoneNumberResource'; import type AccountDirectoryProfileImageResource from './AccountDirectoryProfileImageResource'; import type BusinessSiteResource from './BusinessSiteResource'; -import type DirectoryRoleResource from './DirectoryRoleResource'; -import type CallQueueResource from './CallQueueResource'; import type CustomFieldResource from './CustomFieldResource'; -import type GroupResource from './GroupResource'; -import type CostCenterResource from './CostCenterResource'; import type ExternalIntegrationResource from './ExternalIntegrationResource'; interface ContactResource { @@ -107,35 +103,13 @@ interface ContactResource { */ hidden?: boolean; - /** - */ - role?: DirectoryRoleResource; - - /** - */ - callQueues?: CallQueueResource[]; - /** */ customFields?: CustomFieldResource[]; - /** - */ - groups?: GroupResource[]; - - /** - */ - costCenter?: CostCenterResource; - /** */ integration?: ExternalIntegrationResource; - - /** - * Extension subtype - * Example: Unknown - */ - subType?: 'Unknown' | 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Emergency'; } export default ContactResource; diff --git a/packages/core/src/definitions/ContentBodyFormatted.ts b/packages/core/src/definitions/ContentBodyFormatted.ts deleted file mode 100644 index 918d22494..000000000 --- a/packages/core/src/definitions/ContentBodyFormatted.ts +++ /dev/null @@ -1,14 +0,0 @@ -/** - * Text and HTML formatted versions of the content body - */ -interface ContentBodyFormatted { - /** - */ - html?: string; - - /** - */ - text?: string; -} - -export default ContentBodyFormatted; diff --git a/packages/core/src/definitions/ContentContextData.ts b/packages/core/src/definitions/ContentContextData.ts deleted file mode 100644 index 7473d4c9f..000000000 --- a/packages/core/src/definitions/ContentContextData.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * Additional data of the content. - * The `contextData` hash keys are the custom fields keys - * - */ -// eslint-disable-next-line @typescript-eslint/no-empty-interface -interface ContentContextData {} - -export default ContentContextData; diff --git a/packages/core/src/definitions/ContentList.ts b/packages/core/src/definitions/ContentList.ts deleted file mode 100644 index d5c57d6bd..000000000 --- a/packages/core/src/definitions/ContentList.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type ContentModel from './ContentModel'; -import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel'; - -interface ContentList { - /** - * Required - */ - records?: ContentModel[]; - - /** - * Required - */ - paging?: NonEnumeratedPagingModel; -} - -export default ContentList; diff --git a/packages/core/src/definitions/ContentModel.ts b/packages/core/src/definitions/ContentModel.ts deleted file mode 100644 index 4ecf9cbca..000000000 --- a/packages/core/src/definitions/ContentModel.ts +++ /dev/null @@ -1,299 +0,0 @@ -import type SocMsgContentAttachment from './SocMsgContentAttachment'; -import type ContentBodyFormatted from './ContentBodyFormatted'; -import type ContentContextData from './ContentContextData'; - -interface ContentModel { - /** - * Array of attachments to be added to the content - * Required - */ - attachments?: SocMsgContentAttachment[]; - - /** - * Identity identifier of the content author. Not mandatory on creation, - * by default it uses the token's user first identity on channel - * Required - */ - authorIdentityId?: string; - - /** - * Auto submitted content: - * - won't reopen tasks or interventions - * - can be used to send automatic messages like asking an user to follow on twitter, sending a survey, etc, - * - doesn't get included in statistics - * Required - */ - autoSubmitted?: boolean; - - /** - * Content body. On creation this field is mandatory except for WhatsApp content - * using templates. The following are the channels supported and their **max length** - * restrictions (in brackets): - * - * - *Apple Messages For Business* (10000) - * - *Email* (262144) - * - *RingCX Digital Messaging* (1024) - * - *Facebook* (8000) - * - *Google My Business* (4000) - * - *Instagram* (950) - * - *Instagram Messaging* (1000) - * - *LinkedIn* (3000) - * - *Messenger* (2000) - * - *Twitter* (280) - * - *Viber* (7000) - * - *WhatsApp* (3800) - * - *Youtube* (8000) - * Required - * Example: Body of the content - */ - body?: string; - - /** - * Required - */ - bodyFormatted?: ContentBodyFormatted; - - /** - * Content input format - * Required - */ - bodyInputFormat?: 'Text' | 'Html'; - - /** - * List of the category identifiers of the content - * Required - * Example: 541014e17aa58d8ccf000023,541014e17aa58d8ccf002023 - */ - categoryIds?: string[]; - - /** - * Direction of the content. - * - * * Incoming contents are received from a channel. - * * Outgoing contents are exported to a channel. - * Example: Incoming - */ - contentDirection?: 'Incoming' | 'Outgoing'; - - /** - */ - contextData?: ContentContextData; - - /** - * Creation time of the resource. - * Required - * Format: date-time - * Example: 2023-02-04T12:43:07Z - */ - creationTime?: string; - - /** - * Source of content - * Required - */ - createdFrom?: 'Synchronizer' | 'Interface' | 'Api' | 'AutoSurvey' | 'AutoResponseTrigger' | 'AutoRequestEmail'; - - /** - * RingCentral user identifier of the creator - * Required - * Example: 2683222036 - */ - creatorId?: string; - - /** - * True if the content is the first in the thread. - */ - firstInThread?: boolean; - - /** - * External categories of the content. - * Returned only if the content has `foreignCategories` - * Example: foreign_category_id - */ - foreignCategories?: string[]; - - /** - * Content identifier - * Required - */ - id?: string; - - /** - * Identifier of the content identity to which this content is a reply to. - * If the channel does not support discussion initiation, this parameter is mandatory - * Required - */ - inReplyToAuthorIdentityId?: string; - - /** - * Content identifier to which this content is a reply to. On creation, if omitted, - * a new discussion will be created. If the channel does not support discussion initiation, - * this parameter is mandatory - * Required - */ - inReplyToContentId?: string; - - /** - * Intervention identifier of the content - * Required - */ - interventionId?: string; - - /** - * Language of the content - * Required - * Example: En - */ - language?: string; - - /** - * If set to `true`, then the content is publicly visible on remote channel. - * Private content is NOT supported on every channel - * Required - * Default: true - */ - public?: boolean; - - /** - * If set to `true`, then the content is published on remote channel - * Required - * Example: true - */ - published?: boolean; - - /** - * Rating of content. Present only if the content supports rating and rating is filled - * Required - * Format: int32 - * Example: 4 - */ - rating?: number; - - /** - * Set to `true` if content has been deleted on remote channel - * Required - */ - remotelyDeleted?: boolean; - - /** - * Channel identifier. - * Required - * Example: 506d9e817aa58d1259000f12 - */ - channelId?: string; - - /** - * Type of a channel - * Required - */ - channelType?: - | 'AppleMessagesForBusiness' - | 'Email' - | 'EngageMessaging' - | 'Facebook' - | 'GoogleMyBusiness' - | 'Instagram' - | 'InstagramMessaging' - | 'Linkedin' - | 'Messenger' - | 'Twitter' - | 'Viber' - | 'WhatsApp' - | 'Youtube'; - - /** - * External URI of a content channel - * Required - * Format: uri - */ - channelUri?: string; - - /** - * Content status - * Required - */ - status?: 'New' | 'Assigned' | 'Replied' | 'UserReply' | 'UserInitiated' | 'Ignored'; - - /** - * Synchronization status - * Required - * Example: success - */ - synchronizationStatus?: string; - - /** - * Synchronization error details - * Required - */ - synchronizationError?: string; - - /** - * Content thread identifier - * Required - */ - threadId?: string; - - /** - * Applicable to Email channels only. The subject of the email. - * This field is mandatory when initiating a discussion - * Required - * Example: An email title - */ - title?: string; - - /** - * Type of the content - * Required - * Example: Email - */ - type?: - | 'Album' - | 'AuthenticateMessage' - | 'AuthenticateResponse' - | 'Carousel' - | 'CarouselMessage' - | 'Comment' - | 'ContactMessage' - | 'Content' - | 'Email' - | 'FormMessage' - | 'FormResponse' - | 'HsmMessage' - | 'Link' - | 'ListMessage' - | 'Media' - | 'Message' - | 'OutboundMessage' - | 'PaymentMessage' - | 'Photo' - | 'PostbackMessage' - | 'PrivateTweet' - | 'PromptMessage' - | 'Question' - | 'Review' - | 'ReviewResponse' - | 'RichLinkMessage' - | 'SelectMessage' - | 'Status' - | 'TemplateMessage' - | 'TimePickerMessage' - | 'Tweet' - | 'Video' - | 'VideoCallRequestMessage'; - - /** - * The time when the last modification was completed. - * Required - * Format: date-time - * Example: 2023-02-04T12:43:07Z - */ - lastModifiedTime?: string; - - /** - * Types of structured messages that can be used to reply to this type of message - * Required - */ - capabilitiesSupported?: string[]; -} - -export default ContentModel; diff --git a/packages/core/src/definitions/CostCenterResource.ts b/packages/core/src/definitions/CostCenterResource.ts deleted file mode 100644 index af9cebafb..000000000 --- a/packages/core/src/definitions/CostCenterResource.ts +++ /dev/null @@ -1,18 +0,0 @@ -interface CostCenterResource { - /** - * Example: 83266549237542 - */ - id?: string; - - /** - * Example: Main - */ - code?: string; - - /** - * Example: Cost Center A - */ - name?: string; -} - -export default CostCenterResource; diff --git a/packages/core/src/definitions/CreateCallMonitoringGroupRequest.ts b/packages/core/src/definitions/CreateCallMonitoringGroupRequest.ts index 3ac06796d..1f0730035 100644 --- a/packages/core/src/definitions/CreateCallMonitoringGroupRequest.ts +++ b/packages/core/src/definitions/CreateCallMonitoringGroupRequest.ts @@ -1,9 +1,15 @@ +import type CreateCallMonitoringGroupRequestSite from './CreateCallMonitoringGroupRequestSite'; + interface CreateCallMonitoringGroupRequest { /** * Name of a group * Required */ name?: string; + + /** + */ + site?: CreateCallMonitoringGroupRequestSite; } export default CreateCallMonitoringGroupRequest; diff --git a/packages/core/src/definitions/CreateCallMonitoringGroupRequestSite.ts b/packages/core/src/definitions/CreateCallMonitoringGroupRequestSite.ts new file mode 100644 index 000000000..5608f0bde --- /dev/null +++ b/packages/core/src/definitions/CreateCallMonitoringGroupRequestSite.ts @@ -0,0 +1,8 @@ +interface CreateCallMonitoringGroupRequestSite { + /** + * Identifier of a site + */ + id?: string; +} + +export default CreateCallMonitoringGroupRequestSite; diff --git a/packages/core/src/definitions/CreateSocialMessagingContentRequest.ts b/packages/core/src/definitions/CreateSocialMessagingContentRequest.ts deleted file mode 100644 index 8c6aa7d66..000000000 --- a/packages/core/src/definitions/CreateSocialMessagingContentRequest.ts +++ /dev/null @@ -1,126 +0,0 @@ -import type ContentContextData from './ContentContextData'; - -/** - * Request body for operation createSocialMessagingContent - */ -interface CreateSocialMessagingContentRequest { - /** - * Identity identifier of the content author. Not mandatory on creation, - * by default it uses the token's user first identity on channel - */ - authorIdentityId?: string; - - /** - * Content body. On creation this field is mandatory except for WhatsApp content - * using templates. The following are the channels supported and their **max length** - * restrictions (in brackets): - * - * - *Apple Messages For Business* (10000) - * - *Email* (262144) - * - *RingCX Digital Messaging* (1024) - * - *Facebook* (8000) - * - *Google My Business* (4000) - * - *Instagram* (950) - * - *Instagram Messaging* (1000) - * - *LinkedIn* (3000) - * - *Messenger* (2000) - * - *Twitter* (280) - * - *Viber* (7000) - * - *WhatsApp* (3800) - * - *Youtube* (8000) - * Example: Body of the content - */ - body?: string; - - /** - * Content identifier to which this content is a reply to. On creation, if omitted, - * a new discussion will be created. If the channel does not support discussion initiation, - * this parameter is mandatory - */ - inReplyToContentId?: string; - - /** - * If set to `true`, then the content is publicly visible on remote channel. - * Private content is NOT supported on every channel - * Default: true - */ - public?: boolean; - - /** - * Channel identifier. - * Example: 506d9e817aa58d1259000f12 - */ - channelId?: string; - - /** - * List of attachment identifiers to be added to the content - * Example: 541014e17aa58d8ccf000023,541014e17aa58d8ccf000023 - */ - attachmentIds?: string[]; - - /** - * Applicable to Email channels only. The subject of the email. - * This field is mandatory when initiating a discussion - * Example: An email title - */ - title?: string; - - /** - * Applicable to Email channels only. - * An array containing the email addresses used in sections of the email. - * This parameter is mandatory when initiating a discussion - */ - to?: string[]; - - /** - * Applicable to Email channels only. - * An array containing the email addresses used in sections of the email. - * This parameter is mandatory when initiating a discussion - */ - cc?: string[]; - - /** - * Applicable to Email channels only. - * An array containing the email addresses used in sections of the email. - * This parameter is mandatory when initiating a discussion - */ - bcc?: string[]; - - /** - * Applicable to WhatsApp channels only. Name of the WhatsApp template to use for the content. - * All available template names are visible on the WhatsApp Business Manager interface - * Example: customer_order_shipment_template - */ - templateName?: string; - - /** - * Applicable to WhatsApp channels only. Language of the WhatsApp template - * to use for the content. All available template languages are visible on - * the WhatsApp Business Manager interface. Language specified must conform - * to the ISO 639-1 alpha-2 codes for representing the names of languages - * Example: fr - */ - templateLanguage?: string; - - /** - * Applicable to WhatsApp channels only. Component configuration of the WhatsApp - * template to use for the content. All available components are visible on - * the WhatsApp Business Manager interface - * Example: [object Object],[object Object] - */ - components?: object[]; - - /** - */ - contextData?: ContentContextData; - - /** - * Auto submitted content: - * - won't reopen tasks or interventions - * - can be used to send automatic messages like asking an user to follow on twitter, sending a survey, etc, - * - doesn't get included in statistics - */ - autoSubmitted?: boolean; -} - -export default CreateSocialMessagingContentRequest; diff --git a/packages/core/src/definitions/DefaultUserRole.ts b/packages/core/src/definitions/DefaultUserRole.ts index 16d93222d..c170924c4 100644 --- a/packages/core/src/definitions/DefaultUserRole.ts +++ b/packages/core/src/definitions/DefaultUserRole.ts @@ -15,6 +15,11 @@ interface DefaultUserRole { * Example: My Custom User Role */ displayName?: string; + + /** + * Site compatibility of a user role + */ + siteCompatible?: boolean; } export default DefaultUserRole; diff --git a/packages/core/src/definitions/DeviceResource.ts b/packages/core/src/definitions/DeviceResource.ts index dde7e4d8d..6c83bafd9 100644 --- a/packages/core/src/definitions/DeviceResource.ts +++ b/packages/core/src/definitions/DeviceResource.ts @@ -133,6 +133,11 @@ interface DeviceResource { /** */ billingStatement?: BillingStatementInfo; + + /** + * Ability to access the Voicemail without being prompted to enter a PIN from the hard phone + */ + automaticVoicemailLogin?: boolean; } export default DeviceResource; diff --git a/packages/core/src/definitions/DirectoryRoleResource.ts b/packages/core/src/definitions/DirectoryRoleResource.ts deleted file mode 100644 index 321202a53..000000000 --- a/packages/core/src/definitions/DirectoryRoleResource.ts +++ /dev/null @@ -1,20 +0,0 @@ -interface DirectoryRoleResource { - /** - * Required - */ - id?: string; - - /** - */ - name?: string; - - /** - */ - domain?: string; - - /** - */ - displayName?: string; -} - -export default DirectoryRoleResource; diff --git a/packages/core/src/definitions/ExtensionCreationRequest.ts b/packages/core/src/definitions/ExtensionCreationRequest.ts index 7b628bb49..7f4d500e0 100644 --- a/packages/core/src/definitions/ExtensionCreationRequest.ts +++ b/packages/core/src/definitions/ExtensionCreationRequest.ts @@ -93,6 +93,12 @@ interface ExtensionCreationRequest { * to `false` by default */ hidden?: boolean; + + /** + * Extension name. For user extension types the value is a combination + * of the specified first name and last name + */ + name?: string; } export default ExtensionCreationRequest; diff --git a/packages/core/src/definitions/ExtensionRegionalSettingRequest.ts b/packages/core/src/definitions/ExtensionRegionalSettingRequest.ts index 68dbe9874..3db8a7372 100644 --- a/packages/core/src/definitions/ExtensionRegionalSettingRequest.ts +++ b/packages/core/src/definitions/ExtensionRegionalSettingRequest.ts @@ -5,6 +5,11 @@ import type ExtensionGreetingLanguageInfoRequest from './ExtensionGreetingLangua import type ExtensionFormattingLocaleInfoRequest from './ExtensionFormattingLocaleInfoRequest'; import type ExtensionCurrencyInfoRequest from './ExtensionCurrencyInfoRequest'; +/** + * Regional data (timezone, home country, language) of an extension. + * The default is Company (Auto-Receptionist) settings + * + */ interface ExtensionRegionalSettingRequest { /** */ diff --git a/packages/core/src/definitions/GetMessageInfoResponse.ts b/packages/core/src/definitions/GetMessageInfoResponse.ts index 0baa95835..5db01eecf 100644 --- a/packages/core/src/definitions/GetMessageInfoResponse.ts +++ b/packages/core/src/definitions/GetMessageInfoResponse.ts @@ -2,6 +2,7 @@ import type MessageAttachmentInfo from './MessageAttachmentInfo'; import type ConversationInfo from './ConversationInfo'; import type MessageStoreCallerInfoResponseFrom from './MessageStoreCallerInfoResponseFrom'; import type MessageStoreCallerInfoResponseTo from './MessageStoreCallerInfoResponseTo'; +import type VoicemailOwnerResource from './VoicemailOwnerResource'; interface GetMessageInfoResponse { /** @@ -171,6 +172,10 @@ interface GetMessageInfoResponse { * cover page. Maximum length is limited to 1024 symbols */ coverPageText?: string; + + /** + */ + owner?: VoicemailOwnerResource; } export default GetMessageInfoResponse; diff --git a/packages/core/src/definitions/GetRecordingInsightsParameters.ts b/packages/core/src/definitions/GetRecordingInsightsParameters.ts new file mode 100644 index 000000000..8e1c9784c --- /dev/null +++ b/packages/core/src/definitions/GetRecordingInsightsParameters.ts @@ -0,0 +1,11 @@ +/** + * Query parameters for operation getRecordingInsights + */ +interface GetRecordingInsightsParameters { + /** + * AI Insight Types + */ + insightTypes?: ('NextSteps' | 'Transcript' | 'Summary' | 'Highlights' | 'BulletedSummary' | 'AIScore')[]; +} + +export default GetRecordingInsightsParameters; diff --git a/packages/core/src/definitions/GetTokenRequest.ts b/packages/core/src/definitions/GetTokenRequest.ts index f2e1e961c..e33a3dbd5 100644 --- a/packages/core/src/definitions/GetTokenRequest.ts +++ b/packages/core/src/definitions/GetTokenRequest.ts @@ -68,7 +68,7 @@ interface GetTokenRequest { /** * Refresh token lifetime in seconds - * Maximum: 604800 + * Maximum: 2592000 * Format: int32 * Default: 604800 */ diff --git a/packages/core/src/definitions/GroupResource.ts b/packages/core/src/definitions/GroupResource.ts deleted file mode 100644 index ce23dd7cf..000000000 --- a/packages/core/src/definitions/GroupResource.ts +++ /dev/null @@ -1,13 +0,0 @@ -interface GroupResource { - /** - * Example: 63723034 - */ - id?: string; - - /** - * Example: Leaders - */ - name?: string; -} - -export default GroupResource; diff --git a/packages/core/src/definitions/HighlightsInsightUnit.ts b/packages/core/src/definitions/HighlightsInsightUnit.ts new file mode 100644 index 000000000..35b3d534b --- /dev/null +++ b/packages/core/src/definitions/HighlightsInsightUnit.ts @@ -0,0 +1,33 @@ +interface HighlightsInsightUnit { + /** + * Participant ID + * Required + * Example: p-32423 + */ + speakerId?: string; + + /** + * Value of the insight + * Required + * Example: conversational insights text + */ + value?: string; + + /** + * Start time of the insight (in sec) + * Required + * Format: float + * Example: 1.2 + */ + start?: number; + + /** + * End time of the insight (in sec) + * Required + * Format: float + * Example: 4.2 + */ + end?: number; +} + +export default HighlightsInsightUnit; diff --git a/packages/core/src/definitions/IdentitiesList.ts b/packages/core/src/definitions/IdentitiesList.ts deleted file mode 100644 index 3b082f5ef..000000000 --- a/packages/core/src/definitions/IdentitiesList.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type IdentityModel from './IdentityModel'; -import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel'; - -interface IdentitiesList { - /** - * Required - */ - records?: IdentityModel[]; - - /** - * Required - */ - paging?: NonEnumeratedPagingModel; -} - -export default IdentitiesList; diff --git a/packages/core/src/definitions/IdentityExtraValues.ts b/packages/core/src/definitions/IdentityExtraValues.ts deleted file mode 100644 index 6f351ba57..000000000 --- a/packages/core/src/definitions/IdentityExtraValues.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** - * Additional data to store along with identity - */ -// eslint-disable-next-line @typescript-eslint/no-empty-interface -interface IdentityExtraValues {} - -export default IdentityExtraValues; diff --git a/packages/core/src/definitions/IdentityModel.ts b/packages/core/src/definitions/IdentityModel.ts deleted file mode 100644 index 582a9274b..000000000 --- a/packages/core/src/definitions/IdentityModel.ts +++ /dev/null @@ -1,248 +0,0 @@ -import type IdentityExtraValues from './IdentityExtraValues'; - -interface IdentityModel { - /** - * Identity identifier. - * Required - * Example: 506d9e817aa58d1259000f12 - */ - id?: string; - - /** - * Identity's avatar URI - * Format: uri - * Example: https://example.com/assets/avatar/default-79fd530c58c2a6b83a11fcc0e842ed7023ceb69292cfeb857bc2af2c624b90fd.png - */ - avatarUri?: string; - - /** - * Company. - * Example: Test Company - */ - company?: string; - - /** - * Creation time of the resource. - * Required - * Format: date-time - * Example: 2023-02-04T12:43:07Z - */ - creationTime?: string; - - /** - * Display name of identity - * Example: John Doe - */ - displayName?: string; - - /** - * Email address. - * Format: email - * Example: user@example.com - */ - emailAddress?: string; - - /** - */ - extraValues?: IdentityExtraValues; - - /** - * FirstName. - * Example: John - */ - firstName?: string; - - /** - * Gender. - * Example: Woman - */ - gender?: 'Man' | 'Woman'; - - /** - * Phone number. - * Example: +33634231224 - */ - homePhone?: string; - - /** - * Identity group identifier which references the identity group that contains - * all information (phone, notes, etc). Multiple identities may belong to - * a single group. If the parameter value is null, it means that identity - * does not belong to a group or have extra information - * Example: 54085e5b7aa58d8b5d00006c - */ - identityGroupId?: string; - - /** - * Either Agent or Customer - */ - identityType?: 'Agent' | 'Customer'; - - /** - * LastName. - * Example: Doe - */ - lastName?: string; - - /** - * Phone number. - * Example: +33634231224 - */ - mobilePhone?: string; - - /** - * Screen name of identity - * Example: John D. - */ - screenName?: string; - - /** - * Type of identity - * Required - */ - type?: - | 'AppleMessagesForBusiness' - | 'Email' - | 'EngageMessaging' - | 'Facebook' - | 'GoogleMyBusiness' - | 'Instagram' - | 'Linkedin' - | 'Twitter' - | 'Viber' - | 'WhatsApp' - | 'Youtube'; - - /** - * The time when the last modification was completed. - * Required - * Format: date-time - * Example: 2023-02-04T12:43:07Z - */ - lastModifiedTime?: string; - - /** - * List of the associated user identifiers who can use the identity - */ - userIds?: string[]; - - /** - * UUID of identity - * Example: 9680ab94-3b78-495c-bb2c-a969954d8260 - */ - uuid?: string; - - /** - * Device info of the identity. Applicable to RingCX Digital Messaging channels only - * Example: iPhone (iPhone); iOS 15.0.2 - */ - mobileDeviceInfo?: string; - - /** - * Facebook biography of the identity. Applicable to Facebook and Messenger channels only - * Example: Painter living in Paris - */ - fbBio?: string; - - /** - * Facebook category of the identity. Applicable to Facebook and Messenger channels only - * Example: Computers/Internet - */ - fbCategory?: string; - - /** - * Facebook locale of the identity. Applicable to Facebook and Messenger channels only - * Example: fr_FR - */ - fbLocale?: string; - - /** - * Instagram followers count of the identity. Applicable to Instagram and InstagramMessaging channels only - * Format: int32 - * Example: 10 - */ - igFollowersCount?: number; - - /** - * Twitter description of the identity. Applicable to Twitter channels only - * Example: Software Engineer - */ - twDescription?: string; - - /** - * Twitter followers count of the identity. Applicable to Twitter channels only - * Format: int32 - * Example: 10 - */ - twFollowersCount?: number; - - /** - * Count of Twitter accounts followed by the identity. Applicable to Twitter channels only - * Format: int32 - * Example: 500 - */ - twFollowingCount?: number; - - /** - * Count of tweets of the identity. Applicable to Twitter channels only - * Format: int32 - * Example: 42 - */ - twStatusesCount?: number; - - /** - * Twitter location of the identity. Applicable to Twitter channels only - * Example: Paris - */ - twLocation?: string; - - /** - * Viber API version of the identity. Applicable to Viber channels only - * Example: 10 - */ - apiVersion?: string; - - /** - * Viber country of the identity. Applicable to Viber channels only - * Example: FR - */ - country?: string; - - /** - * Viber device type of the identity. Applicable to Viber channels only - * Example: SM-G970U1 - */ - deviceType?: string; - - /** - * Viber language of the identity. Applicable to Viber channels only - * Example: fr-FR - */ - language?: string; - - /** - * Viber mobile country code of the identity. Applicable to Viber channels only - * Example: 1 - */ - mcc?: string; - - /** - * Viber mobile network code of the identity. Applicable to Viber channels only - * Example: 220 - */ - mnc?: string; - - /** - * Viber primary device OS of the identity. Applicable to Viber channels only - * Example: Android 11 - */ - primaryDeviceOs?: string; - - /** - * Viber application version of the identity. Applicable to Viber channels only - * Example: 19.5.0 - */ - viberVersion?: string; -} - -export default IdentityModel; diff --git a/packages/core/src/definitions/InternalDeliveryMode.ts b/packages/core/src/definitions/InternalDeliveryMode.ts new file mode 100644 index 000000000..69c99caaf --- /dev/null +++ b/packages/core/src/definitions/InternalDeliveryMode.ts @@ -0,0 +1,16 @@ +interface InternalDeliveryMode { + /** + * The transport type for this subscription, or the channel by which an app should be notified of an event + * Required + */ + transportType?: 'Internal'; + + /** + * The name of internal channel (defined in the backend service configuration) to deliver notifications through. + * Required + * Example: my-server-channel + */ + configName?: string; +} + +export default InternalDeliveryMode; diff --git a/packages/core/src/definitions/ListCallMonitoringGroupsParameters.ts b/packages/core/src/definitions/ListCallMonitoringGroupsParameters.ts index 433c13107..95fd24dbc 100644 --- a/packages/core/src/definitions/ListCallMonitoringGroupsParameters.ts +++ b/packages/core/src/definitions/ListCallMonitoringGroupsParameters.ts @@ -26,7 +26,7 @@ interface ListCallMonitoringGroupsParameters { /** * Internal identifier of a site */ - siteId?: string; + siteId?: string[]; } export default ListCallMonitoringGroupsParameters; diff --git a/packages/core/src/definitions/ListDirectoryEntriesParameters.ts b/packages/core/src/definitions/ListDirectoryEntriesParameters.ts index 3f88aceaf..45d9c9d25 100644 --- a/packages/core/src/definitions/ListDirectoryEntriesParameters.ts +++ b/packages/core/src/definitions/ListDirectoryEntriesParameters.ts @@ -3,8 +3,8 @@ */ interface ListDirectoryEntriesParameters { /** - * Flag to enable cross-site limitation checking - * Example: true + * Allows to make lookups across a whole directory skipping a filtering logic of Cross-Site access management feature. + * Default: true */ accessibleSitesOnly?: boolean; diff --git a/packages/core/src/definitions/ListExtensionDevicesParameters.ts b/packages/core/src/definitions/ListExtensionDevicesParameters.ts index 3ab621ca5..1e4f196d3 100644 --- a/packages/core/src/definitions/ListExtensionDevicesParameters.ts +++ b/packages/core/src/definitions/ListExtensionDevicesParameters.ts @@ -29,9 +29,9 @@ interface ListExtensionDevicesParameters { linePooling?: 'Host' | 'Guest' | 'None'; /** - * Device feature + * Device feature or multiple features supported */ - feature?: 'BLA' | 'CommonPhone' | 'Intercom' | 'Paging' | 'HELD'; + feature?: ('BLA' | 'CommonPhone' | 'Intercom' | 'Paging' | 'HELD')[]; /** * Device type diff --git a/packages/core/src/definitions/ListSocialMessagingContentsParameters.ts b/packages/core/src/definitions/ListSocialMessagingContentsParameters.ts deleted file mode 100644 index 12cbfce4e..000000000 --- a/packages/core/src/definitions/ListSocialMessagingContentsParameters.ts +++ /dev/null @@ -1,85 +0,0 @@ -/** - * Query parameters for operation listSocialMessagingContents - */ -interface ListSocialMessagingContentsParameters { - /** - * Filter based on the specified intervention identifiers - * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc - */ - interventionIds?: string[]; - - /** - * Filter based on the specified identity identifiers - * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc - */ - authorIdentityIds?: string[]; - - /** - * Filter based on the specified identity group identifiers - * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc - */ - authorIdentityGroupIds?: string[]; - - /** - * Filter based on the specified channel identifiers - * Example: 7f946431b6eebffafae642cc - */ - channelIds?: string[]; - - /** - * Direction of the content. - * - * * Incoming contents are received from a channel. - * * Outgoing contents are exported to a channel. - * Example: Incoming - */ - contentDirection?: 'Incoming' | 'Outgoing'; - - /** - * Filter based on the specified thread identifiers - * Example: 7f946431b6eebffafae642cc - */ - threadIds?: string[]; - - /** - * Filter based on the specified text(s). Provided multiple times, the values are ANDed - */ - text?: string[]; - - /** - * Filter for specified status - */ - status?: ('New' | 'Assigned' | 'Replied' | 'UserReply' | 'UserInitiated' | 'Ignored')[]; - - /** - * Ordering by creationTime and lastModifiedTime is descending by default. - * Example: +creationTime - * Default: -creationTime - */ - orderBy?: - | '-creationTime' - | '+creationTime' - | 'creationTime' - | '-lastModifiedTime' - | '+lastModifiedTime' - | 'lastModifiedTime'; - - /** - * The token indicating the particular page of the result set to be retrieved. - * If omitted the first page will be returned. - */ - pageToken?: string; - - /** - * The number of items per page. If provided value in the request - * is greater than a maximum, the maximum value is applied - * Maximum: 1000 - * Minimum: 1 - * Format: int32 - * Example: 100 - * Default: 100 - */ - perPage?: number; -} - -export default ListSocialMessagingContentsParameters; diff --git a/packages/core/src/definitions/ListSocialMessagingIdentitiesParameters.ts b/packages/core/src/definitions/ListSocialMessagingIdentitiesParameters.ts deleted file mode 100644 index 5507a60fc..000000000 --- a/packages/core/src/definitions/ListSocialMessagingIdentitiesParameters.ts +++ /dev/null @@ -1,61 +0,0 @@ -/** - * Query parameters for operation listSocialMessagingIdentities - */ -interface ListSocialMessagingIdentitiesParameters { - /** - * Filter based on the specified channelId. - */ - channelId?: string; - - /** - * Filter based on the specified `identityGroupIds` (separated by commas) - */ - identityGroupIds?: string[]; - - /** - * Either Agent or Customer - */ - identityType?: 'Agent' | 'Customer'; - - /** - * Filter based on the specified `userId` - */ - userId?: string; - - /** - * Filter based on the specified `uuid` - */ - uuid?: string; - - /** - * Ordering by creationTime and lastModifiedTime is descending by default. - * Example: +creationTime - * Default: -creationTime - */ - orderBy?: - | '-creationTime' - | '+creationTime' - | 'creationTime' - | '-lastModifiedTime' - | '+lastModifiedTime' - | 'lastModifiedTime'; - - /** - * The token indicating the particular page of the result set to be retrieved. - * If omitted the first page will be returned. - */ - pageToken?: string; - - /** - * The number of items per page. If provided value in the request - * is greater than a maximum, the maximum value is applied - * Maximum: 1000 - * Minimum: 1 - * Format: int32 - * Example: 100 - * Default: 100 - */ - perPage?: number; -} - -export default ListSocialMessagingIdentitiesParameters; diff --git a/packages/core/src/definitions/ListUserTemplatesParameters.ts b/packages/core/src/definitions/ListUserTemplatesParameters.ts index 3c7b50d9c..92ca35c0e 100644 --- a/packages/core/src/definitions/ListUserTemplatesParameters.ts +++ b/packages/core/src/definitions/ListUserTemplatesParameters.ts @@ -5,7 +5,7 @@ interface ListUserTemplatesParameters { /** * Type of template */ - type?: 'UserSettings' | 'CallHandling'; + type?: 'UserSettings' | 'CallHandling' | 'LimitedExtensions'; /** * Indicates a page number to retrieve. Only positive number values diff --git a/packages/core/src/definitions/NextStepsInsightUnit.ts b/packages/core/src/definitions/NextStepsInsightUnit.ts new file mode 100644 index 000000000..95ecb4b8b --- /dev/null +++ b/packages/core/src/definitions/NextStepsInsightUnit.ts @@ -0,0 +1,33 @@ +interface NextStepsInsightUnit { + /** + * Participant ID + * Required + * Example: p-32423 + */ + speakerId?: string; + + /** + * Value of the insight + * Required + * Example: conversational insights text + */ + value?: string; + + /** + * Start time of the insight (in sec) + * Required + * Format: float + * Example: 1.2 + */ + start?: number; + + /** + * End time of the insight (in sec) + * Required + * Format: float + * Example: 4.2 + */ + end?: number; +} + +export default NextStepsInsightUnit; diff --git a/packages/core/src/definitions/NotificationDeliveryMode.ts b/packages/core/src/definitions/NotificationDeliveryMode.ts index 8814c75b1..b1113575f 100644 --- a/packages/core/src/definitions/NotificationDeliveryMode.ts +++ b/packages/core/src/definitions/NotificationDeliveryMode.ts @@ -6,7 +6,7 @@ interface NotificationDeliveryMode { * The transport type for this subscription, or the channel by which an app should be notified of an event * Required */ - transportType?: 'WebHook' | 'RC/APNS' | 'RC/GCM' | 'PubNub' | 'WebSocket'; + transportType?: 'WebHook' | 'RC/APNS' | 'RC/GCM' | 'PubNub' | 'WebSocket' | 'Internal'; /** * PubNub channel name @@ -60,6 +60,13 @@ interface NotificationDeliveryMode { * Cryptographic key to decrypt PubNub notification messages */ encryptionKey?: string; + + /** + * The name of internal channel (defined in the backend service configuration) to deliver notifications through. + * Required + * Example: my-server-channel + */ + configName?: string; } export default NotificationDeliveryMode; diff --git a/packages/core/src/definitions/PartySuperviseResponse.ts b/packages/core/src/definitions/PartySuperviseResponse.ts index d53341397..5b5e0eb7c 100644 --- a/packages/core/src/definitions/PartySuperviseResponse.ts +++ b/packages/core/src/definitions/PartySuperviseResponse.ts @@ -41,7 +41,9 @@ interface PartySuperviseResponse { owner?: OwnerInfo; /** - * Specifies if a device is stand-alone + * If `true` then the party is not connected to a session voice + * conference, `false` means the party is connected to other parties in a + * session */ standAlone?: boolean; diff --git a/packages/core/src/definitions/PeerInfo.ts b/packages/core/src/definitions/PeerInfo.ts index 3375d5980..a82df81f3 100644 --- a/packages/core/src/definitions/PeerInfo.ts +++ b/packages/core/src/definitions/PeerInfo.ts @@ -1,5 +1,5 @@ /** - * Peer session/party details. Valid in 'Gone' state of a call + * Peer (linked) session/party details. Valid in 'Gone' state of a call */ interface PeerInfo { /** diff --git a/packages/core/src/definitions/RSConversationalInsightsUnit.ts b/packages/core/src/definitions/RSConversationalInsightsUnit.ts new file mode 100644 index 000000000..69e032b4f --- /dev/null +++ b/packages/core/src/definitions/RSConversationalInsightsUnit.ts @@ -0,0 +1,33 @@ +interface RSConversationalInsightsUnit { + /** + * Participant ID + * Required + * Example: p-32423 + */ + speakerId?: string; + + /** + * Value of the insight + * Required + * Example: conversational insights text + */ + value?: string; + + /** + * Start time of the insight (in sec) + * Required + * Format: float + * Example: 1.2 + */ + start?: number; + + /** + * End time of the insight (in sec) + * Required + * Format: float + * Example: 4.2 + */ + end?: number; +} + +export default RSConversationalInsightsUnit; diff --git a/packages/core/src/definitions/ReadDirectoryEntryParameters.ts b/packages/core/src/definitions/ReadDirectoryEntryParameters.ts index ed4ecad99..8f2403267 100644 --- a/packages/core/src/definitions/ReadDirectoryEntryParameters.ts +++ b/packages/core/src/definitions/ReadDirectoryEntryParameters.ts @@ -3,8 +3,8 @@ */ interface ReadDirectoryEntryParameters { /** - * Flag to enable cross-site limitation checking - * Example: true + * Allows to make lookups across a whole directory skipping a filtering logic of Cross-Site access management feature. + * Default: true */ accessibleSitesOnly?: boolean; } diff --git a/packages/core/src/definitions/ReadMultichannelCallRecordingContentParameters.ts b/packages/core/src/definitions/ReadMultichannelCallRecordingContentParameters.ts new file mode 100644 index 000000000..1932ba934 --- /dev/null +++ b/packages/core/src/definitions/ReadMultichannelCallRecordingContentParameters.ts @@ -0,0 +1,16 @@ +/** + * Query parameters for operation readMultichannelCallRecordingContent + */ +interface ReadMultichannelCallRecordingContentParameters { + /** + * Whether the content is expected to be displayed in the browser, or downloaded and saved locally + */ + contentDisposition?: 'Inline' | 'Attachment'; + + /** + * The default filename of the file to be downloaded + */ + contentDispositionFilename?: string; +} + +export default ReadMultichannelCallRecordingContentParameters; diff --git a/packages/core/src/definitions/RecordingInsights.ts b/packages/core/src/definitions/RecordingInsights.ts new file mode 100644 index 000000000..3a2f286f0 --- /dev/null +++ b/packages/core/src/definitions/RecordingInsights.ts @@ -0,0 +1,92 @@ +import type AIInsights from './AIInsights'; + +interface RecordingInsights { + /** + * Title of the call + * Required + * Example: Call from 1234567890 to 0987654321 + */ + title?: string; + + /** + * URI of the call recording + * Example: https://ringsense.ringcentral.com/calls/2e67979e-ff82-4171-ae30-20c0c1f19b27 + */ + rsRecordUri?: string; + + /** + * Source rc application of the recording + * Required + * Example: pbx + */ + domain?: 'pbx'; + + /** + * Recording ID of the domain + * Required + * Example: 4b57_384543 + */ + sourceRecordId?: string; + + /** + * Session ID of the domain + * Required + * Example: cbac2b78-6f74-4257-8167-dff864de2263!us-10-dca09@us-10 + */ + sourceSessionId?: string; + + /** + * Optional call direction in case of phone call recording + * Example: Inbound + */ + callDirection?: 'Inbound' | 'Outbound'; + + /** + * Extension id of the call recording owner + * Required + * Example: 123456789 + */ + ownerExtensionId?: string; + + /** + * Duration of the call recording (in ms) + * Required + * Format: int32 + * Example: 112000 + */ + recordingDurationMs?: number; + + /** + * Start time of the call recording + * Required + * Format: date-time + */ + recordingStartTime?: string; + + /** + * Creation time of the call insights + * Required + * Format: date-time + */ + creationTime?: string; + + /** + * Last modified time of the call insights + * Required + * Format: date-time + */ + lastModifiedTime?: string; + + /** + * List of the participants in the call + * Required + */ + speakerInfo?: object[]; + + /** + * Required + */ + insights?: AIInsights; +} + +export default RecordingInsights; diff --git a/packages/core/src/definitions/ScimUserSearchResponse.ts b/packages/core/src/definitions/ScimUserSearchResponse.ts index f9ccac93e..fae47993e 100644 --- a/packages/core/src/definitions/ScimUserSearchResponse.ts +++ b/packages/core/src/definitions/ScimUserSearchResponse.ts @@ -1,10 +1,10 @@ -import type ScimUserResponse from './ScimUserResponse'; +import type ScimUserShortInfo from './ScimUserShortInfo'; interface ScimUserSearchResponse { /** * User list */ - Resources?: ScimUserResponse[]; + Resources?: ScimUserShortInfo[]; /** * Format: int64 diff --git a/packages/core/src/definitions/ScimUserShortInfo.ts b/packages/core/src/definitions/ScimUserShortInfo.ts new file mode 100644 index 000000000..c92a7f68b --- /dev/null +++ b/packages/core/src/definitions/ScimUserShortInfo.ts @@ -0,0 +1,62 @@ +import type ScimEmail from './ScimEmail'; +import type ScimName from './ScimName'; +import type ScimPhoto from './ScimPhoto'; +import type ScimEnterpriseUser from './ScimEnterpriseUser'; +import type ScimMeta from './ScimMeta'; + +interface ScimUserShortInfo { + /** + * User status + */ + active?: boolean; + + /** + * Required + */ + emails?: ScimEmail[]; + + /** + * External unique resource ID defined by provisioning client + */ + externalId?: string; + + /** + * Unique resource ID defined by RingCentral + */ + id?: string; + + /** + * Required + */ + name?: ScimName; + + /** + */ + photos?: ScimPhoto[]; + + /** + * Required + */ + schemas?: 'urn:ietf:params:scim:schemas:core:2.0:User'[]; + + /** + * User title + */ + title?: string; + + /** + */ + 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'?: ScimEnterpriseUser; + + /** + * MUST be same as work type email address + * Required + */ + userName?: string; + + /** + */ + meta?: ScimMeta; +} + +export default ScimUserShortInfo; diff --git a/packages/core/src/definitions/SearchDirectoryEntriesParameters.ts b/packages/core/src/definitions/SearchDirectoryEntriesParameters.ts index 4d2df20d9..6c7266857 100644 --- a/packages/core/src/definitions/SearchDirectoryEntriesParameters.ts +++ b/packages/core/src/definitions/SearchDirectoryEntriesParameters.ts @@ -3,8 +3,8 @@ */ interface SearchDirectoryEntriesParameters { /** - * Flag to enable cross-site limitation checking - * Example: true + * Allows to make lookups across a whole directory skipping a filtering logic of Cross-Site access management feature. + * Default: true */ accessibleSitesOnly?: boolean; diff --git a/packages/core/src/definitions/ServiceInfoPlan.ts b/packages/core/src/definitions/ServiceInfoPlanV2.ts similarity index 59% rename from packages/core/src/definitions/ServiceInfoPlan.ts rename to packages/core/src/definitions/ServiceInfoPlanV2.ts index fb28b0cc1..46986aaac 100644 --- a/packages/core/src/definitions/ServiceInfoPlan.ts +++ b/packages/core/src/definitions/ServiceInfoPlanV2.ts @@ -1,7 +1,7 @@ /** * Information on account service plan */ -interface ServiceInfoPlan { +interface ServiceInfoPlanV2 { /** * Internal identifier of a service plan */ @@ -11,10 +11,6 @@ interface ServiceInfoPlan { * Name of a service plan */ name?: string; - - /** - */ - freemiumProductType?: 'Freyja' | 'Phoenix'; } -export default ServiceInfoPlan; +export default ServiceInfoPlanV2; diff --git a/packages/core/src/definitions/ServiceInfoV2.ts b/packages/core/src/definitions/ServiceInfoV2.ts index a55ae1384..2c1c2652e 100644 --- a/packages/core/src/definitions/ServiceInfoV2.ts +++ b/packages/core/src/definitions/ServiceInfoV2.ts @@ -2,7 +2,7 @@ import type ServiceInfoPackage from './ServiceInfoPackage'; import type ServiceInfoBrand from './ServiceInfoBrand'; import type ServiceInfoContractedCountryId from './ServiceInfoContractedCountryId'; import type ServiceInfoUBrand from './ServiceInfoUBrand'; -import type ServiceInfoPlan from './ServiceInfoPlan'; +import type ServiceInfoPlanV2 from './ServiceInfoPlanV2'; /** * Service Plan information (billing package, brand, etc.) @@ -31,7 +31,7 @@ interface ServiceInfoV2 { /** */ - servicePlan?: ServiceInfoPlan; + servicePlan?: ServiceInfoPlanV2; } export default ServiceInfoV2; diff --git a/packages/core/src/definitions/ShippingInfo.ts b/packages/core/src/definitions/ShippingInfo.ts index 584ab0fa8..8e5626aef 100644 --- a/packages/core/src/definitions/ShippingInfo.ts +++ b/packages/core/src/definitions/ShippingInfo.ts @@ -14,7 +14,7 @@ interface ShippingInfo { * Finally, it is changed to `Shipped` which means that the distributor has shipped the device. * Example: Shipped */ - status?: 'Initial' | 'Accepted' | 'Shipped'; + status?: 'Initial' | 'Accepted' | 'Shipped' | "Won't ship"; /** * Shipping carrier name. Appears only if the device status is 'Shipped' diff --git a/packages/core/src/definitions/SipData.ts b/packages/core/src/definitions/SipData.ts new file mode 100644 index 000000000..d6a78c4da --- /dev/null +++ b/packages/core/src/definitions/SipData.ts @@ -0,0 +1,23 @@ +/** + * SIP (Session Initiation Protocol) information. + * Returned if query parameter sipData is set to 'True' + * + */ +interface SipData { + /** + * Recipient's data + */ + toTag?: string; + + /** + * Sender's data + */ + fromTag?: string; + + /** + * SIP call identifier + */ + callId?: string; +} + +export default SipData; diff --git a/packages/core/src/definitions/SocMsgContentAttachment.ts b/packages/core/src/definitions/SocMsgContentAttachment.ts deleted file mode 100644 index 5f63e3450..000000000 --- a/packages/core/src/definitions/SocMsgContentAttachment.ts +++ /dev/null @@ -1,86 +0,0 @@ -interface SocMsgContentAttachment { - /** - * Type of attachment, which is generally a MIME attachment type like `image/jpeg`, etc. - * Security level in RingCX determines what type of attachment is allowed. - * Based on the security level the following attachment types are supported. - * - * *'Strict'* level allows safe extensions below: - * Content name and supported types: - * - * - audio (AAC, MP3, OGG, M4A) - * - image (BMP, GIF, JPG, JPEG, PNG, SVG, WEBP) - * - pdf (PDF) - * - text (CSV, TXT, LOG) - * - video (AVI, FLV, M4V, MKV, MOV, MP4, MPG, QT, WMV) - * - other (AMR, DMS, VCARD, TIF, TIFF, MPEG) - * - * *'Relaxed'* level allows documents: - * Content name and supported types: - * - * - excel (XLS, XLSM, XLSX, XLC, XLT, XLTM, XLTX) - * - presentation (KEY, ODP, OTP) - * - powerpoint (PPS, PPT, PPTX, POT) - * - spreadsheet (Numbers - ODS, OTS) - * - word (DOC, DOCM, DOCX, DOTM, DOTX) - * - word_processing (Pages - ODT, OTT, RTF) - * - * *'Permissive'* level allows all documents. - * - * However, there are no security level restrictions for content posted through the channel - * Example: image/jpeg - */ - contentType?: string; - - /** - * Creation time of the resource. - * Format: date-time - * Example: 2023-02-04T12:43:07Z - */ - creationTime?: string; - - /** - * Specifies if attachment is embedded in content - */ - embedded?: boolean; - - /** - * Filename of attachment - * Example: 0.jpeg - */ - filename?: string; - - /** - * Identifier of the attachment. - * Example: 54085e5b7aa58d8b5d00006c - */ - id?: string; - - /** - * Attachment privacy setting - * Default: true - */ - public?: boolean; - - /** - * Size of attachment - * Format: int32 - * Example: 217571 - */ - size?: number; - - /** - * The time when the last modification was completed. - * Format: date-time - * Example: 2023-02-04T12:43:07Z - */ - lastModifiedTime?: string; - - /** - * Attachment URI - * Format: uri - * Example: https://example.digital.ringcentral.com/files/attachments/54085e5b7aa58d8b5d00006c - */ - uri?: string; -} - -export default SocMsgContentAttachment; diff --git a/packages/core/src/definitions/SummaryInsightUnit.ts b/packages/core/src/definitions/SummaryInsightUnit.ts new file mode 100644 index 000000000..bf9f68f03 --- /dev/null +++ b/packages/core/src/definitions/SummaryInsightUnit.ts @@ -0,0 +1,26 @@ +interface SummaryInsightUnit { + /** + * Value of the summary + * Required + * Example: conversational insights text + */ + value?: string; + + /** + * Start time of the insight (in sec) + * Required + * Format: float + * Example: 1.2 + */ + start?: number; + + /** + * End time of the insight (in sec) + * Required + * Format: float + * Example: 4.2 + */ + end?: number; +} + +export default SummaryInsightUnit; diff --git a/packages/core/src/definitions/SyncAccountCallLogParameters.ts b/packages/core/src/definitions/SyncAccountCallLogParameters.ts index fcca3f488..9c8135f3e 100644 --- a/packages/core/src/definitions/SyncAccountCallLogParameters.ts +++ b/packages/core/src/definitions/SyncAccountCallLogParameters.ts @@ -14,7 +14,10 @@ interface SyncAccountCallLogParameters { syncToken?: string; /** - * The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment + * Starting date for the resulting records in ISO 8601 format, including + * timezone, for example *2016-03-10T18:07:52.534Z*. The range is limited to the last 30 days from the current moment. + * If not specified, the default value is a log history date (date of account creation/call log deletion), and + * no time range limitation applied * Format: date-time */ dateFrom?: string; diff --git a/packages/core/src/definitions/SyncMessagesParameters.ts b/packages/core/src/definitions/SyncMessagesParameters.ts index 95b125ed4..260791739 100644 --- a/packages/core/src/definitions/SyncMessagesParameters.ts +++ b/packages/core/src/definitions/SyncMessagesParameters.ts @@ -63,9 +63,9 @@ interface SyncMessagesParameters { syncType?: 'FSync' | 'ISync'; /** - * This query parameter will filter voicemail messages based on its owner. - * This parameter should be controlled by the 'SharedVoicemail' feature. - * If the feature is disabled this filter shouldn't be applied. + * Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail' + * feature is enabled. + * Default: Personal */ voicemailOwner?: string[]; } diff --git a/packages/core/src/definitions/SyncUserCallLogParameters.ts b/packages/core/src/definitions/SyncUserCallLogParameters.ts index d50a7aac9..c21e0eb5f 100644 --- a/packages/core/src/definitions/SyncUserCallLogParameters.ts +++ b/packages/core/src/definitions/SyncUserCallLogParameters.ts @@ -14,9 +14,10 @@ interface SyncUserCallLogParameters { syncToken?: string; /** - * The start datetime for resulting records in ISO 8601 format including - * timezone, for example 2016-03-10T18:07:52.534Z. The default value is the - * current moment + * Starting date for the resulting records in ISO 8601 format, including + * timezone, for example *2016-03-10T18:07:52.534Z*. The range is limited to the last 30 days from the current moment. + * If not specified, the default value is a log history date (date of account creation/call log deletion), and + * no time range limitation applied * Format: date-time */ dateFrom?: string; diff --git a/packages/core/src/definitions/TMMessageAttachmentInfo.ts b/packages/core/src/definitions/TMMessageAttachmentInfo.ts index 740a1ca2a..cf58c9be5 100644 --- a/packages/core/src/definitions/TMMessageAttachmentInfo.ts +++ b/packages/core/src/definitions/TMMessageAttachmentInfo.ts @@ -15,6 +15,17 @@ interface TMMessageAttachmentInfo { */ type?: 'Card' | 'Event' | 'File' | 'Note' | 'Task'; + /** + * Link to a binary content + * Format: uri + */ + contentUri?: string; + + /** + * Name of a file + */ + name?: string; + /** * A string of default text that will be rendered in the case that the client does not support Interactive Messages */ diff --git a/packages/core/src/definitions/TelephonySessionsEventPartyInfo.ts b/packages/core/src/definitions/TelephonySessionsEventPartyInfo.ts index ddedec495..eaa6aceaf 100644 --- a/packages/core/src/definitions/TelephonySessionsEventPartyInfo.ts +++ b/packages/core/src/definitions/TelephonySessionsEventPartyInfo.ts @@ -1,20 +1,28 @@ import type CallPartyInfo from './CallPartyInfo'; -import type CallSessionStatusInfo from './CallSessionStatusInfo'; +import type RecordingInfo from './RecordingInfo'; +import type CallStatusInfo from './CallStatusInfo'; +import type ParkInfo from './ParkInfo'; +import type SipData from './SipData'; +import type UiCallInfo from './UiCallInfo'; interface TelephonySessionsEventPartyInfo { /** + * Internal identifier of an account */ accountId?: string; /** + * Internal identifier of an extension */ extensionId?: string; /** + * Internal identifier of a party */ id?: string; /** + * Call direction */ direction?: 'Inbound' | 'Outbound'; @@ -28,7 +36,54 @@ interface TelephonySessionsEventPartyInfo { /** */ - status?: CallSessionStatusInfo; + recordings?: RecordingInfo[]; + + /** + */ + status?: CallStatusInfo; + + /** + */ + park?: ParkInfo; + + /** + * Specifies if it's a queue call + */ + queueCall?: boolean; + + /** + * Specifies if a call was missed by the party + */ + missedCall?: boolean; + + /** + * If `true` then the party is not connected to a session voice + * conference, `false` means the party is connected to other parties in a + * session + */ + standAlone?: boolean; + + /** + * Specifies if a call participant is muted or not. **Note:** + * If a call is also controlled via Hard phone or RingCentral App (not only + * through the API by calling call control methods) then it cannot be fully + * muted/unmuted via API only, in this case the action should be duplicated + * via Hard phone/RC App interfaces + */ + muted?: boolean; + + /** + * Defines party role in Server Side Conference + */ + conferenceRole?: 'Host' | 'Participant'; + + /** + */ + sipData?: SipData; + + /** + */ + uiCallInfo?: UiCallInfo; } export default TelephonySessionsEventPartyInfo; diff --git a/packages/core/src/definitions/TemplateInfo.ts b/packages/core/src/definitions/TemplateInfo.ts index 18d5f07df..50b0fbf95 100644 --- a/packages/core/src/definitions/TemplateInfo.ts +++ b/packages/core/src/definitions/TemplateInfo.ts @@ -11,8 +11,13 @@ interface TemplateInfo { id?: string; /** + * Description of a template */ - type?: 'UserSettings' | 'CallHandling'; + description?: string; + + /** + */ + type?: 'UserSettings' | 'CallHandling' | 'LimitedExtensions'; /** * Name of a template diff --git a/packages/core/src/definitions/TranscriptInsightUnit.ts b/packages/core/src/definitions/TranscriptInsightUnit.ts new file mode 100644 index 000000000..689bc1313 --- /dev/null +++ b/packages/core/src/definitions/TranscriptInsightUnit.ts @@ -0,0 +1,36 @@ +/** + * One utterance of a call. Each utterance is a speakerId, text, start and end time + */ +interface TranscriptInsightUnit { + /** + * Participant ID + * Required + * Example: p-32423 + */ + speakerId?: string; + + /** + * Text of the utterance + * Required + * Example: Hello user! + */ + text?: string; + + /** + * Start time of the utterance (in sec) + * Required + * Format: float + * Example: 1.2 + */ + start?: number; + + /** + * End time of the utterance (in sec) + * Required + * Format: float + * Example: 4.2 + */ + end?: number; +} + +export default TranscriptInsightUnit; diff --git a/packages/core/src/definitions/TransitionInfo.ts b/packages/core/src/definitions/TransitionInfo.ts new file mode 100644 index 000000000..bf1b6953c --- /dev/null +++ b/packages/core/src/definitions/TransitionInfo.ts @@ -0,0 +1,16 @@ +import type ExtensionRegionalSettingRequest from './ExtensionRegionalSettingRequest'; + +interface TransitionInfo { + /** + * Specifies if a welcome/activation email is sent to the new users + * (with the extension status transition from 'Unassigned' to 'NotActivated/Disabled') + * Default: true + */ + sendWelcomeEmail?: boolean; + + /** + */ + regionalSettings?: ExtensionRegionalSettingRequest; +} + +export default TransitionInfo; diff --git a/packages/core/src/definitions/UiCallInfo.ts b/packages/core/src/definitions/UiCallInfo.ts new file mode 100644 index 000000000..2a7539300 --- /dev/null +++ b/packages/core/src/definitions/UiCallInfo.ts @@ -0,0 +1,16 @@ +import type UiCallInfoRecord from './UiCallInfoRecord'; + +/** + * Call information on user interface + */ +interface UiCallInfo { + /** + */ + primary?: UiCallInfoRecord; + + /** + */ + additional?: UiCallInfoRecord; +} + +export default UiCallInfo; diff --git a/packages/core/src/definitions/UiCallInfoRecord.ts b/packages/core/src/definitions/UiCallInfoRecord.ts new file mode 100644 index 000000000..9c9e14ee1 --- /dev/null +++ b/packages/core/src/definitions/UiCallInfoRecord.ts @@ -0,0 +1,14 @@ +interface UiCallInfoRecord { + /** + * UI call info type + */ + type?: 'QueueName' | 'CallerIdName'; + + /** + * UI call info value + * Example: John Doe + */ + value?: string; +} + +export default UiCallInfoRecord; diff --git a/packages/core/src/definitions/VoicemailOwnerResource.ts b/packages/core/src/definitions/VoicemailOwnerResource.ts new file mode 100644 index 000000000..70c11fec7 --- /dev/null +++ b/packages/core/src/definitions/VoicemailOwnerResource.ts @@ -0,0 +1,16 @@ +/** + * Voicemail owner information. Supported for shared voicemail messages only + */ +interface VoicemailOwnerResource { + /** + * Name of a voicemail owner + */ + name?: string; + + /** + * Internal identifier of an extension + */ + extensionId?: string; +} + +export default VoicemailOwnerResource; diff --git a/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/Insights/index.ts b/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/Insights/index.ts new file mode 100644 index 000000000..5494c0cc3 --- /dev/null +++ b/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/Insights/index.ts @@ -0,0 +1,31 @@ +import type RecordingInsights from '../../../../../../../../../definitions/RecordingInsights'; +import type GetRecordingInsightsParameters from '../../../../../../../../../definitions/GetRecordingInsightsParameters'; +import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../../../../types'; + +class Index { + public rc: RingCentralInterface; + public _parent: ParentInterface; + + public constructor(_parent: ParentInterface) { + this._parent = _parent; + this.rc = _parent.rc; + } + public path(): string { + return `${this._parent.path()}/insights`; + } + /** + * Returns the insights of a call recording + * HTTP Method: get + * Endpoint: /ai/ringsense/v1/public/accounts/{accountId}/domains/{domain}/records/{sourceRecordId}/insights + * Rate Limit Group: Light + * App Permission: RingSense + */ + public async get( + queryParams?: GetRecordingInsightsParameters, + restRequestConfig?: RestRequestConfig, + ): Promise { + const r = await this.rc.get(this.path(), queryParams, restRequestConfig); + return r.data; + } +} +export default Index; diff --git a/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/index.ts b/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/index.ts new file mode 100644 index 000000000..9c553b8e3 --- /dev/null +++ b/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/index.ts @@ -0,0 +1,25 @@ +import Insights from './Insights'; +import type { RingCentralInterface, ParentInterface } from '../../../../../../../../types'; + +class Index { + public rc: RingCentralInterface; + public _parent: ParentInterface; + public sourceRecordId: string | null; + + public constructor(_parent: ParentInterface, sourceRecordId: string | null = null) { + this._parent = _parent; + this.rc = _parent.rc; + this.sourceRecordId = sourceRecordId; + } + public path(withParameter = true): string { + if (withParameter && this.sourceRecordId !== null) { + return `${this._parent.path()}/records/${this.sourceRecordId}`; + } + return `${this._parent.path()}/records`; + } + + public insights(): Insights { + return new Insights(this); + } +} +export default Index; diff --git a/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.ts b/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.ts new file mode 100644 index 000000000..9521cd69c --- /dev/null +++ b/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.ts @@ -0,0 +1,25 @@ +import Records from './Records'; +import type { RingCentralInterface, ParentInterface } from '../../../../../../../types'; + +class Index { + public rc: RingCentralInterface; + public _parent: ParentInterface; + public domain: string | null; + + public constructor(_parent: ParentInterface, domain: string | null = null) { + this._parent = _parent; + this.rc = _parent.rc; + this.domain = domain; + } + public path(withParameter = true): string { + if (withParameter && this.domain !== null) { + return `${this._parent.path()}/domains/${this.domain}`; + } + return `${this._parent.path()}/domains`; + } + + public records(sourceRecordId: string | null = null): Records { + return new Records(this, sourceRecordId); + } +} +export default Index; diff --git a/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/index.ts b/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/index.ts new file mode 100644 index 000000000..cec105bcf --- /dev/null +++ b/packages/core/src/paths/Ai/Ringsense/V1/Public/Accounts/index.ts @@ -0,0 +1,25 @@ +import Domains from './Domains'; +import type { RingCentralInterface, ParentInterface } from '../../../../../../types'; + +class Index { + public rc: RingCentralInterface; + public _parent: ParentInterface; + public accountId: string | null; + + public constructor(_parent: ParentInterface, accountId: string | null = null) { + this._parent = _parent; + this.rc = _parent.rc; + this.accountId = accountId; + } + public path(withParameter = true): string { + if (withParameter && this.accountId !== null) { + return `${this._parent.path()}/accounts/${this.accountId}`; + } + return `${this._parent.path()}/accounts`; + } + + public domains(domain: string | null = null): Domains { + return new Domains(this, domain); + } +} +export default Index; diff --git a/packages/core/src/paths/Ai/Ringsense/V1/Public/index.ts b/packages/core/src/paths/Ai/Ringsense/V1/Public/index.ts new file mode 100644 index 000000000..b265a4064 --- /dev/null +++ b/packages/core/src/paths/Ai/Ringsense/V1/Public/index.ts @@ -0,0 +1,20 @@ +import Accounts from './Accounts'; +import type { RingCentralInterface, ParentInterface } from '../../../../../types'; + +class Index { + public rc: RingCentralInterface; + public _parent: ParentInterface; + + public constructor(_parent: ParentInterface) { + this._parent = _parent; + this.rc = _parent.rc; + } + public path(): string { + return `${this._parent.path(false)}/public`; + } + + public accounts(accountId: string | null = null): Accounts { + return new Accounts(this, accountId); + } +} +export default Index; diff --git a/packages/core/src/paths/Cx/SocialMessaging/V1/index.ts b/packages/core/src/paths/Ai/Ringsense/V1/index.ts similarity index 55% rename from packages/core/src/paths/Cx/SocialMessaging/V1/index.ts rename to packages/core/src/paths/Ai/Ringsense/V1/index.ts index a4c4e9836..0176dc293 100644 --- a/packages/core/src/paths/Cx/SocialMessaging/V1/index.ts +++ b/packages/core/src/paths/Ai/Ringsense/V1/index.ts @@ -1,5 +1,4 @@ -import Identities from './Identities'; -import Contents from './Contents'; +import Public from './Public'; import type { RingCentralInterface, ParentInterface } from '../../../../types'; class Index { @@ -14,12 +13,8 @@ class Index { return `${this._parent.path(false)}/v1`; } - public contents(contentId: string | null = null): Contents { - return new Contents(this, contentId); - } - - public identities(identityId: string | null = null): Identities { - return new Identities(this, identityId); + public public(): Public { + return new Public(this); } } export default Index; diff --git a/packages/core/src/paths/Cx/SocialMessaging/index.ts b/packages/core/src/paths/Ai/Ringsense/index.ts similarity index 87% rename from packages/core/src/paths/Cx/SocialMessaging/index.ts rename to packages/core/src/paths/Ai/Ringsense/index.ts index dd6a90111..3d22147b3 100644 --- a/packages/core/src/paths/Cx/SocialMessaging/index.ts +++ b/packages/core/src/paths/Ai/Ringsense/index.ts @@ -10,7 +10,7 @@ class Index { this.rc = _parent.rc; } public path(): string { - return `${this._parent.path(false)}/social-messaging`; + return `${this._parent.path(false)}/ringsense`; } public v1(): V1 { diff --git a/packages/core/src/paths/Ai/index.ts b/packages/core/src/paths/Ai/index.ts index 8a401f08b..67a26efbd 100644 --- a/packages/core/src/paths/Ai/index.ts +++ b/packages/core/src/paths/Ai/index.ts @@ -1,3 +1,4 @@ +import Ringsense from './Ringsense'; import Insights from './Insights'; import Status from './Status'; import Audio from './Audio'; @@ -29,5 +30,9 @@ class Index { public insights(): Insights { return new Insights(this); } + + public ringsense(): Ringsense { + return new Ringsense(this); + } } export default Index; diff --git a/packages/core/src/paths/Cx/SocialMessaging/V1/Contents/index.ts b/packages/core/src/paths/Cx/SocialMessaging/V1/Contents/index.ts deleted file mode 100644 index f43a987a2..000000000 --- a/packages/core/src/paths/Cx/SocialMessaging/V1/Contents/index.ts +++ /dev/null @@ -1,101 +0,0 @@ -import type CreateSocialMessagingContentRequest from '../../../../../definitions/CreateSocialMessagingContentRequest'; -import type ListSocialMessagingContentsParameters from '../../../../../definitions/ListSocialMessagingContentsParameters'; -import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types'; - -class Index { - public rc: RingCentralInterface; - public _parent: ParentInterface; - public contentId: string | null; - - public constructor(_parent: ParentInterface, contentId: string | null = null) { - this._parent = _parent; - this.rc = _parent.rc; - this.contentId = contentId; - } - public path(withParameter = true): string { - if (withParameter && this.contentId !== null) { - return `${this._parent.path()}/contents/${this.contentId}`; - } - return `${this._parent.path()}/contents`; - } - /** - * Returns a list of social messaging contents ordered by creation date. The default order is descending. - * - * The account context of this request is determined by the RC Account ID associated with - * the access token provided in the Authorization header. - * - * The query parameters provided in request will be considered an AND operation to filter the list. - * - * A query parameter which is not specified or provided with the null value will be ignored. - * - * HTTP Method: get - * Endpoint: /cx/social-messaging/v1/contents - * Rate Limit Group: Light - * App Permission: SocialMessaging - */ - public async list( - queryParams?: ListSocialMessagingContentsParameters, - restRequestConfig?: RestRequestConfig, - ): Promise { - const r = await this.rc.get(this.path(false), queryParams, restRequestConfig); - return r.data; - } - - /** - * Creates the new social messaging content for use in discussions. - * - * This request is used to reply to an already posted content or to initiate a discussion. If authorized, the - * authenticated user will be used as the content author. - * - * Content will be created and pushed asynchronously to the channel. When the content is successfully pushed to - * the channel, the `Content.Exported` event will be reported. - * - * The account context of this request is determined by the RC Account ID associated with the access token provided - * in the Authorization header. - * - * Replying to customer content is usually possible unless the channel or conversation is read only. Composing - * content, on the contrary, depends on the channel itself. - * - * - The channel may not support it and be purely reactive like Instagram, Messenger, etc. - * - * - Some channels (usually public accounts, like Twitter or Facebook pages) allow content publishing - * without targeting specific individuals. - * - * - Some channels (usually non-public media) require specific targeting (phone number for SMS, email address - * for email, customer_id, etc.) to be able to create content. This is channel-specific and detailed under the - * generic parameters. - * - * HTTP Method: post - * Endpoint: /cx/social-messaging/v1/contents - * Rate Limit Group: Light - * App Permission: SocialMessaging - */ - public async post( - createSocialMessagingContentRequest: CreateSocialMessagingContentRequest, - restRequestConfig?: RestRequestConfig, - ): Promise { - const r = await this.rc.post( - this.path(false), - createSocialMessagingContentRequest, - undefined, - restRequestConfig, - ); - return r.data; - } - - /** - * Returns the social messaging content by ID specified in path. - * HTTP Method: get - * Endpoint: /cx/social-messaging/v1/contents/{contentId} - * Rate Limit Group: Light - * App Permission: SocialMessaging - */ - public async get(restRequestConfig?: RestRequestConfig): Promise { - if (this.contentId === null) { - throw new Error('contentId must be specified.'); - } - const r = await this.rc.get(this.path(), undefined, restRequestConfig); - return r.data; - } -} -export default Index; diff --git a/packages/core/src/paths/Cx/SocialMessaging/V1/Identities/index.ts b/packages/core/src/paths/Cx/SocialMessaging/V1/Identities/index.ts deleted file mode 100644 index 51dc21f5d..000000000 --- a/packages/core/src/paths/Cx/SocialMessaging/V1/Identities/index.ts +++ /dev/null @@ -1,58 +0,0 @@ -import type ListSocialMessagingIdentitiesParameters from '../../../../../definitions/ListSocialMessagingIdentitiesParameters'; -import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types'; - -class Index { - public rc: RingCentralInterface; - public _parent: ParentInterface; - public identityId: string | null; - - public constructor(_parent: ParentInterface, identityId: string | null = null) { - this._parent = _parent; - this.rc = _parent.rc; - this.identityId = identityId; - } - public path(withParameter = true): string { - if (withParameter && this.identityId !== null) { - return `${this._parent.path()}/identities/${this.identityId}`; - } - return `${this._parent.path()}/identities`; - } - /** - * Returns a list of identities ordered by creation date. The default order is descending. - * - * The account context of this request is determined by the RC Account ID associated with - * the access token provided in the Authorization header. - * - * The query parameters provided will be considered an AND operation to filter the list. - * - * A query parameter which is not specified or provided with the null value will be ignored. - * - * HTTP Method: get - * Endpoint: /cx/social-messaging/v1/identities - * Rate Limit Group: Light - * App Permission: SocialMessaging - */ - public async list( - queryParams?: ListSocialMessagingIdentitiesParameters, - restRequestConfig?: RestRequestConfig, - ): Promise { - const r = await this.rc.get(this.path(false), queryParams, restRequestConfig); - return r.data; - } - - /** - * Returns an identity by ID specified in path. - * HTTP Method: get - * Endpoint: /cx/social-messaging/v1/identities/{identityId} - * Rate Limit Group: Light - * App Permission: SocialMessaging - */ - public async get(restRequestConfig?: RestRequestConfig): Promise { - if (this.identityId === null) { - throw new Error('identityId must be specified.'); - } - const r = await this.rc.get(this.path(), undefined, restRequestConfig); - return r.data; - } -} -export default Index; diff --git a/packages/core/src/paths/Cx/index.ts b/packages/core/src/paths/Cx/index.ts deleted file mode 100644 index ce5b79b5b..000000000 --- a/packages/core/src/paths/Cx/index.ts +++ /dev/null @@ -1,18 +0,0 @@ -import SocialMessaging from './SocialMessaging'; -import type { RingCentralInterface } from '../../types'; - -class Index { - public rc: RingCentralInterface; - - public constructor(rc: RingCentralInterface) { - this.rc = rc; - } - public path(): string { - return '/cx'; - } - - public socialMessaging(): SocialMessaging { - return new SocialMessaging(this); - } -} -export default Index; diff --git a/packages/core/src/paths/Restapi/Account/CallLog/index.ts b/packages/core/src/paths/Restapi/Account/CallLog/index.ts index 0adac94e1..4718a5f18 100644 --- a/packages/core/src/paths/Restapi/Account/CallLog/index.ts +++ b/packages/core/src/paths/Restapi/Account/CallLog/index.ts @@ -37,7 +37,9 @@ class Index { } /** - * Returns individual call log record(s) by ID. Batch syntax is supported. + * Returns individual call log record(s) by ID. + * [Batch syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. + * * HTTP Method: get * Endpoint: /restapi/{apiVersion}/account/{accountId}/call-log/{callRecordId} * Rate Limit Group: Heavy diff --git a/packages/core/src/paths/Restapi/Account/Extension/AddressBook/Contact/index.ts b/packages/core/src/paths/Restapi/Account/Extension/AddressBook/Contact/index.ts index 2012b78fb..e8751ef7e 100644 --- a/packages/core/src/paths/Restapi/Account/Extension/AddressBook/Contact/index.ts +++ b/packages/core/src/paths/Restapi/Account/Extension/AddressBook/Contact/index.ts @@ -62,7 +62,7 @@ class Index { /** * Returns the user personal contact(s). - * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. * * HTTP Method: get * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} @@ -80,7 +80,7 @@ class Index { /** * Updates the user personal contact(s) (full resource update). - * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. * * HTTP Method: put * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} @@ -107,7 +107,7 @@ class Index { /** * Deletes the user personal contact(s). - * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. * * HTTP Method: delete * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} diff --git a/packages/core/src/paths/Restapi/Account/Extension/CallerBlocking/PhoneNumbers/index.ts b/packages/core/src/paths/Restapi/Account/Extension/CallerBlocking/PhoneNumbers/index.ts index d83b79d8c..b87497a48 100644 --- a/packages/core/src/paths/Restapi/Account/Extension/CallerBlocking/PhoneNumbers/index.ts +++ b/packages/core/src/paths/Restapi/Account/Extension/CallerBlocking/PhoneNumbers/index.ts @@ -59,7 +59,7 @@ class Index { /** * Returns blocked or allowed phone number(s) by their ID(s). - * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. * * HTTP Method: get * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId} @@ -77,7 +77,7 @@ class Index { /** * Updates blocked or allowed phone number(s) by their ID(s). - * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. * * HTTP Method: put * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId} @@ -102,7 +102,9 @@ class Index { } /** - * Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported. + * Deletes blocked or allowed phone number(s) by their ID(s). + * [Batch request](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. + * * HTTP Method: delete * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId} * Rate Limit Group: Medium diff --git a/packages/core/src/paths/Restapi/Account/Extension/Device/index.ts b/packages/core/src/paths/Restapi/Account/Extension/Device/index.ts index afca1f497..a4f2e8076 100644 --- a/packages/core/src/paths/Restapi/Account/Extension/Device/index.ts +++ b/packages/core/src/paths/Restapi/Account/Extension/Device/index.ts @@ -14,8 +14,8 @@ class Index { return `${this._parent.path()}/device`; } /** - * Returns devices of an extension or multiple extensions by their ID(s). Batch request - * is supported. + * Returns devices of an extension or multiple extensions by their ID(s). + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. * * HTTP Method: get * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/device diff --git a/packages/core/src/paths/Restapi/Account/Extension/MessageStore/index.ts b/packages/core/src/paths/Restapi/Account/Extension/MessageStore/index.ts index 13353f139..736aad251 100644 --- a/packages/core/src/paths/Restapi/Account/Extension/MessageStore/index.ts +++ b/packages/core/src/paths/Restapi/Account/Extension/MessageStore/index.ts @@ -41,12 +41,11 @@ class Index { } /** - * Deletes conversation(s) by conversation ID(s). Batch request is - * supported, max number of IDs passed as query/path parameters is 50. Alternative - * syntax is supported - user conversations can be deleted by passing multiple - * IDs in request body as an array of string, max number of conversation IDs - * passed in request body is 100. In this case asterisk is used in the path instead - * of IDs + * Deletes conversation(s) by conversation ID(s). + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported - maximum number + * of IDs passed as query/path parameters is 50. Alternative syntax is supported - the user's conversations can be deleted + * by passing multiple IDs in request body as an array of string. Maximum number of conversation IDs passed in request body + * is 100. In this case asterisk '*' is used in the path instead of IDs. * * HTTP Method: delete * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store @@ -64,7 +63,8 @@ class Index { /** * Returns an individual message record or multiple records by the given message ID(s). - * The length of inbound messages is unlimited. Bulk syntax is supported. + * The length of inbound messages is unlimited. [Bulk syntax](https://developers.ringcentral.com/guide/basics/batch-requests) + * is supported. * * HTTP Method: get * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId} @@ -83,12 +83,11 @@ class Index { /** * Updates message(s) by their ID(s). Currently, only the `readStatus` * can be updated using this method. - * - * Bulk syntax is supported, max number of IDs passed as query/path - * parameters is 50. Alternative bulk syntax is also supported - user messages can be updated - * by passing multiple IDs in request body as an array of string, max number - * of IDs passed in the body is 1000. In this case asterisk is used in the - * path instead of IDs. + * [Bulk syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported, + * maximum number of IDs passed as query/path parameters is 50. Alternative bulk syntax is also + * supported - the user's messages can be updated by passing multiple IDs in request body as + * an array of string, maximum number of IDs passed in the body is 1000. In this case asterisk '*' + * is used in the path instead of IDs. * * HTTP Method: put * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId} diff --git a/packages/core/src/paths/Restapi/Account/Extension/Presence/index.ts b/packages/core/src/paths/Restapi/Account/Extension/Presence/index.ts index f3268eb1c..a1fae0a90 100644 --- a/packages/core/src/paths/Restapi/Account/Extension/Presence/index.ts +++ b/packages/core/src/paths/Restapi/Account/Extension/Presence/index.ts @@ -20,7 +20,7 @@ class Index { * (the parameters `telephonyStatus`, `message`, `userStatus` and `dndStatus` are not returned at all) for the following extension types: * Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location. * If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off. - * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. For batch requests the number of extensions + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. For batch requests the number of extensions * in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error * code InvalidMultipartRequest and the corresponding message Extension Presence Info multipart request is limited to 30 extensions. * diff --git a/packages/core/src/paths/Restapi/Account/PhoneNumber/index.ts b/packages/core/src/paths/Restapi/Account/PhoneNumber/index.ts index f70668754..5e873a740 100644 --- a/packages/core/src/paths/Restapi/Account/PhoneNumber/index.ts +++ b/packages/core/src/paths/Restapi/Account/PhoneNumber/index.ts @@ -39,7 +39,7 @@ class Index { /** * Returns phone number(s) belonging to a certain account or extension by phoneNumberId(s). - * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. + * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. * * HTTP Method: get * Endpoint: /restapi/{apiVersion}/account/{accountId}/phone-number/{phoneNumberId} diff --git a/packages/core/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/Content/index.ts b/packages/core/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/Content/index.ts new file mode 100644 index 000000000..dcd9784f2 --- /dev/null +++ b/packages/core/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/Content/index.ts @@ -0,0 +1,33 @@ +import type ReadMultichannelCallRecordingContentParameters from '../../../../../../../definitions/ReadMultichannelCallRecordingContentParameters'; +import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../../types'; + +class Index { + public rc: RingCentralInterface; + public _parent: ParentInterface; + + public constructor(_parent: ParentInterface) { + this._parent = _parent; + this.rc = _parent.rc; + } + public path(): string { + return `${this._parent.path()}/content`; + } + /** + * Returns media content of a multichannel call recording + * + * **This API must be called via media API entry point, e.g. https://media.ringcentral.com** + * + * HTTP Method: get + * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/metadata/multichannel-recordings/{metadataId}/content + * Rate Limit Group: Heavy + * App Permission: ReadCallRecording + */ + public async get( + queryParams?: ReadMultichannelCallRecordingContentParameters, + restRequestConfig?: RestRequestConfig, + ): Promise { + const r = await this.rc.get(this.path(), queryParams, restRequestConfig); + return r.data; + } +} +export default Index; diff --git a/packages/core/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/index.ts b/packages/core/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/index.ts new file mode 100644 index 000000000..9b2e29be3 --- /dev/null +++ b/packages/core/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/index.ts @@ -0,0 +1,25 @@ +import Content from './Content'; +import type { RingCentralInterface, ParentInterface } from '../../../../../../types'; + +class Index { + public rc: RingCentralInterface; + public _parent: ParentInterface; + public metadataId: string | null; + + public constructor(_parent: ParentInterface, metadataId: string | null = null) { + this._parent = _parent; + this.rc = _parent.rc; + this.metadataId = metadataId; + } + public path(withParameter = true): string { + if (withParameter && this.metadataId !== null) { + return `${this._parent.path()}/multichannel-recordings/${this.metadataId}`; + } + return `${this._parent.path()}/multichannel-recordings`; + } + + public content(): Content { + return new Content(this); + } +} +export default Index; diff --git a/packages/core/src/paths/Restapi/Account/Telephony/Metadata/index.ts b/packages/core/src/paths/Restapi/Account/Telephony/Metadata/index.ts new file mode 100644 index 000000000..c7002fde8 --- /dev/null +++ b/packages/core/src/paths/Restapi/Account/Telephony/Metadata/index.ts @@ -0,0 +1,20 @@ +import MultichannelRecordings from './MultichannelRecordings'; +import type { RingCentralInterface, ParentInterface } from '../../../../../types'; + +class Index { + public rc: RingCentralInterface; + public _parent: ParentInterface; + + public constructor(_parent: ParentInterface) { + this._parent = _parent; + this.rc = _parent.rc; + } + public path(): string { + return `${this._parent.path(false)}/metadata`; + } + + public multichannelRecordings(metadataId: string | null = null): MultichannelRecordings { + return new MultichannelRecordings(this, metadataId); + } +} +export default Index; diff --git a/packages/core/src/paths/Restapi/Account/Telephony/Sessions/Parties/Recordings/index.ts b/packages/core/src/paths/Restapi/Account/Telephony/Sessions/Parties/Recordings/index.ts index 73c739464..9c9c469d7 100644 --- a/packages/core/src/paths/Restapi/Account/Telephony/Sessions/Parties/Recordings/index.ts +++ b/packages/core/src/paths/Restapi/Account/Telephony/Sessions/Parties/Recordings/index.ts @@ -20,7 +20,9 @@ class Index { return `${this._parent.path()}/recordings`; } /** - * Starts a new call recording for the party + * Starts a new call recording for a call party. + * *Please note* this API does not allow conference calls to be recorded. + * * HTTP Method: post * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings * Rate Limit Group: Light diff --git a/packages/core/src/paths/Restapi/Account/Telephony/index.ts b/packages/core/src/paths/Restapi/Account/Telephony/index.ts index dd3450ad2..7a25f8c71 100644 --- a/packages/core/src/paths/Restapi/Account/Telephony/index.ts +++ b/packages/core/src/paths/Restapi/Account/Telephony/index.ts @@ -1,6 +1,7 @@ import Conference from './Conference'; import CallOut from './CallOut'; import Sessions from './Sessions'; +import Metadata from './Metadata'; import type { RingCentralInterface, ParentInterface } from '../../../../types'; class Index { @@ -15,6 +16,10 @@ class Index { return `${this._parent.path()}/telephony`; } + public metadata(): Metadata { + return new Metadata(this); + } + public sessions(telephonySessionId: string | null = null): Sessions { return new Sessions(this, telephonySessionId); } diff --git a/packages/core/src/paths/TeamMessaging/V1/Persons/index.ts b/packages/core/src/paths/TeamMessaging/V1/Persons/index.ts index fa121ffbb..8cc5b98df 100644 --- a/packages/core/src/paths/TeamMessaging/V1/Persons/index.ts +++ b/packages/core/src/paths/TeamMessaging/V1/Persons/index.ts @@ -18,7 +18,9 @@ class Index { return `${this._parent.path()}/persons`; } /** - * Returns a user or multiple users by their ID(s). Batch request is supported. + * Returns a user or multiple users by their ID(s). + * [Batch requests](https://developers.ringcentral.com/guide/basics/batch-requests) are supported. + * * HTTP Method: get * Endpoint: /team-messaging/v1/persons/{personId} * Rate Limit Group: Light diff --git a/packages/core/src/samples.md b/packages/core/src/samples.md index 0fddee975..c478fa4ac 100644 --- a/packages/core/src/samples.md +++ b/packages/core/src/samples.md @@ -362,30 +362,6 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Bridge-Management-updateBridge) in API Explorer. -## getToken - -OAuth 2.0 Token Endpoint - -| Name | Value | -| ---------------- | ---------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/oauth/token` | -| Rate Limit Group | `Auth` | -| App Permission | `N/A` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.restapi().oauth().token().post(getTokenRequest); -await rc.revoke(); -``` - -- `getTokenRequest` is of type [GetTokenRequest](./definitions/GetTokenRequest.ts) -- `result` is of type [TokenInfo](./definitions/TokenInfo.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#OAuth-and-OpenID-Connect-getToken) in API Explorer. - ## scimListResourceTypes2 List Resource Types @@ -434,6 +410,80 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#SCIM-scimGetResourceType2) in API Explorer. +## getToken + +OAuth 2.0 Token Endpoint + +| Name | Value | +| ---------------- | ---------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/oauth/token` | +| Rate Limit Group | `Auth` | +| App Permission | `N/A` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc.restapi().oauth().token().post(getTokenRequest); +await rc.revoke(); +``` + +- `getTokenRequest` is of type [GetTokenRequest](./definitions/GetTokenRequest.ts) +- `result` is of type [TokenInfo](./definitions/TokenInfo.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#OAuth-and-OpenID-Connect-getToken) in API Explorer. + +## caiSpeakerDiarize + +Speaker Diarization + +| Name | Value | +| ---------------- | ------------------------------------ | +| HTTP Method | `POST` | +| Endpoint | `/ai/audio/v1/async/speaker-diarize` | +| Rate Limit Group | `Heavy` | +| App Permission | `AI` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc.ai().audio().v1().async().speakerDiarize().post(diarizeInput, caiSpeakerDiarizeParameters); +await rc.revoke(); +``` + +- `diarizeInput` is of type [DiarizeInput](./definitions/DiarizeInput.ts) +- `caiSpeakerDiarizeParameters` is of type [CaiSpeakerDiarizeParameters](./definitions/CaiSpeakerDiarizeParameters.ts) +- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Audio-caiSpeakerDiarize) in API Explorer. + +## caiSpeakerIdentify + +Speaker Identification + +| Name | Value | +| ---------------- | ------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/ai/audio/v1/async/speaker-identify` | +| Rate Limit Group | `Heavy` | +| App Permission | `AI` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc.ai().audio().v1().async().speakerIdentify().post(identifyInput, caiSpeakerIdentifyParameters); +await rc.revoke(); +``` + +- `identifyInput` is of type [IdentifyInput](./definitions/IdentifyInput.ts) +- `caiSpeakerIdentifyParameters` is of type [CaiSpeakerIdentifyParameters](./definitions/CaiSpeakerIdentifyParameters.ts) +- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Audio-caiSpeakerIdentify) in API Explorer. + ## caiEnrollmentsList List Enrolled Speakers @@ -552,6 +602,32 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Audio-caiEnrollmentsUpdate) in API Explorer. +## createBridge + +Create Bridge + +| Name | Value | +| ---------------- | ----------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/rcvideo/v2/account/{accountId}/extension/{extensionId}/bridges` | +| Rate Limit Group | `Heavy` | +| App Permission | `Video` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc.rcvideo().v2().account(accountId).extension(extensionId).bridges().post(createBridgeRequest); +await rc.revoke(); +``` + +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `createBridgeRequest` is of type [CreateBridgeRequest](./definitions/CreateBridgeRequest.ts) +- `result` is of type [BridgeResponse](./definitions/BridgeResponse.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Bridge-Management-createBridge) in API Explorer. + ## revokeToken OAuth 2.0 Token Revocation Endpoint @@ -577,5510 +653,5324 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#OAuth-and-OpenID-Connect-revokeToken) in API Explorer. -## readDevice +## getAccountInfoV2 -Get Device +Get Account Info -| Name | Value | -| ---------------- | ------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/device/{deviceId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyDevices` | +| Name | Value | +| ---------------- | ---------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/v2/accounts/{accountId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).device(deviceId).get(readDeviceParameters); +var result = await rc.restapi().v2().accounts(accountId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readDeviceParameters` is of type [ReadDeviceParameters](./definitions/ReadDeviceParameters.ts) -- `result` is of type [DeviceResource](./definitions/DeviceResource.ts) +- `result` is of type [AccountInfo](./definitions/AccountInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Devices-readDevice) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Company-getAccountInfoV2) in API Explorer. -## updateDevice +## addDeviceToInventory -Update Device +Add Phone to Inventory -| Name | Value | -| ---------------- | ------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/device/{deviceId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyDevices` | +| Name | Value | +| ---------------- | --------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/v2/accounts/{accountId}/device-inventory` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .device(deviceId) - .put(accountDeviceUpdate, updateDeviceParameters); +var result = await rc.restapi().v2().accounts(accountId).deviceInventory().post(addDeviceToInventoryRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `accountDeviceUpdate` is of type [AccountDeviceUpdate](./definitions/AccountDeviceUpdate.ts) -- `updateDeviceParameters` is of type [UpdateDeviceParameters](./definitions/UpdateDeviceParameters.ts) -- `result` is of type [DeviceResource](./definitions/DeviceResource.ts) +- `addDeviceToInventoryRequest` is of type [AddDeviceToInventoryRequest](./definitions/AddDeviceToInventoryRequest.ts) +- `result` is of type [AddDeviceToInventoryResponse](./definitions/AddDeviceToInventoryResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Devices-updateDevice) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Devices-addDeviceToInventory) in API Explorer. -## listSites +## deleteDeviceFromInventory -List Sites +Delete Device from Inventory -| Name | Value | -| ---------------- | ------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | --------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/v2/accounts/{accountId}/device-inventory` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites().list(); +var result = await rc.restapi().v2().accounts(accountId).deviceInventory().delete(deleteDeviceFromInventoryRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [SitesList](./definitions/SitesList.ts) +- `deleteDeviceFromInventoryRequest` is of type [DeleteDeviceFromInventoryRequest](./definitions/DeleteDeviceFromInventoryRequest.ts) +- `result` is of type [DeleteDeviceFromInventoryResponse](./definitions/DeleteDeviceFromInventoryResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-listSites) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Devices-deleteDeviceFromInventory) in API Explorer. -## createSite +## bulkAddDevicesV2 -Create Site +Add BYOD Devices -| Name | Value | -| ---------------- | ------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/v2/accounts/{accountId}/devices/bulk-add` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `AddRemoveDevices` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites().post(createSiteRequest); +var result = await rc.restapi().v2().accounts(accountId).devices().bulkAdd().post(bulkAddDevicesRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `createSiteRequest` is of type [CreateSiteRequest](./definitions/CreateSiteRequest.ts) -- `result` is of type [SiteInfo](./definitions/SiteInfo.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-createSite) in API Explorer. +- `bulkAddDevicesRequest` is of type [BulkAddDevicesRequest](./definitions/BulkAddDevicesRequest.ts) +- `result` is of type [BulkAddDevicesResponse](./definitions/BulkAddDevicesResponse.ts) -## readSite +[Try it out](https://developer.ringcentral.com/api-reference#Devices-bulkAddDevicesV2) in API Explorer. -Get Site +## auditTrailSearch -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +Search Audit Trail Data -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).get(); -await rc.revoke(); +| Name | Value | +| ---------------- | -------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/audit-trail/search` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadAuditTrail` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .auditTrail() + .search() + .post(accountHistorySearchPublicRequest); +await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [SiteInfo](./definitions/SiteInfo.ts) +- `accountHistorySearchPublicRequest` is of type [AccountHistorySearchPublicRequest](./definitions/AccountHistorySearchPublicRequest.ts) +- `result` is of type [AccountHistorySearchPublicResponse](./definitions/AccountHistorySearchPublicResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-readSite) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Audit-Trail-auditTrailSearch) in API Explorer. -## updateSite +## listCallQueueMembers -Update Site +List Call Queue Members -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}` | -| Rate Limit Group | `Light` | -| App Permission | `EditExtensions` | -| User Permission | `Sites` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}/members` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).put(siteUpdateRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callQueues(groupId) + .members() + .get(listCallQueueMembersParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `siteUpdateRequest` is of type [SiteUpdateRequest](./definitions/SiteUpdateRequest.ts) -- `result` is of type [SiteInfo](./definitions/SiteInfo.ts) +- `listCallQueueMembersParameters` is of type [ListCallQueueMembersParameters](./definitions/ListCallQueueMembersParameters.ts) +- `result` is of type [CallQueueMembers](./definitions/CallQueueMembers.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-updateSite) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-listCallQueueMembers) in API Explorer. -## deleteSite +## readCallQueuePresence -Delete Site +Get Call Queue Presence -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}` | -| Rate Limit Group | `Light` | -| App Permission | `EditAccounts` | -| User Permission | `Sites` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}/presence` | +| Rate Limit Group | `Light` | +| App Permission | `ReadPresence` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).delete(); +var result = await rc.restapi(apiVersion).account(accountId).callQueues(groupId).presence().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is an empty string +- `result` is of type [CallQueuePresence](./definitions/CallQueuePresence.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-deleteSite) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Presence-readCallQueuePresence) in API Explorer. -## listSubscriptions +## updateCallQueuePresence -List Subscriptions +Update Call Queue Presence -| Name | Value | -| ---------------- | ------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/subscription` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}/presence` | +| Rate Limit Group | `Medium` | +| App Permission | `EditPresence` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).subscription().list(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callQueues(groupId) + .presence() + .put(callQueueUpdatePresence); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [SubscriptionListResource](./definitions/SubscriptionListResource.ts) +- Parameter `accountId` is optional with default value `~` +- `callQueueUpdatePresence` is of type [CallQueueUpdatePresence](./definitions/CallQueueUpdatePresence.ts) +- `result` is of type [CallQueuePresence](./definitions/CallQueuePresence.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-listSubscriptions) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Presence-updateCallQueuePresence) in API Explorer. -## createSubscription +## readDevice -Create Subscription +Get Device -| Name | Value | -| ---------------- | ------------------------------------ | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/subscription` | -| Rate Limit Group | `Medium` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/device/{deviceId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyDevices` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).subscription().post(createSubscriptionRequest); +var result = await rc.restapi(apiVersion).account(accountId).device(deviceId).get(readDeviceParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- `createSubscriptionRequest` is of type [CreateSubscriptionRequest](./definitions/CreateSubscriptionRequest.ts) -- `result` is of type [SubscriptionInfo](./definitions/SubscriptionInfo.ts) +- Parameter `accountId` is optional with default value `~` +- `readDeviceParameters` is of type [ReadDeviceParameters](./definitions/ReadDeviceParameters.ts) +- `result` is of type [DeviceResource](./definitions/DeviceResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-createSubscription) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Devices-readDevice) in API Explorer. -## readSubscription +## updateDevice -Get Subscription +Update Device -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/subscription/{subscriptionId}` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/device/{deviceId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyDevices` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).subscription(subscriptionId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .device(deviceId) + .put(accountDeviceUpdate, updateDeviceParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [SubscriptionInfo](./definitions/SubscriptionInfo.ts) +- Parameter `accountId` is optional with default value `~` +- `accountDeviceUpdate` is of type [AccountDeviceUpdate](./definitions/AccountDeviceUpdate.ts) +- `updateDeviceParameters` is of type [UpdateDeviceParameters](./definitions/UpdateDeviceParameters.ts) +- `result` is of type [DeviceResource](./definitions/DeviceResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-readSubscription) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Devices-updateDevice) in API Explorer. -## updateSubscription +## listDirectoryEntries -Update Subscription +Get Company Directory Entries -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/subscription/{subscriptionId}` | -| Rate Limit Group | `Medium` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/directory/entries` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).subscription(subscriptionId).put(updateSubscriptionRequest); +var result = await rc.restapi(apiVersion).account(accountId).directory().entries().list(listDirectoryEntriesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- `updateSubscriptionRequest` is of type [UpdateSubscriptionRequest](./definitions/UpdateSubscriptionRequest.ts) -- `result` is of type [SubscriptionInfo](./definitions/SubscriptionInfo.ts) +- Parameter `accountId` is optional with default value `~` +- `listDirectoryEntriesParameters` is of type [ListDirectoryEntriesParameters](./definitions/ListDirectoryEntriesParameters.ts) +- `result` is of type [DirectoryResource](./definitions/DirectoryResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-updateSubscription) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Internal-Contacts-listDirectoryEntries) in API Explorer. -## deleteSubscription +## readDirectoryEntry -Cancel Subscription +Get Corporate Directory Entry -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/subscription/{subscriptionId}` | -| Rate Limit Group | `Medium` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/directory/entries/{entryId}` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).subscription(subscriptionId).delete(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .directory() + .entries(entryId) + .get(readDirectoryEntryParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- `result` is an empty string +- Parameter `accountId` is optional with default value `~` +- `readDirectoryEntryParameters` is of type [ReadDirectoryEntryParameters](./definitions/ReadDirectoryEntryParameters.ts) +- `result` is of type [ContactResource](./definitions/ContactResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-deleteSubscription) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Internal-Contacts-readDirectoryEntry) in API Explorer. -## scimSearchViaPost2 +## readDirectoryFederation -Search/List Users +Get Account Federation -| Name | Value | -| ---------------- | --------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/scim/{version}/Users/dotSearch` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/directory/federation` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.scim(version).users().dotSearch().post(scimSearchRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .directory() + .federation() + .get(readDirectoryFederationParameters); await rc.revoke(); ``` -- Parameter `version` is optional with default value `v2` -- `scimSearchRequest` is of type [ScimSearchRequest](./definitions/ScimSearchRequest.ts) -- `result` is of type [ScimUserSearchResponse](./definitions/ScimUserSearchResponse.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#SCIM-scimSearchViaPost2) in API Explorer. - -## authorize +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `readDirectoryFederationParameters` is of type [ReadDirectoryFederationParameters](./definitions/ReadDirectoryFederationParameters.ts) +- `result` is of type [FederationResource](./definitions/FederationResource.ts) -OAuth 2.0 Authorization Endpoint +[Try it out](https://developer.ringcentral.com/api-reference#Internal-Contacts-readDirectoryFederation) in API Explorer. -| Name | Value | -| ---------------- | -------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/oauth/authorize` | -| Rate Limit Group | `Auth` | -| App Permission | `N/A` | -| User Permission | `N/A` | +## listEmergencyLocations + +List Emergency Locations + +| Name | Value | +| ---------------- | --------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ConfigureEmergencyMaps` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().oauth().authorize().get(authorizeParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .emergencyLocations() + .list(listEmergencyLocationsParameters); await rc.revoke(); ``` -- `authorizeParameters` is of type [AuthorizeParameters](./definitions/AuthorizeParameters.ts) -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `listEmergencyLocationsParameters` is of type [ListEmergencyLocationsParameters](./definitions/ListEmergencyLocationsParameters.ts) +- `result` is of type [EmergencyLocationsResource](./definitions/EmergencyLocationsResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#OAuth-and-OpenID-Connect-authorize) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-listEmergencyLocations) in API Explorer. -## authorize2 +## createEmergencyLocation -OAuth 2.0 Authorization Endpoint (POST) +Add Emergency Location -| Name | Value | -| ---------------- | -------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/oauth/authorize` | -| Rate Limit Group | `Auth` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `ConfigureEmergencyMaps` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().oauth().authorize().post(authorizeRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .emergencyLocations() + .post(emergencyLocationRequestResource); await rc.revoke(); ``` -- `authorizeRequest` is of type [AuthorizeRequest](./definitions/AuthorizeRequest.ts) -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `emergencyLocationRequestResource` is of type [EmergencyLocationRequestResource](./definitions/EmergencyLocationRequestResource.ts) +- `result` is of type [EmergencyLocationResponseResource](./definitions/EmergencyLocationResponseResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#OAuth-and-OpenID-Connect-authorize2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-createEmergencyLocation) in API Explorer. -## getAccountInfoV2 +## readEmergencyLocation -Get Account Info +Get Emergency Location -| Name | Value | -| ---------------- | ---------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/v2/accounts/{accountId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}` | +| Rate Limit Group | `Light` | +| App Permission | `EditAccounts` | +| User Permission | `ConfigureEmergencyMaps` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .emergencyLocations(locationId) + .get(readEmergencyLocationParameters); await rc.revoke(); ``` -- `result` is of type [AccountInfo](./definitions/AccountInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `readEmergencyLocationParameters` is of type [ReadEmergencyLocationParameters](./definitions/ReadEmergencyLocationParameters.ts) +- `result` is of type [CommonEmergencyLocationResource](./definitions/CommonEmergencyLocationResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Company-getAccountInfoV2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-readEmergencyLocation) in API Explorer. -## readCompanyCallLog +## updateEmergencyLocation -List Company Call Records +Update Emergency Location -| Name | Value | -| ---------------- | ---------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-log` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallLog` | -| User Permission | `FullCompanyCallLog` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `ConfigureEmergencyMaps` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callLog().list(readCompanyCallLogParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .emergencyLocations(locationId) + .put(emergencyLocationRequestResource); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `readCompanyCallLogParameters` is of type [ReadCompanyCallLogParameters](./definitions/ReadCompanyCallLogParameters.ts) -- `result` is of type [CallLogResponse](./definitions/CallLogResponse.ts) +- `emergencyLocationRequestResource` is of type [EmergencyLocationRequestResource](./definitions/EmergencyLocationRequestResource.ts) +- `result` is of type [EmergencyLocationResponseResource](./definitions/EmergencyLocationResponseResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-readCompanyCallLog) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-updateEmergencyLocation) in API Explorer. -## readCompanyCallRecord +## deleteEmergencyLocation -Get Company Call Record(s) +Delete Emergency Location -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-log/{callRecordId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallLog` | -| User Permission | `FullCompanyCallLog` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `ConfigureEmergencyMaps` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callLog(callRecordId).get(readCompanyCallRecordParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .emergencyLocations(locationId) + .delete(deleteEmergencyLocationParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `readCompanyCallRecordParameters` is of type [ReadCompanyCallRecordParameters](./definitions/ReadCompanyCallRecordParameters.ts) -- `result` is of type [CallLogRecord](./definitions/CallLogRecord.ts) +- `deleteEmergencyLocationParameters` is of type [DeleteEmergencyLocationParameters](./definitions/DeleteEmergencyLocationParameters.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-readCompanyCallRecord) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-deleteEmergencyLocation) in API Explorer. -## listExtensions +## extensionBulkUpdate -List Extensions +Update Multiple Extensions -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension-bulk-update` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditExtensions` | +| User Permission | `EditExtensionInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension().list(listExtensionsParameters); +var result = await rc.restapi(apiVersion).account(accountId).extensionBulkUpdate().post(extensionBulkUpdateRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `listExtensionsParameters` is of type [ListExtensionsParameters](./definitions/ListExtensionsParameters.ts) -- `result` is of type [GetExtensionListResponse](./definitions/GetExtensionListResponse.ts) +- `extensionBulkUpdateRequest` is of type [ExtensionBulkUpdateRequest](./definitions/ExtensionBulkUpdateRequest.ts) +- `result` is of type [ExtensionBulkUpdateTaskResource](./definitions/ExtensionBulkUpdateTaskResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Extensions-listExtensions) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Extensions-extensionBulkUpdate) in API Explorer. -## createExtension +## readUserCallLog -Create Extension +List User Call Records -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `AddRemoveUsers` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-log` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallLog` | +| User Permission | `ReadCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension().post(extensionCreationRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .callLog() + .list(readUserCallLogParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `extensionCreationRequest` is of type [ExtensionCreationRequest](./definitions/ExtensionCreationRequest.ts) -- `result` is of type [ExtensionCreationResponse](./definitions/ExtensionCreationResponse.ts) +- Parameter `extensionId` is optional with default value `~` +- `readUserCallLogParameters` is of type [ReadUserCallLogParameters](./definitions/ReadUserCallLogParameters.ts) +- `result` is of type [CallLogResponse](./definitions/CallLogResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Extensions-createExtension) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-readUserCallLog) in API Explorer. -## readExtension +## deleteUserCallLog -Get Extension +Delete User Call Records -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-log` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditCallLog` | +| User Permission | `EditCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .callLog() + .delete(deleteUserCallLogParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `result` is of type [GetExtensionInfoResponse](./definitions/GetExtensionInfoResponse.ts) +- `deleteUserCallLogParameters` is of type [DeleteUserCallLogParameters](./definitions/DeleteUserCallLogParameters.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readExtension) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-deleteUserCallLog) in API Explorer. -## updateExtension +## readUserCallRecord -Update Extension +Get User Call Record(s) -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserInfo OR EditUserCredentials` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallLog` | +| User Permission | `ReadCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).put(extensionUpdateRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .callLog(callRecordId) + .get(readUserCallRecordParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `extensionUpdateRequest` is of type [ExtensionUpdateRequest](./definitions/ExtensionUpdateRequest.ts) -- `result` is of type [GetExtensionInfoResponse](./definitions/GetExtensionInfoResponse.ts) +- `readUserCallRecordParameters` is of type [ReadUserCallRecordParameters](./definitions/ReadUserCallRecordParameters.ts) +- `result` is of type [CallLogRecord](./definitions/CallLogRecord.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateExtension) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-readUserCallRecord) in API Explorer. -## createCompanyGreeting +## updateUserCallQueues -Create Company Greeting +Update User Call Queues -| Name | Value | -| ---------------- | ---------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/greeting` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `ReadUserInfo` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-queues` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCallQueuePresence` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).greeting().post(createCompanyGreetingRequest); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).callQueues().put(userCallQueues); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `createCompanyGreetingRequest` is of type [CreateCompanyGreetingRequest](./definitions/CreateCompanyGreetingRequest.ts) -- `result` is of type [CustomCompanyGreetingInfo](./definitions/CustomCompanyGreetingInfo.ts) +- Parameter `extensionId` is optional with default value `~` +- `userCallQueues` is of type [UserCallQueues](./definitions/UserCallQueues.ts) +- `result` is of type [UserCallQueues](./definitions/UserCallQueues.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Greetings-createCompanyGreeting) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-updateUserCallQueues) in API Explorer. -## readIVRMenuList +## readExtensionCallerId -Get IVR Menu list +Get Extension Caller ID -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-menus` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-id` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCallerIDSettings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrMenus().list(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).callerId().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [IVRMenuList](./definitions/IVRMenuList.ts) +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [ExtensionCallerIdInfo](./definitions/ExtensionCallerIdInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-readIVRMenuList) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readExtensionCallerId) in API Explorer. -## createIVRMenu +## updateExtensionCallerId -Create IVR Menu +Update Extension Caller ID -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-menus` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `AutoReceptionist` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-id` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditCallerIDSettings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrMenus().post(iVRMenuInfo); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .callerId() + .put(extensionCallerIdInfoRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `iVRMenuInfo` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) -- `result` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) +- Parameter `extensionId` is optional with default value `~` +- `extensionCallerIdInfoRequest` is of type [ExtensionCallerIdInfoRequest](./definitions/ExtensionCallerIdInfoRequest.ts) +- `result` is of type [ExtensionCallerIdInfo](./definitions/ExtensionCallerIdInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-createIVRMenu) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateExtensionCallerId) in API Explorer. -## readIVRMenu +## listFavoriteContacts -Get IVR Menu +List Favorite Contacts -| Name | Value | -| ---------------- | ----------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-menus/{ivrMenuId}` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `AutoReceptionist` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/favorite` | +| Rate Limit Group | `Light` | +| App Permission | `ReadContacts` | +| User Permission | `ReadPersonalContacts` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrMenus(ivrMenuId).get(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).favorite().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [FavoriteContactList](./definitions/FavoriteContactList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-readIVRMenu) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#External-Contacts-listFavoriteContacts) in API Explorer. -## updateIVRMenu +## updateFavoriteContactList -Update IVR Menu +Update Favorite Contact List -| Name | Value | -| ---------------- | ----------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-menus/{ivrMenuId}` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `AutoReceptionist` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/favorite` | +| Rate Limit Group | `Medium` | +| App Permission | `Contacts` | +| User Permission | `EditPersonalContacts` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrMenus(ivrMenuId).put(iVRMenuInfo); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).favorite().put(favoriteCollection); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `iVRMenuInfo` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) -- `result` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) +- Parameter `extensionId` is optional with default value `~` +- `favoriteCollection` is of type [FavoriteCollection](./definitions/FavoriteCollection.ts) +- `result` is of type [FavoriteContactList](./definitions/FavoriteContactList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-updateIVRMenu) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#External-Contacts-updateFavoriteContactList) in API Explorer. -## readAccountPresence +## readExtensionFeatures -Get User Presence Status List +Get User Features -| Name | Value | -| ---------------- | ---------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/presence` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadPresence` | -| User Permission | `ReadPresenceStatus` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/features` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).presence().get(readAccountPresenceParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .features() + .get(readExtensionFeaturesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `readAccountPresenceParameters` is of type [ReadAccountPresenceParameters](./definitions/ReadAccountPresenceParameters.ts) -- `result` is of type [AccountPresenceInfo](./definitions/AccountPresenceInfo.ts) +- Parameter `extensionId` is optional with default value `~` +- `readExtensionFeaturesParameters` is of type [ReadExtensionFeaturesParameters](./definitions/ReadExtensionFeaturesParameters.ts) +- `result` is of type [FeatureList](./definitions/FeatureList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Presence-readAccountPresence) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Features-readExtensionFeatures) in API Explorer. -## readCallRecording +## createCustomUserGreeting -Get Call Recording +Create Custom User Greeting -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/recording/{recordingId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallRecording` | -| User Permission | `ReadCallRecording` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/greeting` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).recording(recordingId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .greeting() + .post(createCustomUserGreetingRequest, createCustomUserGreetingParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [GetCallRecordingResponse](./definitions/GetCallRecordingResponse.ts) +- Parameter `extensionId` is optional with default value `~` +- `createCustomUserGreetingRequest` is of type [CreateCustomUserGreetingRequest](./definitions/CreateCustomUserGreetingRequest.ts) +- `createCustomUserGreetingParameters` is of type [CreateCustomUserGreetingParameters](./definitions/CreateCustomUserGreetingParameters.ts) +- `result` is of type [CustomUserGreetingInfo](./definitions/CustomUserGreetingInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recordings-readCallRecording) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Greetings-createCustomUserGreeting) in API Explorer. -## readSiteIvrSettings +## readCustomGreeting -Get Site IVR Settings +Get Custom Greeting -| Name | Value | -| ---------------- | -------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}/ivr` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/greeting/{greetingId}` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadUserInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).ivr().get(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).greeting(greetingId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [SiteIVRSettings](./definitions/SiteIVRSettings.ts) +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [CustomUserGreetingInfo](./definitions/CustomUserGreetingInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-readSiteIvrSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Greetings-readCustomGreeting) in API Explorer. -## updateSiteIvrSettings +## readUserPresenceStatus -Update Site IVR Settings +Get User Presence Status -| Name | Value | -| ---------------- | -------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}/ivr` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `Sites` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/presence` | +| Rate Limit Group | `Light` | +| App Permission | `ReadPresence` | +| User Permission | `ReadPresenceStatus` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).ivr().put(siteIVRSettingsUpdate); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .presence() + .get(readUserPresenceStatusParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `siteIVRSettingsUpdate` is of type [SiteIVRSettingsUpdate](./definitions/SiteIVRSettingsUpdate.ts) -- `result` is of type [SiteIVRSettings](./definitions/SiteIVRSettings.ts) +- Parameter `extensionId` is optional with default value `~` +- `readUserPresenceStatusParameters` is of type [ReadUserPresenceStatusParameters](./definitions/ReadUserPresenceStatusParameters.ts) +- `result` is of type [GetPresenceInfo](./definitions/GetPresenceInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-updateSiteIvrSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Presence-readUserPresenceStatus) in API Explorer. -## listUserTemplates +## updateUserPresenceStatus -List User Templates +Update User Presence Status -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/templates` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/presence` | +| Rate Limit Group | `Medium` | +| App Permission | `EditPresence` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).templates().list(listUserTemplatesParameters); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).presence().put(presenceInfoRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `listUserTemplatesParameters` is of type [ListUserTemplatesParameters](./definitions/ListUserTemplatesParameters.ts) -- `result` is of type [UserTemplates](./definitions/UserTemplates.ts) +- Parameter `extensionId` is optional with default value `~` +- `presenceInfoRequest` is of type [PresenceInfoRequest](./definitions/PresenceInfoRequest.ts) +- `result` is of type [PresenceInfoResponse](./definitions/PresenceInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Extensions-listUserTemplates) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Presence-updateUserPresenceStatus) in API Explorer. -## readUserTemplate +## createRingOutCall -Get User Template +Make RingOut Call -| Name | Value | -| ---------------- | ------------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/templates/{templateId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/ring-out` | +| Rate Limit Group | `Heavy` | +| App Permission | `RingOut` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).templates(templateId).get(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).ringOut().post(makeRingOutRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [TemplateInfo](./definitions/TemplateInfo.ts) +- Parameter `extensionId` is optional with default value `~` +- `makeRingOutRequest` is of type [MakeRingOutRequest](./definitions/MakeRingOutRequest.ts) +- `result` is of type [GetRingOutStatusResponse](./definitions/GetRingOutStatusResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Extensions-readUserTemplate) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#RingOut-createRingOutCall) in API Explorer. -## listUserRoles +## readRingOutCallStatus -List Company User Roles +Get RingOut Call Status -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadUserRoles` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}` | +| Rate Limit Group | `Light` | +| App Permission | `RingOut` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).userRole().list(listUserRolesParameters); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).ringOut(ringoutId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `listUserRolesParameters` is of type [ListUserRolesParameters](./definitions/ListUserRolesParameters.ts) -- `result` is of type [RolesCollectionResource](./definitions/RolesCollectionResource.ts) +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [GetRingOutStatusResponse](./definitions/GetRingOutStatusResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listUserRoles) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#RingOut-readRingOutCallStatus) in API Explorer. -## createCustomRole +## deleteRingOutCall -Create Custom Role +Cancel RingOut Call -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role` | -| Rate Limit Group | `Medium` | -| App Permission | `RoleManagement` | -| User Permission | `EditUserRoles` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `RingOut` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).userRole().post(roleResource); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).ringOut(ringoutId).delete(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `roleResource` is of type [RoleResource](./definitions/RoleResource.ts) +- Parameter `extensionId` is optional with default value `~` - `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-createCustomRole) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#RingOut-deleteRingOutCall) in API Explorer. -## readUserRole +## getForwardAllCompanyCalls -Get User Role +Get Forward All Company Calls -| Name | Value | -| ---------------- | -------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/{roleId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadUserRoles` | +| Name | Value | +| ---------------- | ------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/forward-all-calls` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).userRole(roleId).get(readUserRoleParameters); +var result = await rc.restapi(apiVersion).account(accountId).forwardAllCalls().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `readUserRoleParameters` is of type [ReadUserRoleParameters](./definitions/ReadUserRoleParameters.ts) -- `result` is of type [RoleResource](./definitions/RoleResource.ts) +- `result` is of type [ForwardAllCompanyCallsInfo](./definitions/ForwardAllCompanyCallsInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-readUserRole) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-getForwardAllCompanyCalls) in API Explorer. -## updateUserRole +## updateForwardAllCompanyCalls -Update User Role +Update Forward All Company Calls -| Name | Value | -| ---------------- | -------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/{roleId}` | -| Rate Limit Group | `Medium` | -| App Permission | `RoleManagement` | -| User Permission | `EditUserRoles` | +| Name | Value | +| ---------------- | ------------------------------------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/forward-all-calls` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).userRole(roleId).put(roleResource); +var result = await rc.restapi(apiVersion).account(accountId).forwardAllCalls().patch(forwardAllCompanyCallsRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `roleResource` is of type [RoleResource](./definitions/RoleResource.ts) -- `result` is of type [RoleResource](./definitions/RoleResource.ts) +- `forwardAllCompanyCallsRequest` is of type [ForwardAllCompanyCallsRequest](./definitions/ForwardAllCompanyCallsRequest.ts) +- `result` is of type [ForwardAllCompanyCallsInfo](./definitions/ForwardAllCompanyCallsInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-updateUserRole) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-updateForwardAllCompanyCalls) in API Explorer. -## deleteCustomRole +## readIVRPromptContent -Delete Custom Role +Get IVR Prompt Content -| Name | Value | -| ---------------- | -------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/{roleId}` | -| Rate Limit Group | `Medium` | -| App Permission | `RoleManagement` | -| User Permission | `EditUserRoles` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts/{promptId}/content` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).userRole(roleId).delete(deleteCustomRoleParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .ivrPrompts(promptId) + .content() + .get(readIVRPromptContentParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `deleteCustomRoleParameters` is of type [DeleteCustomRoleParameters](./definitions/DeleteCustomRoleParameters.ts) -- `result` is an empty string +- `readIVRPromptContentParameters` is of type [ReadIVRPromptContentParameters](./definitions/ReadIVRPromptContentParameters.ts) +- `result` is of type `byte[]` -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-deleteCustomRole) in API Explorer. +### ❗❗❗ Code sample above may not work -## listStates +Please refer to [Binary content downloading](/README.md#Binary-content-downloading). -List States +[Try it out](https://developer.ringcentral.com/api-reference#IVR-readIVRPromptContent) in API Explorer. -| Name | Value | -| ---------------- | ---------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/state` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +## createMessageStoreReport + +Create Message Store Report + +| Name | Value | +| ---------------- | ---------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/message-store-report` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadMessages` | +| User Permission | `Users` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().state().list(listStatesParameters); +var result = await rc.restapi(apiVersion).account(accountId).messageStoreReport().post(createMessageStoreReportRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- `listStatesParameters` is of type [ListStatesParameters](./definitions/ListStatesParameters.ts) -- `result` is of type [GetStateListResponse](./definitions/GetStateListResponse.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listStates) in API Explorer. +- Parameter `accountId` is optional with default value `~` +- `createMessageStoreReportRequest` is of type [CreateMessageStoreReportRequest](./definitions/CreateMessageStoreReportRequest.ts) +- `result` is of type [MessageStoreReport](./definitions/MessageStoreReport.ts) -## readState +[Try it out](https://developer.ringcentral.com/api-reference#Message-Exports-createMessageStoreReport) in API Explorer. -Get State +## readMessageStoreReportTask -| Name | Value | -| ---------------- | -------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/state/{stateId}` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +Get Message Store Report Task -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); +| Name | Value | +| ---------------- | ------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/message-store-report/{taskId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadMessages` | +| User Permission | `Users` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().state(stateId).get(); +var result = await rc.restapi(apiVersion).account(accountId).messageStoreReport(taskId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [GetStateInfoResponse](./definitions/GetStateInfoResponse.ts) +- Parameter `accountId` is optional with default value `~` +- `result` is of type [MessageStoreReport](./definitions/MessageStoreReport.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-readState) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Exports-readMessageStoreReportTask) in API Explorer. -## listGlipChatsNew +## listSites -List Chats +List Sites -| Name | Value | -| ---------------- | -------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/chats` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats().list(listGlipChatsNewParameters); +var result = await rc.restapi(apiVersion).account(accountId).sites().list(); await rc.revoke(); ``` -- `listGlipChatsNewParameters` is of type [ListGlipChatsNewParameters](./definitions/ListGlipChatsNewParameters.ts) -- `result` is of type [TMChatList](./definitions/TMChatList.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [SitesList](./definitions/SitesList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Chats-listGlipChatsNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-listSites) in API Explorer. -## readGlipChatNew +## createSite -Get Chat +Create Site -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/chats/{chatId}` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).get(); +var result = await rc.restapi(apiVersion).account(accountId).sites().post(createSiteRequest); await rc.revoke(); ``` -- `result` is of type [TMChatInfo](./definitions/TMChatInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `createSiteRequest` is of type [CreateSiteRequest](./definitions/CreateSiteRequest.ts) +- `result` is of type [SiteInfo](./definitions/SiteInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Chats-readGlipChatNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-createSite) in API Explorer. -## readGlipEventsNew +## readSite -List User Events +Get Site -| Name | Value | -| ---------------- | --------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/events` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().events().list(readGlipEventsNewParameters); +var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).get(); await rc.revoke(); ``` -- `readGlipEventsNewParameters` is of type [ReadGlipEventsNewParameters](./definitions/ReadGlipEventsNewParameters.ts) -- `result` is of type [TMEventList](./definitions/TMEventList.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [SiteInfo](./definitions/SiteInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-readGlipEventsNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-readSite) in API Explorer. -## createEventNew +## updateSite -Create Event +Update Site -| Name | Value | -| ---------------- | --------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/events` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}` | +| Rate Limit Group | `Light` | +| App Permission | `EditExtensions` | +| User Permission | `Sites` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().events().post(tMCreateEventRequest); +var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).put(siteUpdateRequest); await rc.revoke(); ``` -- `tMCreateEventRequest` is of type [TMCreateEventRequest](./definitions/TMCreateEventRequest.ts) -- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `siteUpdateRequest` is of type [SiteUpdateRequest](./definitions/SiteUpdateRequest.ts) +- `result` is of type [SiteInfo](./definitions/SiteInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-createEventNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-updateSite) in API Explorer. -## readEventNew +## deleteSite -Get Event +Delete Site -| Name | Value | -| ---------------- | ------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/events/{eventId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}` | +| Rate Limit Group | `Light` | +| App Permission | `EditAccounts` | +| User Permission | `Sites` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().events(eventId).get(); +var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).delete(); await rc.revoke(); ``` -- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-readEventNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-deleteSite) in API Explorer. -## updateEventNew +## assignMultipleSites -Update Event +Edit Sites -| Name | Value | -| ---------------- | ------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/team-messaging/v1/events/{eventId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}/bulk-assign` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `Sites` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().events(eventId).put(tMCreateEventRequest); +var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).bulkAssign().post(siteMembersBulkUpdate); await rc.revoke(); ``` -- `tMCreateEventRequest` is of type [TMCreateEventRequest](./definitions/TMCreateEventRequest.ts) -- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `siteMembersBulkUpdate` is of type [SiteMembersBulkUpdate](./definitions/SiteMembersBulkUpdate.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-updateEventNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-assignMultipleSites) in API Explorer. -## deleteEventNew +## createCallOutCallSession -Delete Event +Make CallOut -| Name | Value | -| ---------------- | ------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/team-messaging/v1/events/{eventId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/call-out` | +| Rate Limit Group | `Heavy` | +| App Permission | `CallControl` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().events(eventId).delete(); +var result = await rc.restapi(apiVersion).account(accountId).telephony().callOut().post(makeCallOutRequest); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `makeCallOutRequest` is of type [MakeCallOutRequest](./definitions/MakeCallOutRequest.ts) +- `result` is of type [CallSession](./definitions/CallSession.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-deleteEventNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-createCallOutCallSession) in API Explorer. -## createGlipFileNew +## createConferenceCallSession -Upload File +Start Conference Call Session -| Name | Value | -| ---------------- | -------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/files` | -| Rate Limit Group | `Heavy` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/conference` | +| Rate Limit Group | `Heavy` | +| App Permission | `CallControl` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().files().post(createGlipFileNewRequest, createGlipFileNewParameters); +var result = await rc.restapi(apiVersion).account(accountId).telephony().conference().post(); await rc.revoke(); ``` -- `createGlipFileNewRequest` is of type [CreateGlipFileNewRequest](./definitions/CreateGlipFileNewRequest.ts) -- `createGlipFileNewParameters` is of type [CreateGlipFileNewParameters](./definitions/CreateGlipFileNewParameters.ts) -- `result` is of type [TMAddFileRequest](./definitions/TMAddFileRequest.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [CallSession](./definitions/CallSession.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Posts-createGlipFileNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-createConferenceCallSession) in API Explorer. -## readUserNoteNew +## readCallSessionStatus -Get Note +Get Call Session Status -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/notes/{noteId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}` | +| Rate Limit Group | `Light` | +| App Permission | `CallControl` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().notes(noteId).get(); -await rc.revoke(); -``` +var result = await rc + .restapi(apiVersion) + .account(accountId) + .telephony() + .sessions(telephonySessionId) + .get(readCallSessionStatusParameters); +await rc.revoke(); +``` -- `result` is of type [TMNoteWithBodyInfo](./definitions/TMNoteWithBodyInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `readCallSessionStatusParameters` is of type [ReadCallSessionStatusParameters](./definitions/ReadCallSessionStatusParameters.ts) +- `result` is of type [CallSessionObject](./definitions/CallSessionObject.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Notes-readUserNoteNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-readCallSessionStatus) in API Explorer. -## deleteNoteNew +## deleteCallSession -Delete Note +Drop Call Session -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/team-messaging/v1/notes/{noteId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}` | +| Rate Limit Group | `Light` | +| App Permission | `CallControl` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().notes(noteId).delete(); +var result = await rc.restapi(apiVersion).account(accountId).telephony().sessions(telephonySessionId).delete(); await rc.revoke(); ``` +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` - `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Notes-deleteNoteNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-deleteCallSession) in API Explorer. -## patchNoteNew +## readDefaultRole -Update Note +Get Default User Role -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/team-messaging/v1/notes/{noteId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/default` | +| Rate Limit Group | `Light` | +| App Permission | `RoleManagement` | +| User Permission | `Roles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().notes(noteId).patch(tMCreateNoteRequest, patchNoteNewParameters); +var result = await rc.restapi(apiVersion).account(accountId).userRole().default().get(); await rc.revoke(); ``` -- `tMCreateNoteRequest` is of type [TMCreateNoteRequest](./definitions/TMCreateNoteRequest.ts) -- `patchNoteNewParameters` is of type [PatchNoteNewParameters](./definitions/PatchNoteNewParameters.ts) -- `result` is of type [TMNoteInfo](./definitions/TMNoteInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [DefaultUserRole](./definitions/DefaultUserRole.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Notes-patchNoteNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-readDefaultRole) in API Explorer. -## readTaskNew +## updateDefaultUserRole -Get Task +Set Default User Role -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/tasks/{taskId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/default` | +| Rate Limit Group | `Medium` | +| App Permission | `RoleManagement` | +| User Permission | `Roles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().tasks(taskId).get(); +var result = await rc.restapi(apiVersion).account(accountId).userRole().default().put(defaultUserRoleRequest); await rc.revoke(); ``` -- `result` is of type [TMTaskInfo](./definitions/TMTaskInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `defaultUserRoleRequest` is of type [DefaultUserRoleRequest](./definitions/DefaultUserRoleRequest.ts) +- `result` is of type [DefaultUserRole](./definitions/DefaultUserRole.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Tasks-readTaskNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-updateDefaultUserRole) in API Explorer. -## deleteTaskNew +## assignMultipleUserRoles -Delete Task +Assign Multiple User Roles -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/team-messaging/v1/tasks/{taskId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/{roleId}/bulk-assign` | +| Rate Limit Group | `Heavy` | +| App Permission | `RoleManagement` | +| User Permission | `EditUserRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().tasks(taskId).delete(); +var result = await rc.restapi(apiVersion).account(accountId).userRole(roleId).bulkAssign().post(bulkRoleAssignResource); await rc.revoke(); ``` +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `bulkRoleAssignResource` is of type [BulkRoleAssignResource](./definitions/BulkRoleAssignResource.ts) - `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Tasks-deleteTaskNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-assignMultipleUserRoles) in API Explorer. -## patchTaskNew +## createSIPRegistration -Update Task +Register Device -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/team-messaging/v1/tasks/{taskId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/client-info/sip-provision` | +| Rate Limit Group | `Heavy` | +| App Permission | `VoipCalling` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().tasks(taskId).patch(tMUpdateTaskRequest); +var result = await rc.restapi(apiVersion).clientInfo().sipProvision().post(createSipRegistrationRequest); await rc.revoke(); ``` -- `tMUpdateTaskRequest` is of type [TMUpdateTaskRequest](./definitions/TMUpdateTaskRequest.ts) -- `result` is of type [TMTaskList](./definitions/TMTaskList.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- `createSipRegistrationRequest` is of type [CreateSipRegistrationRequest](./definitions/CreateSipRegistrationRequest.ts) +- `result` is of type [CreateSipRegistrationResponse](./definitions/CreateSipRegistrationResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Tasks-patchTaskNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Device-SIP-Registration-createSIPRegistration) in API Explorer. -## listGlipTeamsNew +## listFaxCoverPages -List Teams +List Fax Cover Pages -| Name | Value | -| ---------------- | -------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/teams` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/fax-cover-page` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams().list(listGlipTeamsNewParameters); +var result = await rc.restapi(apiVersion).dictionary().faxCoverPage().get(listFaxCoverPagesParameters); await rc.revoke(); ``` -- `listGlipTeamsNewParameters` is of type [ListGlipTeamsNewParameters](./definitions/ListGlipTeamsNewParameters.ts) -- `result` is of type [TMTeamList](./definitions/TMTeamList.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- `listFaxCoverPagesParameters` is of type [ListFaxCoverPagesParameters](./definitions/ListFaxCoverPagesParameters.ts) +- `result` is of type [ListFaxCoverPagesResponse](./definitions/ListFaxCoverPagesResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-listGlipTeamsNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Fax-listFaxCoverPages) in API Explorer. -## createGlipTeamNew +## listSubscriptions -Create Team +List Subscriptions -| Name | Value | -| ---------------- | -------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/teams` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/subscription` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams().post(tMCreateTeamRequest); +var result = await rc.restapi(apiVersion).subscription().list(); await rc.revoke(); ``` -- `tMCreateTeamRequest` is of type [TMCreateTeamRequest](./definitions/TMCreateTeamRequest.ts) -- `result` is of type [TMTeamInfo](./definitions/TMTeamInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- `result` is of type [SubscriptionListResource](./definitions/SubscriptionListResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-createGlipTeamNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-listSubscriptions) in API Explorer. -## readGlipTeamNew +## createSubscription -Get Team +Create Subscription -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/teams/{chatId}` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------ | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/subscription` | +| Rate Limit Group | `Medium` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).get(); +var result = await rc.restapi(apiVersion).subscription().post(createSubscriptionRequest); await rc.revoke(); ``` -- `result` is of type [TMTeamInfo](./definitions/TMTeamInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- `createSubscriptionRequest` is of type [CreateSubscriptionRequest](./definitions/CreateSubscriptionRequest.ts) +- `result` is of type [SubscriptionInfo](./definitions/SubscriptionInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-readGlipTeamNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-createSubscription) in API Explorer. -## deleteGlipTeamNew +## readSubscription -Delete Team +Get Subscription -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/team-messaging/v1/teams/{chatId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/subscription/{subscriptionId}` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).delete(); +var result = await rc.restapi(apiVersion).subscription(subscriptionId).get(); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- `result` is of type [SubscriptionInfo](./definitions/SubscriptionInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-deleteGlipTeamNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-readSubscription) in API Explorer. -## patchGlipTeamNew +## updateSubscription -Update Team +Update Subscription -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/team-messaging/v1/teams/{chatId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/subscription/{subscriptionId}` | +| Rate Limit Group | `Medium` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).patch(tMUpdateTeamRequest); +var result = await rc.restapi(apiVersion).subscription(subscriptionId).put(updateSubscriptionRequest); await rc.revoke(); ``` -- `tMUpdateTeamRequest` is of type [TMUpdateTeamRequest](./definitions/TMUpdateTeamRequest.ts) -- `result` is of type [TMTeamInfo](./definitions/TMTeamInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- `updateSubscriptionRequest` is of type [UpdateSubscriptionRequest](./definitions/UpdateSubscriptionRequest.ts) +- `result` is of type [SubscriptionInfo](./definitions/SubscriptionInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-patchGlipTeamNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-updateSubscription) in API Explorer. -## readGlipPersonNew +## deleteSubscription -Get Person +Cancel Subscription -| Name | Value | -| ---------------- | --------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/persons/{personId}` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/subscription/{subscriptionId}` | +| Rate Limit Group | `Medium` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().persons(personId).get(); +var result = await rc.restapi(apiVersion).subscription(subscriptionId).delete(); await rc.revoke(); ``` -- `result` is of type [TMPersonInfo](./definitions/TMPersonInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Profile-readGlipPersonNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-deleteSubscription) in API Explorer. -## caiPunctuate +## scimSearchViaPost2 -Smart Punctuation +Search/List Users -| Name | Value | -| ---------------- | ----------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/ai/text/v1/async/punctuate` | -| Rate Limit Group | `Heavy` | -| App Permission | `AI` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/scim/{version}/Users/dotSearch` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.ai().text().v1().async().punctuate().post(punctuateInput, caiPunctuateParameters); +var result = await rc.scim(version).users().dotSearch().post(scimSearchRequest); await rc.revoke(); ``` -- `punctuateInput` is of type [PunctuateInput](./definitions/PunctuateInput.ts) -- `caiPunctuateParameters` is of type [CaiPunctuateParameters](./definitions/CaiPunctuateParameters.ts) -- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) +- Parameter `version` is optional with default value `v2` +- `scimSearchRequest` is of type [ScimSearchRequest](./definitions/ScimSearchRequest.ts) +- `result` is of type [ScimUserSearchResponse](./definitions/ScimUserSearchResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Text-caiPunctuate) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#SCIM-scimSearchViaPost2) in API Explorer. -## caiSummarize +## authorize -Conversational Summarization +OAuth 2.0 Authorization Endpoint -| Name | Value | -| ---------------- | ----------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/ai/text/v1/async/summarize` | -| Rate Limit Group | `Heavy` | -| App Permission | `AI` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/oauth/authorize` | +| Rate Limit Group | `Auth` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.ai().text().v1().async().summarize().post(summaryInput, caiSummarizeParameters); +var result = await rc.restapi().oauth().authorize().get(authorizeParameters); await rc.revoke(); ``` -- `summaryInput` is of type [SummaryInput](./definitions/SummaryInput.ts) -- `caiSummarizeParameters` is of type [CaiSummarizeParameters](./definitions/CaiSummarizeParameters.ts) -- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) +- `authorizeParameters` is of type [AuthorizeParameters](./definitions/AuthorizeParameters.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Text-caiSummarize) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#OAuth-and-OpenID-Connect-authorize) in API Explorer. -## listVideoMeetings +## authorize2 -List Video Meetings +OAuth 2.0 Authorization Endpoint (POST) -| Name | Value | -| ---------------- | ------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/rcvideo/v1/history/meetings` | -| Rate Limit Group | `Light` | -| App Permission | `Video` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/oauth/authorize` | +| Rate Limit Group | `Auth` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.rcvideo().v1().history().meetings().list(listVideoMeetingsParameters); +var result = await rc.restapi().oauth().authorize().post(authorizeRequest); await rc.revoke(); ``` -- `listVideoMeetingsParameters` is of type [ListVideoMeetingsParameters](./definitions/ListVideoMeetingsParameters.ts) -- `result` is of type [MeetingPage](./definitions/MeetingPage.ts) +- `authorizeRequest` is of type [AuthorizeRequest](./definitions/AuthorizeRequest.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Meetings-History-listVideoMeetings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#OAuth-and-OpenID-Connect-authorize2) in API Explorer. -## getVideoMeeting +## readCompanyCallLog -Get Video Meeting +List Company Call Records -| Name | Value | -| ---------------- | ------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/rcvideo/v1/history/meetings/{meetingId}` | -| Rate Limit Group | `Light` | -| App Permission | `Video` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-log` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallLog` | +| User Permission | `FullCompanyCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.rcvideo().v1().history().meetings(meetingId).get(); +var result = await rc.restapi(apiVersion).account(accountId).callLog().list(readCompanyCallLogParameters); await rc.revoke(); ``` -- `result` is of type [Meeting](./definitions/Meeting.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `readCompanyCallLogParameters` is of type [ReadCompanyCallLogParameters](./definitions/ReadCompanyCallLogParameters.ts) +- `result` is of type [CallLogResponse](./definitions/CallLogResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Meetings-History-getVideoMeeting) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-readCompanyCallLog) in API Explorer. -## getBridgeByPstnPin +## readCompanyCallRecord -Search Bridge by PSTN PIN +Get Company Call Record(s) -| Name | Value | -| ---------------- | ------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/rcvideo/v2/bridges/pin/pstn/{pin}` | -| Rate Limit Group | `Medium` | -| App Permission | `Video` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-log/{callRecordId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallLog` | +| User Permission | `FullCompanyCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.rcvideo().v2().bridges().pin().pstn(pin).get(getBridgeByPstnPinParameters); +var result = await rc.restapi(apiVersion).account(accountId).callLog(callRecordId).get(readCompanyCallRecordParameters); await rc.revoke(); ``` -- `getBridgeByPstnPinParameters` is of type [GetBridgeByPstnPinParameters](./definitions/GetBridgeByPstnPinParameters.ts) -- `result` is of type [BridgeResponse](./definitions/BridgeResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `readCompanyCallRecordParameters` is of type [ReadCompanyCallRecordParameters](./definitions/ReadCompanyCallRecordParameters.ts) +- `result` is of type [CallLogRecord](./definitions/CallLogRecord.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Bridge-Management-getBridgeByPstnPin) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-readCompanyCallRecord) in API Explorer. -## getBridgeByWebPin +## listExtensions -Search Bridge by Web PIN +List Extensions -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/rcvideo/v2/bridges/pin/web/{pin}` | -| Rate Limit Group | `Medium` | -| App Permission | `Video` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.rcvideo().v2().bridges().pin().web(pin).get(getBridgeByWebPinParameters); +var result = await rc.restapi(apiVersion).account(accountId).extension().list(listExtensionsParameters); await rc.revoke(); ``` -- `getBridgeByWebPinParameters` is of type [GetBridgeByWebPinParameters](./definitions/GetBridgeByWebPinParameters.ts) -- `result` is of type [BridgeResponse](./definitions/BridgeResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `listExtensionsParameters` is of type [ListExtensionsParameters](./definitions/ListExtensionsParameters.ts) +- `result` is of type [GetExtensionListResponse](./definitions/GetExtensionListResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Bridge-Management-getBridgeByWebPin) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Extensions-listExtensions) in API Explorer. -## removeLineJWSPublic +## createExtension -Remove Phone Line +Create Extension | Name | Value | | ---------------- | ----------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/v2/accounts/{accountId}/devices/{deviceId}` | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension` | | Rate Limit Group | `Medium` | | App Permission | `EditAccounts` | -| User Permission | `EditAccountDevices` | +| User Permission | `AddRemoveUsers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).devices(deviceId).delete(removeLineRequest); +var result = await rc.restapi(apiVersion).account(accountId).extension().post(extensionCreationRequest); await rc.revoke(); ``` -- `removeLineRequest` is of type [RemoveLineRequest](./definitions/RemoveLineRequest.ts) -- `result` is of type [RemoveLineResponse](./definitions/RemoveLineResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `extensionCreationRequest` is of type [ExtensionCreationRequest](./definitions/ExtensionCreationRequest.ts) +- `result` is of type [ExtensionCreationResponse](./definitions/ExtensionCreationResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Devices-removeLineJWSPublic) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Extensions-createExtension) in API Explorer. -## listCompanyActiveCalls +## readExtension -List Company Active Calls +Get Extension -| Name | Value | -| ---------------- | -------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/active-calls` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallLog` | -| User Permission | `ReadCallLog` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).activeCalls().get(listCompanyActiveCallsParameters); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `listCompanyActiveCallsParameters` is of type [ListCompanyActiveCallsParameters](./definitions/ListCompanyActiveCallsParameters.ts) -- `result` is of type [CallLogResponse](./definitions/CallLogResponse.ts) +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [GetExtensionInfoResponse](./definitions/GetExtensionInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-listCompanyActiveCalls) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readExtension) in API Explorer. -## listCallQueues +## updateExtension -List Call Queues +Update Extension -| Name | Value | -| ---------------- | ------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserInfo OR EditUserCredentials` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callQueues().list(listCallQueuesParameters); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).put(extensionUpdateRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `listCallQueuesParameters` is of type [ListCallQueuesParameters](./definitions/ListCallQueuesParameters.ts) -- `result` is of type [CallQueueList](./definitions/CallQueueList.ts) +- Parameter `extensionId` is optional with default value `~` +- `extensionUpdateRequest` is of type [ExtensionUpdateRequest](./definitions/ExtensionUpdateRequest.ts) +- `result` is of type [GetExtensionInfoResponse](./definitions/GetExtensionInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-listCallQueues) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateExtension) in API Explorer. -## readCallQueueInfo +## createCompanyGreeting -Get Call Queue +Create Company Greeting -| Name | Value | -| ---------------- | ----------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ---------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/greeting` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `ReadUserInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callQueues(groupId).get(); +var result = await rc.restapi(apiVersion).account(accountId).greeting().post(createCompanyGreetingRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [CallQueueDetails](./definitions/CallQueueDetails.ts) +- `createCompanyGreetingRequest` is of type [CreateCompanyGreetingRequest](./definitions/CreateCompanyGreetingRequest.ts) +- `result` is of type [CustomCompanyGreetingInfo](./definitions/CustomCompanyGreetingInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-readCallQueueInfo) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Greetings-createCompanyGreeting) in API Explorer. -## updateCallQueueInfo +## readIVRMenuList -Update Call Queue +Get IVR Menu list -| Name | Value | -| ---------------- | ----------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}` | -| Rate Limit Group | `Light` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserInfo` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-menus` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callQueues(groupId).put(callQueueDetailsForUpdate); +var result = await rc.restapi(apiVersion).account(accountId).ivrMenus().list(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `callQueueDetailsForUpdate` is of type [CallQueueDetailsForUpdate](./definitions/CallQueueDetailsForUpdate.ts) -- `result` is of type [CallQueueDetails](./definitions/CallQueueDetails.ts) +- `result` is of type [IVRMenuList](./definitions/IVRMenuList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-updateCallQueueInfo) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-readIVRMenuList) in API Explorer. -## listCustomFields +## createIVRMenu -Get Custom Field List +Create IVR Menu -| Name | Value | -| ---------------- | --------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/custom-fields` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadUserInfo` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-menus` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `AutoReceptionist` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).customFields().get(); +var result = await rc.restapi(apiVersion).account(accountId).ivrMenus().post(iVRMenuInfo); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [CustomFieldList](./definitions/CustomFieldList.ts) +- `iVRMenuInfo` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) +- `result` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Custom-Fields-listCustomFields) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-createIVRMenu) in API Explorer. -## createCustomField +## readIVRMenu -Create Custom Field +Get IVR Menu -| Name | Value | -| ---------------- | --------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/custom-fields` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `Users` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-menus/{ivrMenuId}` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `AutoReceptionist` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).customFields().post(customFieldCreateRequest); +var result = await rc.restapi(apiVersion).account(accountId).ivrMenus(ivrMenuId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `customFieldCreateRequest` is of type [CustomFieldCreateRequest](./definitions/CustomFieldCreateRequest.ts) -- `result` is of type [CustomFieldModel](./definitions/CustomFieldModel.ts) +- `result` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Custom-Fields-createCustomField) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-readIVRMenu) in API Explorer. -## updateCustomField +## updateIVRMenu -Update Custom Field +Update IVR Menu -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/custom-fields/{fieldId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `Users` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-menus/{ivrMenuId}` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `AutoReceptionist` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).customFields(fieldId).put(customFieldUpdateRequest); +var result = await rc.restapi(apiVersion).account(accountId).ivrMenus(ivrMenuId).put(iVRMenuInfo); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `customFieldUpdateRequest` is of type [CustomFieldUpdateRequest](./definitions/CustomFieldUpdateRequest.ts) -- `result` is of type [CustomFieldModel](./definitions/CustomFieldModel.ts) +- `iVRMenuInfo` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) +- `result` is of type [IVRMenuInfo](./definitions/IVRMenuInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Custom-Fields-updateCustomField) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-updateIVRMenu) in API Explorer. -## deleteCustomField +## readAccountPresence -Delete Custom Field +Get User Presence Status List -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/custom-fields/{fieldId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `Users` | +| Name | Value | +| ---------------- | ---------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/presence` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadPresence` | +| User Permission | `ReadPresenceStatus` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).customFields(fieldId).delete(); +var result = await rc.restapi(apiVersion).account(accountId).presence().get(readAccountPresenceParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is an empty string +- `readAccountPresenceParameters` is of type [ReadAccountPresenceParameters](./definitions/ReadAccountPresenceParameters.ts) +- `result` is of type [AccountPresenceInfo](./definitions/AccountPresenceInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Custom-Fields-deleteCustomField) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Presence-readAccountPresence) in API Explorer. -## createFaxMessage +## readCallRecording -Create Fax Message +Get Call Recording -| Name | Value | -| ---------------- | ----------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/fax` | -| Rate Limit Group | `Heavy` | -| App Permission | `Faxes` | -| User Permission | `OutboundFaxes` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/recording/{recordingId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallRecording` | +| User Permission | `ReadCallRecording` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).fax().post(createFaxMessageRequest); +var result = await rc.restapi(apiVersion).account(accountId).recording(recordingId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `createFaxMessageRequest` is of type [CreateFaxMessageRequest](./definitions/CreateFaxMessageRequest.ts) -- `result` is of type [FaxResponse](./definitions/FaxResponse.ts) +- `result` is of type [GetCallRecordingResponse](./definitions/GetCallRecordingResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Fax-createFaxMessage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recordings-readCallRecording) in API Explorer. -## createMMS +## readSiteIvrSettings -Send MMS +Get Site IVR Settings -| Name | Value | -| ---------------- | ----------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/mms` | -| Rate Limit Group | `Medium` | -| App Permission | `SMS` | -| User Permission | `OutboundSMS` | +| Name | Value | +| ---------------- | -------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}/ivr` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).mms().post(createMMSMessage); +var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).ivr().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `createMMSMessage` is of type [CreateMMSMessage](./definitions/CreateMMSMessage.ts) -- `result` is of type [GetSMSMessageInfoResponse](./definitions/GetSMSMessageInfoResponse.ts) +- `result` is of type [SiteIVRSettings](./definitions/SiteIVRSettings.ts) -[Try it out](https://developer.ringcentral.com/api-reference#SMS-createMMS) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-readSiteIvrSettings) in API Explorer. -## createSMSMessage +## updateSiteIvrSettings -Send SMS +Update Site IVR Settings -| Name | Value | -| ---------------- | ----------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/sms` | -| Rate Limit Group | `Medium` | -| App Permission | `SMS` | -| User Permission | `OutboundSMS` | +| Name | Value | +| ---------------- | -------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}/ivr` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `Sites` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).sms().post(createSMSMessage); +var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).ivr().put(siteIVRSettingsUpdate); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `createSMSMessage` is of type [CreateSMSMessage](./definitions/CreateSMSMessage.ts) -- `result` is of type [GetSMSMessageInfoResponse](./definitions/GetSMSMessageInfoResponse.ts) +- `siteIVRSettingsUpdate` is of type [SiteIVRSettingsUpdate](./definitions/SiteIVRSettingsUpdate.ts) +- `result` is of type [SiteIVRSettings](./definitions/SiteIVRSettings.ts) -[Try it out](https://developer.ringcentral.com/api-reference#SMS-createSMSMessage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-updateSiteIvrSettings) in API Explorer. -## listIvrPrompts +## listUserTemplates -List IVR Prompts +List User Templates -| Name | Value | -| ---------------- | ------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyGreetings` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/templates` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts().list(); +var result = await rc.restapi(apiVersion).account(accountId).templates().list(listUserTemplatesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [IvrPrompts](./definitions/IvrPrompts.ts) +- `listUserTemplatesParameters` is of type [ListUserTemplatesParameters](./definitions/ListUserTemplatesParameters.ts) +- `result` is of type [UserTemplates](./definitions/UserTemplates.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-listIvrPrompts) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Extensions-listUserTemplates) in API Explorer. -## createIVRPrompt +## readUserTemplate -Create IVR Prompts +Get User Template -| Name | Value | -| ---------------- | ------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyGreetings` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/templates/{templateId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts().post(createIVRPromptRequest); +var result = await rc.restapi(apiVersion).account(accountId).templates(templateId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `createIVRPromptRequest` is of type [CreateIVRPromptRequest](./definitions/CreateIVRPromptRequest.ts) -- `result` is of type [PromptInfo](./definitions/PromptInfo.ts) +- `result` is of type [TemplateInfo](./definitions/TemplateInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-createIVRPrompt) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Extensions-readUserTemplate) in API Explorer. -## readIVRPrompt +## listUserRoles -Get IVR Prompt +List Company User Roles -| Name | Value | -| ---------------- | ------------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts/{promptId}` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyGreetings` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadUserRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts(promptId).get(); +var result = await rc.restapi(apiVersion).account(accountId).userRole().list(listUserRolesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [PromptInfo](./definitions/PromptInfo.ts) +- `listUserRolesParameters` is of type [ListUserRolesParameters](./definitions/ListUserRolesParameters.ts) +- `result` is of type [RolesCollectionResource](./definitions/RolesCollectionResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-readIVRPrompt) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listUserRoles) in API Explorer. -## updateIVRPrompt +## createCustomRole -Update IVR Prompt +Create Custom Role -| Name | Value | -| ---------------- | ------------------------------------------------------------------ | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts/{promptId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyGreetings` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role` | +| Rate Limit Group | `Medium` | +| App Permission | `RoleManagement` | +| User Permission | `EditUserRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts(promptId).put(updateIVRPromptRequest); +var result = await rc.restapi(apiVersion).account(accountId).userRole().post(roleResource); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `updateIVRPromptRequest` is of type [UpdateIVRPromptRequest](./definitions/UpdateIVRPromptRequest.ts) -- `result` is of type [PromptInfo](./definitions/PromptInfo.ts) +- `roleResource` is of type [RoleResource](./definitions/RoleResource.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#IVR-updateIVRPrompt) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-createCustomRole) in API Explorer. -## deleteIVRPrompt +## readUserRole -Delete IVR Prompt +Get User Role -| Name | Value | -| ---------------- | ------------------------------------------------------------------ | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts/{promptId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyGreetings` | +| Name | Value | +| ---------------- | -------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/{roleId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadUserRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts(promptId).delete(); +var result = await rc.restapi(apiVersion).account(accountId).userRole(roleId).get(readUserRoleParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is an empty string +- `readUserRoleParameters` is of type [ReadUserRoleParameters](./definitions/ReadUserRoleParameters.ts) +- `result` is of type [RoleResource](./definitions/RoleResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-deleteIVRPrompt) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-readUserRole) in API Explorer. -## listAccountPhoneNumbers +## updateUserRole -List Company Phone Numbers +Update User Role -| Name | Value | -| ---------------- | -------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/phone-number` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyPhoneNumbers` | +| Name | Value | +| ---------------- | -------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/{roleId}` | +| Rate Limit Group | `Medium` | +| App Permission | `RoleManagement` | +| User Permission | `EditUserRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).phoneNumber().list(listAccountPhoneNumbersParameters); +var result = await rc.restapi(apiVersion).account(accountId).userRole(roleId).put(roleResource); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `listAccountPhoneNumbersParameters` is of type [ListAccountPhoneNumbersParameters](./definitions/ListAccountPhoneNumbersParameters.ts) -- `result` is of type [AccountPhoneNumbers](./definitions/AccountPhoneNumbers.ts) +- `roleResource` is of type [RoleResource](./definitions/RoleResource.ts) +- `result` is of type [RoleResource](./definitions/RoleResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-listAccountPhoneNumbers) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-updateUserRole) in API Explorer. -## readAccountPhoneNumber +## deleteCustomRole -Get Phone Number +Delete Custom Role -| Name | Value | -| ---------------- | ------------------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/phone-number/{phoneNumberId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyPhoneNumbers` | +| Name | Value | +| ---------------- | -------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/{roleId}` | +| Rate Limit Group | `Medium` | +| App Permission | `RoleManagement` | +| User Permission | `EditUserRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).phoneNumber(phoneNumberId).get(); +var result = await rc.restapi(apiVersion).account(accountId).userRole(roleId).delete(deleteCustomRoleParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `result` is of type [CompanyPhoneNumberInfo](./definitions/CompanyPhoneNumberInfo.ts) +- `deleteCustomRoleParameters` is of type [DeleteCustomRoleParameters](./definitions/DeleteCustomRoleParameters.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-readAccountPhoneNumber) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-deleteCustomRole) in API Explorer. -## readAccountServiceInfo +## listStates -Get Account Service Info +List States -| Name | Value | -| ---------------- | -------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/service-info` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | ---------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/state` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).serviceInfo().get(); +var result = await rc.restapi(apiVersion).dictionary().state().list(listStatesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [AccountServiceInfo](./definitions/AccountServiceInfo.ts) +- `listStatesParameters` is of type [ListStatesParameters](./definitions/ListStatesParameters.ts) +- `result` is of type [GetStateListResponse](./definitions/GetStateListResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Company-readAccountServiceInfo) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listStates) in API Explorer. -## listSiteMembers +## readState -List Site Members +Get State -| Name | Value | -| ---------------- | ------------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}/members` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | -------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/state/{stateId}` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).members().get(); +var result = await rc.restapi(apiVersion).dictionary().state(stateId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [SiteMembersList](./definitions/SiteMembersList.ts) +- `result` is of type [GetStateInfoResponse](./definitions/GetStateInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-listSiteMembers) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-readState) in API Explorer. -## listCountries +## listGlipChatsNew -List Countries +List Chats -| Name | Value | -| ---------------- | ------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/country` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/chats` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().country().list(listCountriesParameters); +var result = await rc.teamMessaging().v1().chats().list(listGlipChatsNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `listCountriesParameters` is of type [ListCountriesParameters](./definitions/ListCountriesParameters.ts) -- `result` is of type [CountryListDictionaryModel](./definitions/CountryListDictionaryModel.ts) +- `listGlipChatsNewParameters` is of type [ListGlipChatsNewParameters](./definitions/ListGlipChatsNewParameters.ts) +- `result` is of type [TMChatList](./definitions/TMChatList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listCountries) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Chats-listGlipChatsNew) in API Explorer. -## readCountry +## readGlipChatNew -Get Country +Get Chat -| Name | Value | -| ---------------- | ------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/country/{countryId}` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/chats/{chatId}` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().country(countryId).get(); +var result = await rc.teamMessaging().v1().chats(chatId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [CountryInfoDictionaryModel](./definitions/CountryInfoDictionaryModel.ts) +- `result` is of type [TMChatInfo](./definitions/TMChatInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-readCountry) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Chats-readGlipChatNew) in API Explorer. -## listStandardGreetings +## readGlipEventsNew -List Standard Greetings +List User Events -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/greeting` | -| Rate Limit Group | `Medium` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/events` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().greeting().list(listStandardGreetingsParameters); +var result = await rc.teamMessaging().v1().events().list(readGlipEventsNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `listStandardGreetingsParameters` is of type [ListStandardGreetingsParameters](./definitions/ListStandardGreetingsParameters.ts) -- `result` is of type [DictionaryGreetingList](./definitions/DictionaryGreetingList.ts) +- `readGlipEventsNewParameters` is of type [ReadGlipEventsNewParameters](./definitions/ReadGlipEventsNewParameters.ts) +- `result` is of type [TMEventList](./definitions/TMEventList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Greetings-listStandardGreetings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-readGlipEventsNew) in API Explorer. -## readStandardGreeting +## createEventNew -Get Standard Greeting +Create Event -| Name | Value | -| ---------------- | -------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/greeting/{greetingId}` | -| Rate Limit Group | `Medium` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/events` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().greeting(greetingId).get(); +var result = await rc.teamMessaging().v1().events().post(tMCreateEventRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [DictionaryGreetingInfo](./definitions/DictionaryGreetingInfo.ts) +- `tMCreateEventRequest` is of type [TMCreateEventRequest](./definitions/TMCreateEventRequest.ts) +- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Greetings-readStandardGreeting) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-createEventNew) in API Explorer. -## listLanguages +## readEventNew -List Languages +Get Event -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/language` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/events/{eventId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().language().list(); +var result = await rc.teamMessaging().v1().events(eventId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [LanguageList](./definitions/LanguageList.ts) +- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listLanguages) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-readEventNew) in API Explorer. -## readLanguage +## updateEventNew -Get Language +Update Event -| Name | Value | -| ---------------- | -------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/language/{languageId}` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/team-messaging/v1/events/{eventId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().language(languageId).get(); +var result = await rc.teamMessaging().v1().events(eventId).put(tMCreateEventRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [LanguageInfo](./definitions/LanguageInfo.ts) +- `tMCreateEventRequest` is of type [TMCreateEventRequest](./definitions/TMCreateEventRequest.ts) +- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-readLanguage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-updateEventNew) in API Explorer. -## listLocations +## deleteEventNew -List Locations +Delete Event -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/location` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/team-messaging/v1/events/{eventId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().location().get(listLocationsParameters); +var result = await rc.teamMessaging().v1().events(eventId).delete(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `listLocationsParameters` is of type [ListLocationsParameters](./definitions/ListLocationsParameters.ts) -- `result` is of type [GetLocationListResponse](./definitions/GetLocationListResponse.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listLocations) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-deleteEventNew) in API Explorer. -## listTimezones +## createGlipFileNew -List Timezones +Upload File -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/timezone` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/files` | +| Rate Limit Group | `Heavy` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().timezone().list(listTimezonesParameters); +var result = await rc.teamMessaging().v1().files().post(createGlipFileNewRequest, createGlipFileNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `listTimezonesParameters` is of type [ListTimezonesParameters](./definitions/ListTimezonesParameters.ts) -- `result` is of type [GetTimezoneListResponse](./definitions/GetTimezoneListResponse.ts) +- `createGlipFileNewRequest` is of type [CreateGlipFileNewRequest](./definitions/CreateGlipFileNewRequest.ts) +- `createGlipFileNewParameters` is of type [CreateGlipFileNewParameters](./definitions/CreateGlipFileNewParameters.ts) +- `result` is of type [TMAddFileRequest](./definitions/TMAddFileRequest.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listTimezones) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Posts-createGlipFileNew) in API Explorer. -## readTimezone +## readUserNoteNew -Get Timezone +Get Note -| Name | Value | -| ---------------- | -------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/timezone/{timezoneId}` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/notes/{noteId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().timezone(timezoneId).get(); +var result = await rc.teamMessaging().v1().notes(noteId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [GetTimezoneInfoResponse](./definitions/GetTimezoneInfoResponse.ts) +- `result` is of type [TMNoteWithBodyInfo](./definitions/TMNoteWithBodyInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-readTimezone) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Notes-readUserNoteNew) in API Explorer. -## listStandardUserRole +## deleteNoteNew -List Standard User Roles +Delete Note -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/user-role` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/team-messaging/v1/notes/{noteId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().userRole().list(listStandardUserRoleParameters); +var result = await rc.teamMessaging().v1().notes(noteId).delete(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `listStandardUserRoleParameters` is of type [ListStandardUserRoleParameters](./definitions/ListStandardUserRoleParameters.ts) -- `result` is of type [RolesCollectionResource](./definitions/RolesCollectionResource.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listStandardUserRole) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Notes-deleteNoteNew) in API Explorer. -## readStandardUserRole +## patchNoteNew -Get Standard User Role +Update Note -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/user-role/{roleId}` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/team-messaging/v1/notes/{noteId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().userRole(roleId).get(); +var result = await rc.teamMessaging().v1().notes(noteId).patch(tMCreateNoteRequest, patchNoteNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [RoleResource](./definitions/RoleResource.ts) +- `tMCreateNoteRequest` is of type [TMCreateNoteRequest](./definitions/TMCreateNoteRequest.ts) +- `patchNoteNewParameters` is of type [PatchNoteNewParameters](./definitions/PatchNoteNewParameters.ts) +- `result` is of type [TMNoteInfo](./definitions/TMNoteInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-readStandardUserRole) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Notes-patchNoteNew) in API Explorer. -## parsePhoneNumber +## readTaskNew -Parse Phone Number(s) +Get Task -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/number-parser/parse` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/tasks/{taskId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .numberParser() - .parse() - .post(parsePhoneNumberRequest, parsePhoneNumberParameters); +var result = await rc.teamMessaging().v1().tasks(taskId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `parsePhoneNumberRequest` is of type [ParsePhoneNumberRequest](./definitions/ParsePhoneNumberRequest.ts) -- `parsePhoneNumberParameters` is of type [ParsePhoneNumberParameters](./definitions/ParsePhoneNumberParameters.ts) -- `result` is of type [ParsePhoneNumberResponse](./definitions/ParsePhoneNumberResponse.ts) +- `result` is of type [TMTaskInfo](./definitions/TMTaskInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-parsePhoneNumber) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Tasks-readTaskNew) in API Explorer. -## renewSubscription +## deleteTaskNew -Renew Subscription +Delete Task -| Name | Value | -| ---------------- | ----------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/subscription/{subscriptionId}/renew` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/team-messaging/v1/tasks/{taskId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).subscription(subscriptionId).renew().post(); +var result = await rc.teamMessaging().v1().tasks(taskId).delete(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [SubscriptionInfo](./definitions/SubscriptionInfo.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-renewSubscription) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Tasks-deleteTaskNew) in API Explorer. -## scimGetProviderConfig2 +## patchTaskNew -Get Provider Config +Update Task -| Name | Value | -| ---------------- | --------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/scim/{version}/ServiceProviderConfig` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/team-messaging/v1/tasks/{taskId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.scim(version).serviceProviderConfig().get(); +var result = await rc.teamMessaging().v1().tasks(taskId).patch(tMUpdateTaskRequest); await rc.revoke(); ``` -- Parameter `version` is optional with default value `v2` -- `result` is of type [ScimProviderConfig](./definitions/ScimProviderConfig.ts) +- `tMUpdateTaskRequest` is of type [TMUpdateTaskRequest](./definitions/TMUpdateTaskRequest.ts) +- `result` is of type [TMTaskList](./definitions/TMTaskList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#SCIM-scimGetProviderConfig2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Tasks-patchTaskNew) in API Explorer. -## readTMCompanyInfoNew +## listGlipTeamsNew -Get Company Info +List Teams -| Name | Value | -| ---------------- | ------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/companies/{companyId}` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/teams` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().companies(companyId).get(); +var result = await rc.teamMessaging().v1().teams().list(listGlipTeamsNewParameters); await rc.revoke(); ``` -- `result` is of type [TMCompanyInfo](./definitions/TMCompanyInfo.ts) +- `listGlipTeamsNewParameters` is of type [ListGlipTeamsNewParameters](./definitions/ListGlipTeamsNewParameters.ts) +- `result` is of type [TMTeamList](./definitions/TMTeamList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Profile-readTMCompanyInfoNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-listGlipTeamsNew) in API Explorer. -## readGlipEveryoneNew +## createGlipTeamNew -Get Everyone Chat +Create Team -| Name | Value | -| ---------------- | ----------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/everyone` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/teams` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().everyone().get(); +var result = await rc.teamMessaging().v1().teams().post(tMCreateTeamRequest); await rc.revoke(); ``` -- `result` is of type [EveryoneTeamInfo](./definitions/EveryoneTeamInfo.ts) +- `tMCreateTeamRequest` is of type [TMCreateTeamRequest](./definitions/TMCreateTeamRequest.ts) +- `result` is of type [TMTeamInfo](./definitions/TMTeamInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-readGlipEveryoneNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-createGlipTeamNew) in API Explorer. -## patchGlipEveryoneNew +## readGlipTeamNew -Update Everyone Chat +Get Team -| Name | Value | -| ---------------- | ----------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/team-messaging/v1/everyone` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/teams/{chatId}` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().everyone().patch(updateEveryoneTeamRequest); +var result = await rc.teamMessaging().v1().teams(chatId).get(); await rc.revoke(); ``` -- `updateEveryoneTeamRequest` is of type [UpdateEveryoneTeamRequest](./definitions/UpdateEveryoneTeamRequest.ts) -- `result` is of type [EveryoneTeamInfo](./definitions/EveryoneTeamInfo.ts) +- `result` is of type [TMTeamInfo](./definitions/TMTeamInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-patchGlipEveryoneNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-readGlipTeamNew) in API Explorer. -## listFavoriteChatsNew +## deleteGlipTeamNew -List Favorite Chats +Delete Team -| Name | Value | -| ---------------- | ------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/favorites` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/team-messaging/v1/teams/{chatId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().favorites().get(listFavoriteChatsNewParameters); +var result = await rc.teamMessaging().v1().teams(chatId).delete(); await rc.revoke(); ``` -- `listFavoriteChatsNewParameters` is of type [ListFavoriteChatsNewParameters](./definitions/ListFavoriteChatsNewParameters.ts) -- `result` is of type [TMChatListWithoutNavigation](./definitions/TMChatListWithoutNavigation.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Chats-listFavoriteChatsNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-deleteGlipTeamNew) in API Explorer. -## lockNoteNew +## patchGlipTeamNew -Lock Note +Update Team -| Name | Value | -| ---------------- | ---------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/notes/{noteId}/lock` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/team-messaging/v1/teams/{chatId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().notes(noteId).lock().post(); +var result = await rc.teamMessaging().v1().teams(chatId).patch(tMUpdateTeamRequest); await rc.revoke(); ``` -- `result` is an empty string +- `tMUpdateTeamRequest` is of type [TMUpdateTeamRequest](./definitions/TMUpdateTeamRequest.ts) +- `result` is of type [TMTeamInfo](./definitions/TMTeamInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Notes-lockNoteNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-patchGlipTeamNew) in API Explorer. -## joinGlipTeamNew +## readGlipPersonNew -Join Team +Get Person -| Name | Value | -| ---------------- | ---------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/teams/{chatId}/join` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/persons/{personId}` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).join().post(); +var result = await rc.teamMessaging().v1().persons(personId).get(); await rc.revoke(); ``` -- `result` is an empty string +- `result` is of type [TMPersonInfo](./definitions/TMPersonInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-joinGlipTeamNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Profile-readGlipPersonNew) in API Explorer. -## listGlipWebhooksNew +## caiPunctuate -List Webhooks +Smart Punctuation | Name | Value | | ---------------- | ----------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/webhooks` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | +| HTTP Method | `POST` | +| Endpoint | `/ai/text/v1/async/punctuate` | +| Rate Limit Group | `Heavy` | +| App Permission | `AI` | | User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().webhooks().list(); +var result = await rc.ai().text().v1().async().punctuate().post(punctuateInput, caiPunctuateParameters); await rc.revoke(); ``` -- `result` is of type [TMWebhookList](./definitions/TMWebhookList.ts) +- `punctuateInput` is of type [PunctuateInput](./definitions/PunctuateInput.ts) +- `caiPunctuateParameters` is of type [CaiPunctuateParameters](./definitions/CaiPunctuateParameters.ts) +- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-listGlipWebhooksNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Text-caiPunctuate) in API Explorer. -## readGlipWebhookNew - -Get Webhook - -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/webhooks/{webhookId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().webhooks(webhookId).get(); -await rc.revoke(); -``` - -- `result` is of type [TMWebhookList](./definitions/TMWebhookList.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-readGlipWebhookNew) in API Explorer. - -## deleteGlipWebhookNew - -Delete Webhook - -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/team-messaging/v1/webhooks/{webhookId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().webhooks(webhookId).delete(); -await rc.revoke(); -``` - -- `result` is an empty string - -[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-deleteGlipWebhookNew) in API Explorer. - -## addGlipTeamMembersNew +## caiSummarize -Add Team Members +Conversational Summarization -| Name | Value | -| ---------------- | --------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/teams/{chatId}/add` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/ai/text/v1/async/summarize` | +| Rate Limit Group | `Heavy` | +| App Permission | `AI` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).add().post(tMAddTeamMembersRequest); +var result = await rc.ai().text().v1().async().summarize().post(summaryInput, caiSummarizeParameters); await rc.revoke(); ``` -- `tMAddTeamMembersRequest` is of type [TMAddTeamMembersRequest](./definitions/TMAddTeamMembersRequest.ts) -- `result` is an empty string +- `summaryInput` is of type [SummaryInput](./definitions/SummaryInput.ts) +- `caiSummarizeParameters` is of type [CaiSummarizeParameters](./definitions/CaiSummarizeParameters.ts) +- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-addGlipTeamMembersNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Text-caiSummarize) in API Explorer. -## rcwHistoryListAllSessions +## listVideoMeetings -List Historical Webinar Sessions across Multiple Webinars +List Video Meetings | Name | Value | | ---------------- | ------------------------------ | | HTTP Method | `GET` | -| Endpoint | `/webinar/history/v1/sessions` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | +| Endpoint | `/rcvideo/v1/history/meetings` | +| Rate Limit Group | `Light` | +| App Permission | `Video` | | User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().history().v1().sessions().get(rcwHistoryListAllSessionsParameters); +var result = await rc.rcvideo().v1().history().meetings().list(listVideoMeetingsParameters); await rc.revoke(); ``` -- `rcwHistoryListAllSessionsParameters` is of type [RcwHistoryListAllSessionsParameters](./definitions/RcwHistoryListAllSessionsParameters.ts) -- `result` is of type [SessionGlobalListResource](./definitions/SessionGlobalListResource.ts) +- `listVideoMeetingsParameters` is of type [ListVideoMeetingsParameters](./definitions/ListVideoMeetingsParameters.ts) +- `result` is of type [MeetingPage](./definitions/MeetingPage.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryListAllSessions) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Meetings-History-listVideoMeetings) in API Explorer. -## rcwHistoryGetWebinar +## getVideoMeeting -Get Historical Webinar +Get Video Meeting | Name | Value | | ---------------- | ------------------------------------------ | | HTTP Method | `GET` | -| Endpoint | `/webinar/history/v1/webinars/{webinarId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | +| Endpoint | `/rcvideo/v1/history/meetings/{meetingId}` | +| Rate Limit Group | `Light` | +| App Permission | `Video` | | User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().history().v1().webinars(webinarId).get(); +var result = await rc.rcvideo().v1().history().meetings(meetingId).get(); await rc.revoke(); ``` -- `result` is of type [WebinarResource](./definitions/WebinarResource.ts) +- `result` is of type [Meeting](./definitions/Meeting.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryGetWebinar) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Meetings-History-getVideoMeeting) in API Explorer. -## caiSpeakerDiarize +## getBridgeByPstnPin -Speaker Diarization +Search Bridge by PSTN PIN | Name | Value | | ---------------- | ------------------------------------ | -| HTTP Method | `POST` | -| Endpoint | `/ai/audio/v1/async/speaker-diarize` | -| Rate Limit Group | `Heavy` | -| App Permission | `AI` | +| HTTP Method | `GET` | +| Endpoint | `/rcvideo/v2/bridges/pin/pstn/{pin}` | +| Rate Limit Group | `Medium` | +| App Permission | `Video` | | User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.ai().audio().v1().async().speakerDiarize().post(diarizeInput, caiSpeakerDiarizeParameters); +var result = await rc.rcvideo().v2().bridges().pin().pstn(pin).get(getBridgeByPstnPinParameters); await rc.revoke(); ``` -- `diarizeInput` is of type [DiarizeInput](./definitions/DiarizeInput.ts) -- `caiSpeakerDiarizeParameters` is of type [CaiSpeakerDiarizeParameters](./definitions/CaiSpeakerDiarizeParameters.ts) -- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) +- `getBridgeByPstnPinParameters` is of type [GetBridgeByPstnPinParameters](./definitions/GetBridgeByPstnPinParameters.ts) +- `result` is of type [BridgeResponse](./definitions/BridgeResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Audio-caiSpeakerDiarize) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Bridge-Management-getBridgeByPstnPin) in API Explorer. -## caiSpeakerIdentify +## getBridgeByWebPin -Speaker Identification +Search Bridge by Web PIN -| Name | Value | -| ---------------- | ------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/ai/audio/v1/async/speaker-identify` | -| Rate Limit Group | `Heavy` | -| App Permission | `AI` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/rcvideo/v2/bridges/pin/web/{pin}` | +| Rate Limit Group | `Medium` | +| App Permission | `Video` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.ai().audio().v1().async().speakerIdentify().post(identifyInput, caiSpeakerIdentifyParameters); +var result = await rc.rcvideo().v2().bridges().pin().web(pin).get(getBridgeByWebPinParameters); await rc.revoke(); ``` -- `identifyInput` is of type [IdentifyInput](./definitions/IdentifyInput.ts) -- `caiSpeakerIdentifyParameters` is of type [CaiSpeakerIdentifyParameters](./definitions/CaiSpeakerIdentifyParameters.ts) -- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) +- `getBridgeByWebPinParameters` is of type [GetBridgeByWebPinParameters](./definitions/GetBridgeByWebPinParameters.ts) +- `result` is of type [BridgeResponse](./definitions/BridgeResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Audio-caiSpeakerIdentify) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Bridge-Management-getBridgeByWebPin) in API Explorer. -## caiSpeechToText +## removeLineJWSPublic -Speech to Text Conversion +Remove Phone Line -| Name | Value | -| ---------------- | ----------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/ai/audio/v1/async/speech-to-text` | -| Rate Limit Group | `Heavy` | -| App Permission | `AI` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/v2/accounts/{accountId}/devices/{deviceId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditAccountDevices` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.ai().audio().v1().async().speechToText().post(asrInput, caiSpeechToTextParameters); +var result = await rc.restapi().v2().accounts(accountId).devices(deviceId).delete(removeLineRequest); await rc.revoke(); ``` -- `asrInput` is of type [AsrInput](./definitions/AsrInput.ts) -- `caiSpeechToTextParameters` is of type [CaiSpeechToTextParameters](./definitions/CaiSpeechToTextParameters.ts) -- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) +- `removeLineRequest` is of type [RemoveLineRequest](./definitions/RemoveLineRequest.ts) +- `result` is of type [RemoveLineResponse](./definitions/RemoveLineResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Audio-caiSpeechToText) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Devices-removeLineJWSPublic) in API Explorer. -## caiAnalyzeInteraction +## listCompanyActiveCalls -Interaction Analytics +List Company Active Calls -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/ai/insights/v1/async/analyze-interaction` | -| Rate Limit Group | `Heavy` | -| App Permission | `AI` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/active-calls` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallLog` | +| User Permission | `ReadCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .ai() - .insights() - .v1() - .async() - .analyzeInteraction() - .post(interactionInput, caiAnalyzeInteractionParameters); +var result = await rc.restapi(apiVersion).account(accountId).activeCalls().get(listCompanyActiveCallsParameters); await rc.revoke(); ``` -- `interactionInput` is of type [InteractionInput](./definitions/InteractionInput.ts) -- `caiAnalyzeInteractionParameters` is of type [CaiAnalyzeInteractionParameters](./definitions/CaiAnalyzeInteractionParameters.ts) -- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `listCompanyActiveCallsParameters` is of type [ListCompanyActiveCallsParameters](./definitions/ListCompanyActiveCallsParameters.ts) +- `result` is of type [CallLogResponse](./definitions/CallLogResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Insights-caiAnalyzeInteraction) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-listCompanyActiveCalls) in API Explorer. -## listSocialMessagingContents +## listCallQueues -List Contents +List Call Queues -| Name | Value | -| ---------------- | ---------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/cx/social-messaging/v1/contents` | -| Rate Limit Group | `Light` | -| App Permission | `SocialMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.cx().socialMessaging().v1().contents().list(listSocialMessagingContentsParameters); +var result = await rc.restapi(apiVersion).account(accountId).callQueues().list(listCallQueuesParameters); await rc.revoke(); ``` -- `listSocialMessagingContentsParameters` is of type [ListSocialMessagingContentsParameters](./definitions/ListSocialMessagingContentsParameters.ts) -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `listCallQueuesParameters` is of type [ListCallQueuesParameters](./definitions/ListCallQueuesParameters.ts) +- `result` is of type [CallQueueList](./definitions/CallQueueList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Contents-listSocialMessagingContents) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-listCallQueues) in API Explorer. -## createSocialMessagingContent +## readCallQueueInfo -Create Content +Get Call Queue -| Name | Value | -| ---------------- | ---------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/cx/social-messaging/v1/contents` | -| Rate Limit Group | `Light` | -| App Permission | `SocialMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.cx().socialMessaging().v1().contents().post(createSocialMessagingContentRequest); +var result = await rc.restapi(apiVersion).account(accountId).callQueues(groupId).get(); await rc.revoke(); ``` -- `createSocialMessagingContentRequest` is of type [CreateSocialMessagingContentRequest](./definitions/CreateSocialMessagingContentRequest.ts) -- `result` is an empty string - -[Try it out](https://developer.ringcentral.com/api-reference#Contents-createSocialMessagingContent) in API Explorer. - -## readSocialMessagingContent +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [CallQueueDetails](./definitions/CallQueueDetails.ts) -Get Content +[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-readCallQueueInfo) in API Explorer. -| Name | Value | -| ---------------- | ---------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/cx/social-messaging/v1/contents/{contentId}` | -| Rate Limit Group | `Light` | -| App Permission | `SocialMessaging` | -| User Permission | `N/A` | +## updateCallQueueInfo + +Update Call Queue + +| Name | Value | +| ---------------- | ----------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}` | +| Rate Limit Group | `Light` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.cx().socialMessaging().v1().contents(contentId).get(); +var result = await rc.restapi(apiVersion).account(accountId).callQueues(groupId).put(callQueueDetailsForUpdate); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `callQueueDetailsForUpdate` is of type [CallQueueDetailsForUpdate](./definitions/CallQueueDetailsForUpdate.ts) +- `result` is of type [CallQueueDetails](./definitions/CallQueueDetails.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Contents-readSocialMessagingContent) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-updateCallQueueInfo) in API Explorer. -## listSocialMessagingIdentities +## listCustomFields -List Identities +Get Custom Field List -| Name | Value | -| ---------------- | ------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/cx/social-messaging/v1/identities` | -| Rate Limit Group | `Light` | -| App Permission | `SocialMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/custom-fields` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadUserInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.cx().socialMessaging().v1().identities().list(listSocialMessagingIdentitiesParameters); +var result = await rc.restapi(apiVersion).account(accountId).customFields().get(); await rc.revoke(); ``` -- `listSocialMessagingIdentitiesParameters` is of type [ListSocialMessagingIdentitiesParameters](./definitions/ListSocialMessagingIdentitiesParameters.ts) -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [CustomFieldList](./definitions/CustomFieldList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Identities-listSocialMessagingIdentities) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Custom-Fields-listCustomFields) in API Explorer. -## readSocialMessagingIdentity +## createCustomField -Get Identity +Create Custom Field -| Name | Value | -| ---------------- | ------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/cx/social-messaging/v1/identities/{identityId}` | -| Rate Limit Group | `Light` | -| App Permission | `SocialMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/custom-fields` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `Users` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.cx().socialMessaging().v1().identities(identityId).get(); +var result = await rc.restapi(apiVersion).account(accountId).customFields().post(customFieldCreateRequest); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `customFieldCreateRequest` is of type [CustomFieldCreateRequest](./definitions/CustomFieldCreateRequest.ts) +- `result` is of type [CustomFieldModel](./definitions/CustomFieldModel.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Identities-readSocialMessagingIdentity) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Custom-Fields-createCustomField) in API Explorer. -## getExtensionRecordings +## updateCustomField -List User Recordings +Update Custom Field -| Name | Value | -| ---------------- | -------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/rcvideo/v1/account/{accountId}/extension/{extensionId}/recordings` | -| Rate Limit Group | `Light` | -| App Permission | `Video` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/custom-fields/{fieldId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `Users` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .rcvideo() - .v1() - .account(accountId) - .extension(extensionId) - .recordings() - .get(getExtensionRecordingsParameters); +var result = await rc.restapi(apiVersion).account(accountId).customFields(fieldId).put(customFieldUpdateRequest); await rc.revoke(); ``` +- Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `getExtensionRecordingsParameters` is of type [GetExtensionRecordingsParameters](./definitions/GetExtensionRecordingsParameters.ts) -- `result` is of type [CloudRecordings](./definitions/CloudRecordings.ts) +- `customFieldUpdateRequest` is of type [CustomFieldUpdateRequest](./definitions/CustomFieldUpdateRequest.ts) +- `result` is of type [CustomFieldModel](./definitions/CustomFieldModel.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Meeting-Recordings-getExtensionRecordings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Custom-Fields-updateCustomField) in API Explorer. -## getAccountRecordings +## deleteCustomField -List Account Recordings +Delete Custom Field -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/rcvideo/v1/account/{accountId}/recordings` | -| Rate Limit Group | `Light` | -| App Permission | `Video` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/custom-fields/{fieldId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `Users` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.rcvideo().v1().account(accountId).recordings().get(getAccountRecordingsParameters); +var result = await rc.restapi(apiVersion).account(accountId).customFields(fieldId).delete(); await rc.revoke(); ``` +- Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `getAccountRecordingsParameters` is of type [GetAccountRecordingsParameters](./definitions/GetAccountRecordingsParameters.ts) -- `result` is of type [CloudRecordings](./definitions/CloudRecordings.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Meeting-Recordings-getAccountRecordings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Custom-Fields-deleteCustomField) in API Explorer. -## rcvListDelegators +## createFaxMessage -Get Delegators +Create Fax Message -| Name | Value | -| ---------------- | ---------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/rcvideo/v1/accounts/{accountId}/extensions/{extensionId}/delegators` | -| Rate Limit Group | `Medium` | -| App Permission | `Video` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/fax` | +| Rate Limit Group | `Heavy` | +| App Permission | `Faxes` | +| User Permission | `OutboundFaxes` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.rcvideo().v1().accounts(accountId).extensions(extensionId).delegators().get(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).fax().post(createFaxMessageRequest); await rc.revoke(); ``` -- `result` is of type [DelegatorsListResult](./definitions/DelegatorsListResult.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `createFaxMessageRequest` is of type [CreateFaxMessageRequest](./definitions/CreateFaxMessageRequest.ts) +- `result` is of type [FaxResponse](./definitions/FaxResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Delegation-Management-rcvListDelegators) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Fax-createFaxMessage) in API Explorer. -## createBridge +## createMMS -Create Bridge +Send MMS -| Name | Value | -| ---------------- | ----------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/rcvideo/v2/account/{accountId}/extension/{extensionId}/bridges` | -| Rate Limit Group | `Heavy` | -| App Permission | `Video` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/mms` | +| Rate Limit Group | `Medium` | +| App Permission | `SMS` | +| User Permission | `OutboundSMS` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.rcvideo().v2().account(accountId).extension(extensionId).bridges().post(createBridgeRequest); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).mms().post(createMMSMessage); await rc.revoke(); ``` +- Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `createBridgeRequest` is of type [CreateBridgeRequest](./definitions/CreateBridgeRequest.ts) -- `result` is of type [BridgeResponse](./definitions/BridgeResponse.ts) +- `createMMSMessage` is of type [CreateMMSMessage](./definitions/CreateMMSMessage.ts) +- `result` is of type [GetSMSMessageInfoResponse](./definitions/GetSMSMessageInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Bridge-Management-createBridge) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#SMS-createMMS) in API Explorer. -## listCostCenters +## createSMSMessage -List Cost Centers +Send SMS -| Name | Value | -| ---------------- | ----------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/v2/accounts/{accountId}/cost-centers` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `CostCenterManagement` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/sms` | +| Rate Limit Group | `Medium` | +| App Permission | `SMS` | +| User Permission | `OutboundSMS` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).costCenters().get(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).sms().post(createSMSMessage); await rc.revoke(); ``` -- `result` is of type [CostCenterList](./definitions/CostCenterList.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `createSMSMessage` is of type [CreateSMSMessage](./definitions/CreateSMSMessage.ts) +- `result` is of type [GetSMSMessageInfoResponse](./definitions/GetSMSMessageInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Cost-Centers-listCostCenters) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#SMS-createSMSMessage) in API Explorer. -## addDeviceToInventory +## listIvrPrompts -Add Phone to Inventory +List IVR Prompts -| Name | Value | -| ---------------- | --------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/v2/accounts/{accountId}/device-inventory` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyGreetings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).deviceInventory().post(addDeviceToInventoryRequest); +var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts().list(); await rc.revoke(); ``` -- `addDeviceToInventoryRequest` is of type [AddDeviceToInventoryRequest](./definitions/AddDeviceToInventoryRequest.ts) -- `result` is of type [AddDeviceToInventoryResponse](./definitions/AddDeviceToInventoryResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [IvrPrompts](./definitions/IvrPrompts.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Devices-addDeviceToInventory) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-listIvrPrompts) in API Explorer. -## deleteDeviceFromInventory +## createIVRPrompt -Delete Device from Inventory +Create IVR Prompts -| Name | Value | -| ---------------- | --------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/v2/accounts/{accountId}/device-inventory` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyGreetings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).deviceInventory().delete(deleteDeviceFromInventoryRequest); +var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts().post(createIVRPromptRequest); await rc.revoke(); ``` -- `deleteDeviceFromInventoryRequest` is of type [DeleteDeviceFromInventoryRequest](./definitions/DeleteDeviceFromInventoryRequest.ts) -- `result` is of type [DeleteDeviceFromInventoryResponse](./definitions/DeleteDeviceFromInventoryResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `createIVRPromptRequest` is of type [CreateIVRPromptRequest](./definitions/CreateIVRPromptRequest.ts) +- `result` is of type [PromptInfo](./definitions/PromptInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Devices-deleteDeviceFromInventory) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-createIVRPrompt) in API Explorer. -## bulkAddDevicesV2 +## readIVRPrompt -Add BYOD Devices +Get IVR Prompt -| Name | Value | -| ---------------- | --------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/v2/accounts/{accountId}/devices/bulk-add` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `AddRemoveDevices` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts/{promptId}` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyGreetings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).devices().bulkAdd().post(bulkAddDevicesRequest); +var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts(promptId).get(); await rc.revoke(); ``` -- `bulkAddDevicesRequest` is of type [BulkAddDevicesRequest](./definitions/BulkAddDevicesRequest.ts) -- `result` is of type [BulkAddDevicesResponse](./definitions/BulkAddDevicesResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [PromptInfo](./definitions/PromptInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Devices-bulkAddDevicesV2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-readIVRPrompt) in API Explorer. -## bulkDeleteUsersV2 +## updateIVRPrompt -Delete User Extensions +Update IVR Prompt -| Name | Value | -| ---------------- | --------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/v2/accounts/{accountId}/extensions` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `Users` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------ | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts/{promptId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyGreetings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).extensions().delete(bulkDeleteUsersRequest); +var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts(promptId).put(updateIVRPromptRequest); await rc.revoke(); ``` -- `bulkDeleteUsersRequest` is of type [BulkDeleteUsersRequest](./definitions/BulkDeleteUsersRequest.ts) -- `result` is of type [BulkDeleteUsersResponse](./definitions/BulkDeleteUsersResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `updateIVRPromptRequest` is of type [UpdateIVRPromptRequest](./definitions/UpdateIVRPromptRequest.ts) +- `result` is of type [PromptInfo](./definitions/PromptInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-bulkDeleteUsersV2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-updateIVRPrompt) in API Explorer. -## listAccountPhoneNumbersV2 +## deleteIVRPrompt -List Account Phone Numbers +Delete IVR Prompt -| Name | Value | -| ---------------- | ------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/v2/accounts/{accountId}/phone-numbers` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyPhoneNumbers` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------ | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts/{promptId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyGreetings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).phoneNumbers().get(listAccountPhoneNumbersV2Parameters); +var result = await rc.restapi(apiVersion).account(accountId).ivrPrompts(promptId).delete(); await rc.revoke(); ``` -- `listAccountPhoneNumbersV2Parameters` is of type [ListAccountPhoneNumbersV2Parameters](./definitions/ListAccountPhoneNumbersV2Parameters.ts) -- `result` is of type [AccountPhoneNumberList](./definitions/AccountPhoneNumberList.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-listAccountPhoneNumbersV2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#IVR-deleteIVRPrompt) in API Explorer. -## deleteNumbersFromInventoryV2 +## listAccountPhoneNumbers -Delete Numbers from Inventory +List Company Phone Numbers -| Name | Value | -| ---------------- | ------------------------------------------------ | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/v2/accounts/{accountId}/phone-numbers` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyPhoneNumbers` | +| Name | Value | +| ---------------- | -------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/phone-number` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyPhoneNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).phoneNumbers().delete(deletePhoneNumbersRequest); +var result = await rc.restapi(apiVersion).account(accountId).phoneNumber().list(listAccountPhoneNumbersParameters); await rc.revoke(); ``` -- `deletePhoneNumbersRequest` is of type [DeletePhoneNumbersRequest](./definitions/DeletePhoneNumbersRequest.ts) -- `result` is of type [DeletePhoneNumbersResponse](./definitions/DeletePhoneNumbersResponse.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `listAccountPhoneNumbersParameters` is of type [ListAccountPhoneNumbersParameters](./definitions/ListAccountPhoneNumbersParameters.ts) +- `result` is of type [AccountPhoneNumbers](./definitions/AccountPhoneNumbers.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-deleteNumbersFromInventoryV2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-listAccountPhoneNumbers) in API Explorer. -## assignPhoneNumberV2 +## readAccountPhoneNumber -Assign Phone Number +Get Phone Number -| Name | Value | -| ---------------- | ---------------------------------------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyPhoneNumbers` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/phone-number/{phoneNumberId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyPhoneNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).phoneNumbers(phoneNumberId).patch(assignPhoneNumberRequest); +var result = await rc.restapi(apiVersion).account(accountId).phoneNumber(phoneNumberId).get(); await rc.revoke(); ``` -- `assignPhoneNumberRequest` is of type [AssignPhoneNumberRequest](./definitions/AssignPhoneNumberRequest.ts) -- `result` is of type [AccountPhoneNumberInfo](./definitions/AccountPhoneNumberInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [CompanyPhoneNumberInfo](./definitions/CompanyPhoneNumberInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-assignPhoneNumberV2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-readAccountPhoneNumber) in API Explorer. -## replacePhoneNumberV2 +## readAccountServiceInfo -Replace Phone Number +Get Account Service Info -| Name | Value | -| ---------------- | ------------------------------------------------------------------------ | -| HTTP Method | `POST` | -| Endpoint | `/restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId}/replace` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyPhoneNumbers` | +| Name | Value | +| ---------------- | -------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/service-info` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi() - .v2() - .accounts(accountId) - .phoneNumbers(phoneNumberId) - .replace() - .post(replacePhoneNumberRequest); +var result = await rc.restapi(apiVersion).account(accountId).serviceInfo().get(); await rc.revoke(); ``` -- `replacePhoneNumberRequest` is of type [ReplacePhoneNumberRequest](./definitions/ReplacePhoneNumberRequest.ts) -- `result` is of type [AccountPhoneNumberInfo](./definitions/AccountPhoneNumberInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [AccountServiceInfo](./definitions/AccountServiceInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-replacePhoneNumberV2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Company-readAccountServiceInfo) in API Explorer. -## sendWelcomeEmailV2 +## listSiteMembers -Send/Resend Welcome Email +List Site Members -| Name | Value | -| ---------------- | ----------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/v2/accounts/{accountId}/send-welcome-email` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `Users` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}/members` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).sendWelcomeEmail().post(sendWelcomeEmailV2Request); +var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).members().get(); await rc.revoke(); ``` -- `sendWelcomeEmailV2Request` is of type [SendWelcomeEmailV2Request](./definitions/SendWelcomeEmailV2Request.ts) -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [SiteMembersList](./definitions/SiteMembersList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Company-sendWelcomeEmailV2) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-listSiteMembers) in API Explorer. -## listA2PBatches +## listCountries -List A2P SMS Batches +List Countries -| Name | Value | -| ---------------- | ----------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/batches` | -| Rate Limit Group | `Light` | -| App Permission | `A2PSMS` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/country` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).a2pSms().batches().list(listA2PBatchesParameters); +var result = await rc.restapi(apiVersion).dictionary().country().list(listCountriesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listA2PBatchesParameters` is of type [ListA2PBatchesParameters](./definitions/ListA2PBatchesParameters.ts) -- `result` is of type [BatchListResponse](./definitions/BatchListResponse.ts) +- `listCountriesParameters` is of type [ListCountriesParameters](./definitions/ListCountriesParameters.ts) +- `result` is of type [CountryListDictionaryModel](./definitions/CountryListDictionaryModel.ts) -[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-listA2PBatches) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listCountries) in API Explorer. -## createA2PSMS +## readCountry -Send A2P SMS +Get Country -| Name | Value | -| ---------------- | ----------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/batches` | -| Rate Limit Group | `Light` | -| App Permission | `A2PSMS` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/country/{countryId}` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).a2pSms().batches().post(messageBatchCreateRequest); +var result = await rc.restapi(apiVersion).dictionary().country(countryId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `messageBatchCreateRequest` is of type [MessageBatchCreateRequest](./definitions/MessageBatchCreateRequest.ts) -- `result` is of type [MessageBatchResponse](./definitions/MessageBatchResponse.ts) +- `result` is of type [CountryInfoDictionaryModel](./definitions/CountryInfoDictionaryModel.ts) -[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-createA2PSMS) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-readCountry) in API Explorer. -## readA2PBatch +## listStandardGreetings -Get A2P SMS Batch +List Standard Greetings -| Name | Value | -| ---------------- | --------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/batches/{batchId}` | -| Rate Limit Group | `Light` | -| App Permission | `A2PSMS` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/greeting` | +| Rate Limit Group | `Medium` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).a2pSms().batches(batchId).get(); +var result = await rc.restapi(apiVersion).dictionary().greeting().list(listStandardGreetingsParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [MessageBatchResponse](./definitions/MessageBatchResponse.ts) +- `listStandardGreetingsParameters` is of type [ListStandardGreetingsParameters](./definitions/ListStandardGreetingsParameters.ts) +- `result` is of type [DictionaryGreetingList](./definitions/DictionaryGreetingList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-readA2PBatch) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Greetings-listStandardGreetings) in API Explorer. -## listA2PSMS +## readStandardGreeting -List A2P SMS Messages +Get Standard Greeting -| Name | Value | -| ---------------- | ------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/messages` | -| Rate Limit Group | `Light` | -| App Permission | `A2PSMS` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/greeting/{greetingId}` | +| Rate Limit Group | `Medium` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).a2pSms().messages().list(listA2PSMSParameters); +var result = await rc.restapi(apiVersion).dictionary().greeting(greetingId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listA2PSMSParameters` is of type [ListA2PSMSParameters](./definitions/ListA2PSMSParameters.ts) -- `result` is of type [MessageListResponse](./definitions/MessageListResponse.ts) +- `result` is of type [DictionaryGreetingInfo](./definitions/DictionaryGreetingInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-listA2PSMS) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Greetings-readStandardGreeting) in API Explorer. -## readA2PSMS +## listLanguages -Get A2P SMS +List Languages -| Name | Value | -| ---------------- | ------------------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/messages/{messageId}` | -| Rate Limit Group | `Light` | -| App Permission | `A2PSMS` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/language` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).a2pSms().messages(messageId).get(); +var result = await rc.restapi(apiVersion).dictionary().language().list(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [MessageDetailsResponse](./definitions/MessageDetailsResponse.ts) +- `result` is of type [LanguageList](./definitions/LanguageList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-readA2PSMS) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listLanguages) in API Explorer. -## readA2PSMSOptOuts +## readLanguage -List Opted Out Numbers +Get Language -| Name | Value | -| ---------------- | ------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/opt-outs` | -| Rate Limit Group | `Light` | -| App Permission | `A2PSMS` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/language/{languageId}` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).a2pSms().optOuts().get(readA2PSMSOptOutsParameters); +var result = await rc.restapi(apiVersion).dictionary().language(languageId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readA2PSMSOptOutsParameters` is of type [ReadA2PSMSOptOutsParameters](./definitions/ReadA2PSMSOptOutsParameters.ts) -- `result` is of type [OptOutListResponse](./definitions/OptOutListResponse.ts) +- `result` is of type [LanguageInfo](./definitions/LanguageInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-readA2PSMSOptOuts) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-readLanguage) in API Explorer. -## aggregateA2PSMSStatuses +## listLocations -List A2P SMS Statuses +List Locations -| Name | Value | -| ---------------- | ------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/statuses` | -| Rate Limit Group | `Light` | -| App Permission | `A2PSMS` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/location` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).a2pSms().statuses().get(aggregateA2PSMSStatusesParameters); +var result = await rc.restapi(apiVersion).dictionary().location().get(listLocationsParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `aggregateA2PSMSStatusesParameters` is of type [AggregateA2PSMSStatusesParameters](./definitions/AggregateA2PSMSStatusesParameters.ts) -- `result` is of type [MessageStatusesResponse](./definitions/MessageStatusesResponse.ts) +- `listLocationsParameters` is of type [ListLocationsParameters](./definitions/ListLocationsParameters.ts) +- `result` is of type [GetLocationListResponse](./definitions/GetLocationListResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-aggregateA2PSMSStatuses) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listLocations) in API Explorer. -## addressBookBulkUpload +## listPermissions -Upload Multiple User Contacts +List Permissions -| Name | Value | -| ---------------- | -------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/address-book-bulk-upload` | -| Rate Limit Group | `Heavy` | -| App Permission | `Contacts` | -| User Permission | `EditPersonalContacts` | +| Name | Value | +| ---------------- | --------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/permission` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).addressBookBulkUpload().post(addressBookBulkUploadRequest); +var result = await rc.restapi(apiVersion).dictionary().permission().list(listPermissionsParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `addressBookBulkUploadRequest` is of type [AddressBookBulkUploadRequest](./definitions/AddressBookBulkUploadRequest.ts) -- `result` is of type [AddressBookBulkUploadResponse](./definitions/AddressBookBulkUploadResponse.ts) +- `listPermissionsParameters` is of type [ListPermissionsParameters](./definitions/ListPermissionsParameters.ts) +- `result` is of type [PermissionCollectionResource](./definitions/PermissionCollectionResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#External-Contacts-addressBookBulkUpload) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Permissions-listPermissions) in API Explorer. -## listCompanyAnsweringRules +## readPermission -List Company Call Handling Rules +Get Permission -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyAnsweringRules` | +| Name | Value | +| ---------------- | ------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/permission/{permissionId}` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).answeringRule().list(listCompanyAnsweringRulesParameters); +var result = await rc.restapi(apiVersion).dictionary().permission(permissionId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listCompanyAnsweringRulesParameters` is of type [ListCompanyAnsweringRulesParameters](./definitions/ListCompanyAnsweringRulesParameters.ts) -- `result` is of type [CompanyAnsweringRuleList](./definitions/CompanyAnsweringRuleList.ts) +- `result` is of type [PermissionResource](./definitions/PermissionResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-listCompanyAnsweringRules) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Permissions-readPermission) in API Explorer. -## createCompanyAnsweringRule +## listTimezones -Create Company Call Handling Rule +List Timezones -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyAnsweringRules` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/timezone` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).answeringRule().post(companyAnsweringRuleRequest); +var result = await rc.restapi(apiVersion).dictionary().timezone().list(listTimezonesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `companyAnsweringRuleRequest` is of type [CompanyAnsweringRuleRequest](./definitions/CompanyAnsweringRuleRequest.ts) -- `result` is of type [CompanyAnsweringRuleInfo](./definitions/CompanyAnsweringRuleInfo.ts) +- `listTimezonesParameters` is of type [ListTimezonesParameters](./definitions/ListTimezonesParameters.ts) +- `result` is of type [GetTimezoneListResponse](./definitions/GetTimezoneListResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-createCompanyAnsweringRule) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-listTimezones) in API Explorer. -## readCompanyAnsweringRule +## readTimezone -Get Company Call Handling Rule +Get Timezone -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule/{ruleId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyAnsweringRules` | +| Name | Value | +| ---------------- | -------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/timezone/{timezoneId}` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).answeringRule(ruleId).get(); +var result = await rc.restapi(apiVersion).dictionary().timezone(timezoneId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [CompanyAnsweringRuleInfo](./definitions/CompanyAnsweringRuleInfo.ts) +- `result` is of type [GetTimezoneInfoResponse](./definitions/GetTimezoneInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-readCompanyAnsweringRule) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Regional-Settings-readTimezone) in API Explorer. -## updateCompanyAnsweringRule +## listStandardUserRole -Update Company Call Handling Rule +List Standard User Roles -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule/{ruleId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyAnsweringRules` | +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/user-role` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).answeringRule(ruleId).put(companyAnsweringRuleUpdate); +var result = await rc.restapi(apiVersion).dictionary().userRole().list(listStandardUserRoleParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `companyAnsweringRuleUpdate` is of type [CompanyAnsweringRuleUpdate](./definitions/CompanyAnsweringRuleUpdate.ts) -- `result` is of type [CompanyAnsweringRuleInfo](./definitions/CompanyAnsweringRuleInfo.ts) +- `listStandardUserRoleParameters` is of type [ListStandardUserRoleParameters](./definitions/ListStandardUserRoleParameters.ts) +- `result` is of type [RolesCollectionResource](./definitions/RolesCollectionResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-updateCompanyAnsweringRule) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listStandardUserRole) in API Explorer. -## deleteCompanyAnsweringRule +## readStandardUserRole -Delete Company Call Handling Rule +Get Standard User Role -| Name | Value | -| ---------------- | ------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule/{ruleId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyAnsweringRules` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/dictionary/user-role/{roleId}` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).answeringRule(ruleId).delete(); +var result = await rc.restapi(apiVersion).dictionary().userRole(roleId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is an empty string +- `result` is of type [RoleResource](./definitions/RoleResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-deleteCompanyAnsweringRule) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-readStandardUserRole) in API Explorer. -## listAssignedRoles +## parsePhoneNumber -List Company Assigned Roles +Parse Phone Number(s) -| Name | Value | -| ---------------- | --------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/assigned-role` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadAssignedRoles` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/number-parser/parse` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).assignedRole().get(listAssignedRolesParameters); +var result = await rc + .restapi(apiVersion) + .numberParser() + .parse() + .post(parsePhoneNumberRequest, parsePhoneNumberParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listAssignedRolesParameters` is of type [ListAssignedRolesParameters](./definitions/ListAssignedRolesParameters.ts) -- `result` is of type [ExtensionWithRolesCollectionResource](./definitions/ExtensionWithRolesCollectionResource.ts) +- `parsePhoneNumberRequest` is of type [ParsePhoneNumberRequest](./definitions/ParsePhoneNumberRequest.ts) +- `parsePhoneNumberParameters` is of type [ParsePhoneNumberParameters](./definitions/ParsePhoneNumberParameters.ts) +- `result` is of type [ParsePhoneNumberResponse](./definitions/ParsePhoneNumberResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listAssignedRoles) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-parsePhoneNumber) in API Explorer. -## auditTrailSearch +## renewSubscription -Search Audit Trail Data +Renew Subscription -| Name | Value | -| ---------------- | -------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/audit-trail/search` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadAuditTrail` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/subscription/{subscriptionId}/renew` | +| Rate Limit Group | `Light` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .auditTrail() - .search() - .post(accountHistorySearchPublicRequest); +var result = await rc.restapi(apiVersion).subscription(subscriptionId).renew().post(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `accountHistorySearchPublicRequest` is of type [AccountHistorySearchPublicRequest](./definitions/AccountHistorySearchPublicRequest.ts) -- `result` is of type [AccountHistorySearchPublicResponse](./definitions/AccountHistorySearchPublicResponse.ts) +- `result` is of type [SubscriptionInfo](./definitions/SubscriptionInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Audit-Trail-auditTrailSearch) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Subscriptions-renewSubscription) in API Explorer. -## readAccountBusinessAddress +## scimGetProviderConfig2 -Get Account Business Address +Get Provider Config -| Name | Value | -| ---------------- | ------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/business-address` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | --------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/scim/{version}/ServiceProviderConfig` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).businessAddress().get(); +var result = await rc.scim(version).serviceProviderConfig().get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [AccountBusinessAddressResource](./definitions/AccountBusinessAddressResource.ts) +- Parameter `version` is optional with default value `v2` +- `result` is of type [ScimProviderConfig](./definitions/ScimProviderConfig.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Company-readAccountBusinessAddress) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#SCIM-scimGetProviderConfig2) in API Explorer. -## updateAccountBusinessAddress +## readGlipPostsNew -Update Company Business Address +List Posts -| Name | Value | -| ---------------- | ------------------------------------------------------------ | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/business-address` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyInfo` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/posts` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).businessAddress().put(modifyAccountBusinessAddressRequest); +var result = await rc.teamMessaging().v1().chats(chatId).posts().list(readGlipPostsNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `modifyAccountBusinessAddressRequest` is of type [ModifyAccountBusinessAddressRequest](./definitions/ModifyAccountBusinessAddressRequest.ts) -- `result` is of type [AccountBusinessAddressResource](./definitions/AccountBusinessAddressResource.ts) +- `readGlipPostsNewParameters` is of type [ReadGlipPostsNewParameters](./definitions/ReadGlipPostsNewParameters.ts) +- `result` is of type [TMPostsList](./definitions/TMPostsList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Company-updateAccountBusinessAddress) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Posts-readGlipPostsNew) in API Explorer. -## readCompanyBusinessHours +## createGlipPostNew -Get Company Business Hours +Create Post -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/business-hours` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyAnsweringRules` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/posts` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).businessHours().get(); +var result = await rc.teamMessaging().v1().chats(chatId).posts().post(tMCreatePostRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [CompanyBusinessHours](./definitions/CompanyBusinessHours.ts) +- `tMCreatePostRequest` is of type [TMCreatePostRequest](./definitions/TMCreatePostRequest.ts) +- `result` is of type [TMPostInfo](./definitions/TMPostInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Business-Hours-readCompanyBusinessHours) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Posts-createGlipPostNew) in API Explorer. -## updateCompanyBusinessHours +## readGlipPostNew -Update Company Business Hours +Get Post -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/business-hours` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserAnsweringRules` | +| Name | Value | +| ---------------- | -------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/posts/{postId}` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).businessHours().put(companyBusinessHoursUpdateRequest); +var result = await rc.teamMessaging().v1().chats(chatId).posts(postId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `companyBusinessHoursUpdateRequest` is of type [CompanyBusinessHoursUpdateRequest](./definitions/CompanyBusinessHoursUpdateRequest.ts) -- `result` is of type [CompanyBusinessHours](./definitions/CompanyBusinessHours.ts) +- `result` is of type [TMPostInfo](./definitions/TMPostInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Business-Hours-updateCompanyBusinessHours) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Posts-readGlipPostNew) in API Explorer. -## syncAccountCallLog +## deleteGlipPostNew -Sync Company Call Log +Delete Post -| Name | Value | -| ---------------- | --------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-log-sync` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallLog` | -| User Permission | `ReadCallLog` | +| Name | Value | +| ---------------- | -------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/posts/{postId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callLogSync().get(syncAccountCallLogParameters); +var result = await rc.teamMessaging().v1().chats(chatId).posts(postId).delete(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `syncAccountCallLogParameters` is of type [SyncAccountCallLogParameters](./definitions/SyncAccountCallLogParameters.ts) -- `result` is of type [CallLogSyncResponse](./definitions/CallLogSyncResponse.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-syncAccountCallLog) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Posts-deleteGlipPostNew) in API Explorer. -## listCallMonitoringGroups +## patchGlipPostNew -List Call Monitoring Groups +Update Post -| Name | Value | -| ---------------- | ------------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | -------------------------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/posts/{postId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callMonitoringGroups() - .get(listCallMonitoringGroupsParameters); +var result = await rc.teamMessaging().v1().chats(chatId).posts(postId).patch(tMUpdatePostRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listCallMonitoringGroupsParameters` is of type [ListCallMonitoringGroupsParameters](./definitions/ListCallMonitoringGroupsParameters.ts) -- `result` is of type [CallMonitoringGroups](./definitions/CallMonitoringGroups.ts) +- `tMUpdatePostRequest` is of type [TMUpdatePostRequest](./definitions/TMUpdatePostRequest.ts) +- `result` is of type [TMPostInfo](./definitions/TMPostInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-listCallMonitoringGroups) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Posts-patchGlipPostNew) in API Explorer. -## createCallMonitoringGroup +## unfavoriteGlipChatNew -Create Call Monitoring Group +Remove Chat from Favorites -| Name | Value | -| ---------------- | ------------------------------------------------------------------ | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `Groups` | +| Name | Value | +| ---------------- | ---------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/unfavorite` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callMonitoringGroups() - .post(createCallMonitoringGroupRequest); +var result = await rc.teamMessaging().v1().chats(chatId).unfavorite().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `createCallMonitoringGroupRequest` is of type [CreateCallMonitoringGroupRequest](./definitions/CreateCallMonitoringGroupRequest.ts) -- `result` is of type [CallMonitoringGroup](./definitions/CallMonitoringGroup.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-createCallMonitoringGroup) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Chats-unfavoriteGlipChatNew) in API Explorer. -## updateCallMonitoringGroup +## readTMCompanyInfoNew -Update Call Monitoring Group +Get Company Info -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups/{groupId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `Groups` | +| Name | Value | +| ---------------- | ------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/companies/{companyId}` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callMonitoringGroups(groupId) - .put(createCallMonitoringGroupRequest); +var result = await rc.teamMessaging().v1().companies(companyId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `createCallMonitoringGroupRequest` is of type [CreateCallMonitoringGroupRequest](./definitions/CreateCallMonitoringGroupRequest.ts) -- `result` is of type [CallMonitoringGroup](./definitions/CallMonitoringGroup.ts) +- `result` is of type [TMCompanyInfo](./definitions/TMCompanyInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-updateCallMonitoringGroup) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Profile-readTMCompanyInfoNew) in API Explorer. -## deleteCallMonitoringGroup +## readGlipEveryoneNew -Delete Call Monitoring Group +Get Everyone Chat -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups/{groupId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `Groups` | +| Name | Value | +| ---------------- | ----------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/everyone` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callMonitoringGroups(groupId).delete(); +var result = await rc.teamMessaging().v1().everyone().get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is an empty string +- `result` is of type [EveryoneTeamInfo](./definitions/EveryoneTeamInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-deleteCallMonitoringGroup) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-readGlipEveryoneNew) in API Explorer. -## assignMultipleCallQueueMembers +## patchGlipEveryoneNew -Assign Multiple Call Queue Members +Update Everyone Chat -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}/bulk-assign` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditExtensions` | -| User Permission | `Groups` | +| Name | Value | +| ---------------- | ----------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/team-messaging/v1/everyone` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callQueues(groupId) - .bulkAssign() - .post(callQueueBulkAssignResource); +var result = await rc.teamMessaging().v1().everyone().patch(updateEveryoneTeamRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `callQueueBulkAssignResource` is of type [CallQueueBulkAssignResource](./definitions/CallQueueBulkAssignResource.ts) -- `result` is an empty string +- `updateEveryoneTeamRequest` is of type [UpdateEveryoneTeamRequest](./definitions/UpdateEveryoneTeamRequest.ts) +- `result` is of type [EveryoneTeamInfo](./definitions/EveryoneTeamInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-assignMultipleCallQueueMembers) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-patchGlipEveryoneNew) in API Explorer. -## listCallQueueMembers +## listFavoriteChatsNew -List Call Queue Members +List Favorite Chats -| Name | Value | -| ---------------- | ------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}/members` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/favorites` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callQueues(groupId) - .members() - .get(listCallQueueMembersParameters); +var result = await rc.teamMessaging().v1().favorites().get(listFavoriteChatsNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listCallQueueMembersParameters` is of type [ListCallQueueMembersParameters](./definitions/ListCallQueueMembersParameters.ts) -- `result` is of type [CallQueueMembers](./definitions/CallQueueMembers.ts) +- `listFavoriteChatsNewParameters` is of type [ListFavoriteChatsNewParameters](./definitions/ListFavoriteChatsNewParameters.ts) +- `result` is of type [TMChatListWithoutNavigation](./definitions/TMChatListWithoutNavigation.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-listCallQueueMembers) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Chats-listFavoriteChatsNew) in API Explorer. -## readCallQueuePresence +## listGlipGroupWebhooksNew -Get Call Queue Presence +List Webhooks in Group -| Name | Value | -| ---------------- | -------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}/presence` | -| Rate Limit Group | `Light` | -| App Permission | `ReadPresence` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/groups/{groupId}/webhooks` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callQueues(groupId).presence().get(); +var result = await rc.teamMessaging().v1().groups(groupId).webhooks().get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [CallQueuePresence](./definitions/CallQueuePresence.ts) +- `result` is of type [TMWebhookList](./definitions/TMWebhookList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Presence-readCallQueuePresence) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-listGlipGroupWebhooksNew) in API Explorer. -## updateCallQueuePresence +## createGlipGroupWebhookNew -Update Call Queue Presence +Create Webhook in Group -| Name | Value | -| ---------------- | -------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}/presence` | -| Rate Limit Group | `Medium` | -| App Permission | `EditPresence` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/groups/{groupId}/webhooks` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callQueues(groupId) - .presence() - .put(callQueueUpdatePresence); +var result = await rc.teamMessaging().v1().groups(groupId).webhooks().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `callQueueUpdatePresence` is of type [CallQueueUpdatePresence](./definitions/CallQueueUpdatePresence.ts) -- `result` is of type [CallQueuePresence](./definitions/CallQueuePresence.ts) +- `result` is of type [TMWebhookInfo](./definitions/TMWebhookInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Presence-updateCallQueuePresence) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-createGlipGroupWebhookNew) in API Explorer. -## readCallRecordingSettings +## lockNoteNew -Get Call Recording Settings +Lock Note -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | ---------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/notes/{noteId}/lock` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callRecording().get(); +var result = await rc.teamMessaging().v1().notes(noteId).lock().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [CallRecordingSettingsResource](./definitions/CallRecordingSettingsResource.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-readCallRecordingSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Notes-lockNoteNew) in API Explorer. -## updateCallRecordingSettings +## joinGlipTeamNew -Update Call Recording Settings +Join Team -| Name | Value | -| ---------------- | ---------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyInfo` | +| Name | Value | +| ---------------- | ---------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/teams/{chatId}/join` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callRecording().put(callRecordingSettingsResource); +var result = await rc.teamMessaging().v1().teams(chatId).join().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `callRecordingSettingsResource` is of type [CallRecordingSettingsResource](./definitions/CallRecordingSettingsResource.ts) -- `result` is of type [CallRecordingSettingsResource](./definitions/CallRecordingSettingsResource.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-updateCallRecordingSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-joinGlipTeamNew) in API Explorer. -## listCallRecordingExtensions +## unarchiveGlipTeamNew -Get Call Recording Extension List +Unarchive Team -| Name | Value | -| ---------------- | --------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/extensions` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | --------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/teams/{chatId}/unarchive` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callRecording().extensions().get(); +var result = await rc.teamMessaging().v1().teams(chatId).unarchive().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [CallRecordingExtensions](./definitions/CallRecordingExtensions.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-listCallRecordingExtensions) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-unarchiveGlipTeamNew) in API Explorer. -## deleteCompanyCallRecordings +## listGlipWebhooksNew -Delete Company Call Recordings +List Webhooks -| Name | Value | -| ---------------- | ----------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recordings` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditCallLog` | -| User Permission | `EditCompanyCallRecordings` | +| Name | Value | +| ---------------- | ----------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/webhooks` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callRecordings().delete(callRecordingIds); +var result = await rc.teamMessaging().v1().webhooks().list(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `callRecordingIds` is of type [CallRecordingIds](./definitions/CallRecordingIds.ts) -- `result` is an empty string +- `result` is of type [TMWebhookList](./definitions/TMWebhookList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recordings-deleteCompanyCallRecordings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-listGlipWebhooksNew) in API Explorer. -## updateDeviceEmergency +## readGlipWebhookNew -Update Device Emergency Info +Get Webhook -| Name | Value | -| ---------------- | ----------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/device/{deviceId}/emergency` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyDevices` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/webhooks/{webhookId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).device(deviceId).emergency().put(accountDeviceUpdate); +var result = await rc.teamMessaging().v1().webhooks(webhookId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `accountDeviceUpdate` is of type [AccountDeviceUpdate](./definitions/AccountDeviceUpdate.ts) -- `result` is of type [DeviceResource](./definitions/DeviceResource.ts) +- `result` is of type [TMWebhookList](./definitions/TMWebhookList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Devices-updateDeviceEmergency) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-readGlipWebhookNew) in API Explorer. -## readDeviceSipInfo +## deleteGlipWebhookNew -Get Device SIP Info +Delete Webhook -| Name | Value | -| ---------------- | ---------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/device/{deviceId}/sip-info` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyDevices` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/team-messaging/v1/webhooks/{webhookId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).device(deviceId).sipInfo().get(); +var result = await rc.teamMessaging().v1().webhooks(webhookId).delete(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [SipInfoResource](./definitions/SipInfoResource.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Devices-readDeviceSipInfo) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-deleteGlipWebhookNew) in API Explorer. -## listDirectoryEntries +## addGlipTeamMembersNew -Get Company Directory Entries +Add Team Members -| Name | Value | -| ---------------- | ------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/directory/entries` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/teams/{chatId}/add` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).directory().entries().list(listDirectoryEntriesParameters); +var result = await rc.teamMessaging().v1().teams(chatId).add().post(tMAddTeamMembersRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listDirectoryEntriesParameters` is of type [ListDirectoryEntriesParameters](./definitions/ListDirectoryEntriesParameters.ts) -- `result` is of type [DirectoryResource](./definitions/DirectoryResource.ts) +- `tMAddTeamMembersRequest` is of type [TMAddTeamMembersRequest](./definitions/TMAddTeamMembersRequest.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Internal-Contacts-listDirectoryEntries) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-addGlipTeamMembersNew) in API Explorer. -## readDirectoryEntry +## rcwConfigListAllSessions -Get Corporate Directory Entry +List Sessions across Multiple Webinars -| Name | Value | -| ---------------- | ----------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/directory/entries/{entryId}` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/webinar/configuration/v1/sessions` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .directory() - .entries(entryId) - .get(readDirectoryEntryParameters); +var result = await rc.webinar().configuration().v1().sessions().get(rcwConfigListAllSessionsParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readDirectoryEntryParameters` is of type [ReadDirectoryEntryParameters](./definitions/ReadDirectoryEntryParameters.ts) -- `result` is of type [ContactResource](./definitions/ContactResource.ts) +- `rcwConfigListAllSessionsParameters` is of type [RcwConfigListAllSessionsParameters](./definitions/RcwConfigListAllSessionsParameters.ts) +- `result` is of type [WcsSessionGlobalListResource](./definitions/WcsSessionGlobalListResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Internal-Contacts-readDirectoryEntry) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigListAllSessions) in API Explorer. -## searchDirectoryEntries +## rcwConfigListWebinars -Search Company Directory Entries +List User's Webinars -| Name | Value | -| ---------------- | -------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/directory/entries/search` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/webinar/configuration/v1/webinars` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .directory() - .entries() - .search() - .post(searchDirectoryEntriesRequest, searchDirectoryEntriesParameters); +var result = await rc.webinar().configuration().v1().webinars().list(rcwConfigListWebinarsParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `searchDirectoryEntriesRequest` is of type [SearchDirectoryEntriesRequest](./definitions/SearchDirectoryEntriesRequest.ts) -- `searchDirectoryEntriesParameters` is of type [SearchDirectoryEntriesParameters](./definitions/SearchDirectoryEntriesParameters.ts) -- `result` is of type [DirectoryResource](./definitions/DirectoryResource.ts) +- `rcwConfigListWebinarsParameters` is of type [RcwConfigListWebinarsParameters](./definitions/RcwConfigListWebinarsParameters.ts) +- `result` is of type [WebinarListResource](./definitions/WebinarListResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Internal-Contacts-searchDirectoryEntries) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigListWebinars) in API Explorer. -## readDirectoryFederation +## rcwConfigCreateWebinar -Get Account Federation +Create Webinar -| Name | Value | -| ---------------- | ---------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/directory/federation` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | ------------------------------------ | +| HTTP Method | `POST` | +| Endpoint | `/webinar/configuration/v1/webinars` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .directory() - .federation() - .get(readDirectoryFederationParameters); +var result = await rc.webinar().configuration().v1().webinars().post(webinarCreationRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readDirectoryFederationParameters` is of type [ReadDirectoryFederationParameters](./definitions/ReadDirectoryFederationParameters.ts) -- `result` is of type [FederationResource](./definitions/FederationResource.ts) +- `webinarCreationRequest` is of type [WebinarCreationRequest](./definitions/WebinarCreationRequest.ts) +- `result` is of type [WcsWebinarResource](./definitions/WcsWebinarResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Internal-Contacts-readDirectoryFederation) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigCreateWebinar) in API Explorer. -## listEmergencyLocations +## rcwConfigGetWebinar -List Emergency Locations +Get Webinar -| Name | Value | -| ---------------- | --------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ConfigureEmergencyMaps` | +| Name | Value | +| ---------------- | ------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/webinar/configuration/v1/webinars/{webinarId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .emergencyLocations() - .list(listEmergencyLocationsParameters); +var result = await rc.webinar().configuration().v1().webinars(webinarId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listEmergencyLocationsParameters` is of type [ListEmergencyLocationsParameters](./definitions/ListEmergencyLocationsParameters.ts) -- `result` is of type [EmergencyLocationsResource](./definitions/EmergencyLocationsResource.ts) +- `result` is of type [WcsWebinarResource](./definitions/WcsWebinarResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-listEmergencyLocations) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigGetWebinar) in API Explorer. -## createEmergencyLocation +## rcwConfigDeleteWebinar -Add Emergency Location +Delete Webinar -| Name | Value | -| ---------------- | --------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `ConfigureEmergencyMaps` | +| Name | Value | +| ---------------- | ------------------------------------------------ | +| HTTP Method | `DELETE` | +| Endpoint | `/webinar/configuration/v1/webinars/{webinarId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .emergencyLocations() - .post(emergencyLocationRequestResource); +var result = await rc.webinar().configuration().v1().webinars(webinarId).delete(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `emergencyLocationRequestResource` is of type [EmergencyLocationRequestResource](./definitions/EmergencyLocationRequestResource.ts) -- `result` is of type [EmergencyLocationResponseResource](./definitions/EmergencyLocationResponseResource.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-createEmergencyLocation) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigDeleteWebinar) in API Explorer. -## readEmergencyLocation +## rcwConfigUpdateWebinar -Get Emergency Location +Update Webinar -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}` | -| Rate Limit Group | `Light` | -| App Permission | `EditAccounts` | -| User Permission | `ConfigureEmergencyMaps` | +| Name | Value | +| ---------------- | ------------------------------------------------ | +| HTTP Method | `PATCH` | +| Endpoint | `/webinar/configuration/v1/webinars/{webinarId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .emergencyLocations(locationId) - .get(readEmergencyLocationParameters); +var result = await rc.webinar().configuration().v1().webinars(webinarId).patch(webinarBaseModel); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readEmergencyLocationParameters` is of type [ReadEmergencyLocationParameters](./definitions/ReadEmergencyLocationParameters.ts) -- `result` is of type [CommonEmergencyLocationResource](./definitions/CommonEmergencyLocationResource.ts) +- `webinarBaseModel` is of type [WebinarBaseModel](./definitions/WebinarBaseModel.ts) +- `result` is of type [WcsWebinarResource](./definitions/WcsWebinarResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-readEmergencyLocation) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigUpdateWebinar) in API Explorer. -## updateEmergencyLocation +## rcwHistoryListAllSessions -Update Emergency Location +List Historical Webinar Sessions across Multiple Webinars -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `ConfigureEmergencyMaps` | +| Name | Value | +| ---------------- | ------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/webinar/history/v1/sessions` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .emergencyLocations(locationId) - .put(emergencyLocationRequestResource); +var result = await rc.webinar().history().v1().sessions().get(rcwHistoryListAllSessionsParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `emergencyLocationRequestResource` is of type [EmergencyLocationRequestResource](./definitions/EmergencyLocationRequestResource.ts) -- `result` is of type [EmergencyLocationResponseResource](./definitions/EmergencyLocationResponseResource.ts) +- `rcwHistoryListAllSessionsParameters` is of type [RcwHistoryListAllSessionsParameters](./definitions/RcwHistoryListAllSessionsParameters.ts) +- `result` is of type [SessionGlobalListResource](./definitions/SessionGlobalListResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-updateEmergencyLocation) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryListAllSessions) in API Explorer. -## deleteEmergencyLocation +## rcwHistoryGetWebinar -Delete Emergency Location +Get Historical Webinar -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditAccounts` | -| User Permission | `ConfigureEmergencyMaps` | +| Name | Value | +| ---------------- | ------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/webinar/history/v1/webinars/{webinarId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .emergencyLocations(locationId) - .delete(deleteEmergencyLocationParameters); +var result = await rc.webinar().history().v1().webinars(webinarId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `deleteEmergencyLocationParameters` is of type [DeleteEmergencyLocationParameters](./definitions/DeleteEmergencyLocationParameters.ts) -- `result` is an empty string +- `result` is of type [WebinarResource](./definitions/WebinarResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-deleteEmergencyLocation) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryGetWebinar) in API Explorer. -## extensionBulkUpdate +## caiSpeechToText -Update Multiple Extensions +Speech to Text Conversion -| Name | Value | -| ---------------- | ----------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension-bulk-update` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditExtensions` | -| User Permission | `EditExtensionInfo` | +| Name | Value | +| ---------------- | ----------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/ai/audio/v1/async/speech-to-text` | +| Rate Limit Group | `Heavy` | +| App Permission | `AI` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extensionBulkUpdate().post(extensionBulkUpdateRequest); +var result = await rc.ai().audio().v1().async().speechToText().post(asrInput, caiSpeechToTextParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `extensionBulkUpdateRequest` is of type [ExtensionBulkUpdateRequest](./definitions/ExtensionBulkUpdateRequest.ts) -- `result` is of type [ExtensionBulkUpdateTaskResource](./definitions/ExtensionBulkUpdateTaskResource.ts) +- `asrInput` is of type [AsrInput](./definitions/AsrInput.ts) +- `caiSpeechToTextParameters` is of type [CaiSpeechToTextParameters](./definitions/CaiSpeechToTextParameters.ts) +- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Extensions-extensionBulkUpdate) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Audio-caiSpeechToText) in API Explorer. -## listExtensionActiveCalls +## getAccountRecordings -List User Active Calls +List Account Recordings -| Name | Value | -| ---------------- | -------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/active-calls` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallLog` | -| User Permission | `ReadCallLog` | +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/rcvideo/v1/account/{accountId}/recordings` | +| Rate Limit Group | `Light` | +| App Permission | `Video` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .activeCalls() - .get(listExtensionActiveCallsParameters); +var result = await rc.rcvideo().v1().account(accountId).recordings().get(getAccountRecordingsParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `listExtensionActiveCallsParameters` is of type [ListExtensionActiveCallsParameters](./definitions/ListExtensionActiveCallsParameters.ts) -- `result` is of type [CallLogResponse](./definitions/CallLogResponse.ts) +- `getAccountRecordingsParameters` is of type [GetAccountRecordingsParameters](./definitions/GetAccountRecordingsParameters.ts) +- `result` is of type [CloudRecordings](./definitions/CloudRecordings.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-listExtensionActiveCalls) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Meeting-Recordings-getAccountRecordings) in API Explorer. -## listAnsweringRules +## listCostCenters -List Call Handling Rules +List Cost Centers -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadUserAnsweringRules` | +| Name | Value | +| ---------------- | ----------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/v2/accounts/{accountId}/cost-centers` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `CostCenterManagement` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .answeringRule() - .list(listAnsweringRulesParameters); +var result = await rc.restapi().v2().accounts(accountId).costCenters().get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `listAnsweringRulesParameters` is of type [ListAnsweringRulesParameters](./definitions/ListAnsweringRulesParameters.ts) -- `result` is of type [UserAnsweringRuleList](./definitions/UserAnsweringRuleList.ts) +- `result` is of type [CostCenterList](./definitions/CostCenterList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-listAnsweringRules) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Cost-Centers-listCostCenters) in API Explorer. -## createAnsweringRule +## bulkDeleteUsersV2 -Create Call Handling Rule +Delete User Extensions -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserAnsweringRules` | +| Name | Value | +| ---------------- | --------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/v2/accounts/{accountId}/extensions` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditAccounts` | +| User Permission | `Users` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .answeringRule() - .post(createAnsweringRuleRequest); +var result = await rc.restapi().v2().accounts(accountId).extensions().delete(bulkDeleteUsersRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `createAnsweringRuleRequest` is of type [CreateAnsweringRuleRequest](./definitions/CreateAnsweringRuleRequest.ts) -- `result` is of type [CustomAnsweringRuleInfo](./definitions/CustomAnsweringRuleInfo.ts) +- `bulkDeleteUsersRequest` is of type [BulkDeleteUsersRequest](./definitions/BulkDeleteUsersRequest.ts) +- `result` is of type [BulkDeleteUsersResponse](./definitions/BulkDeleteUsersResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-createAnsweringRule) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-bulkDeleteUsersV2) in API Explorer. -## readAnsweringRule +## listAccountPhoneNumbersV2 -Get Call Handling Rule +List Account Phone Numbers -| Name | Value | -| ---------------- | ------------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadUserAnsweringRules` | +| Name | Value | +| ---------------- | ------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/v2/accounts/{accountId}/phone-numbers` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyPhoneNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .answeringRule(ruleId) - .get(readAnsweringRuleParameters); +var result = await rc.restapi().v2().accounts(accountId).phoneNumbers().get(listAccountPhoneNumbersV2Parameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `readAnsweringRuleParameters` is of type [ReadAnsweringRuleParameters](./definitions/ReadAnsweringRuleParameters.ts) -- `result` is of type [CallHandlingRuleInfo](./definitions/CallHandlingRuleInfo.ts) +- `listAccountPhoneNumbersV2Parameters` is of type [ListAccountPhoneNumbersV2Parameters](./definitions/ListAccountPhoneNumbersV2Parameters.ts) +- `result` is of type [AccountPhoneNumberList](./definitions/AccountPhoneNumberList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-readAnsweringRule) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-listAccountPhoneNumbersV2) in API Explorer. -## updateAnsweringRule +## deleteNumbersFromInventoryV2 -Update Call Handling Rule +Delete Numbers from Inventory -| Name | Value | -| ---------------- | ------------------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserAnsweringRules` | +| Name | Value | +| ---------------- | ------------------------------------------------ | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/v2/accounts/{accountId}/phone-numbers` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyPhoneNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .answeringRule(ruleId) - .put(updateAnsweringRuleRequest); +var result = await rc.restapi().v2().accounts(accountId).phoneNumbers().delete(deletePhoneNumbersRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `updateAnsweringRuleRequest` is of type [UpdateAnsweringRuleRequest](./definitions/UpdateAnsweringRuleRequest.ts) -- `result` is of type [CallHandlingRuleInfo](./definitions/CallHandlingRuleInfo.ts) +- `deletePhoneNumbersRequest` is of type [DeletePhoneNumbersRequest](./definitions/DeletePhoneNumbersRequest.ts) +- `result` is of type [DeletePhoneNumbersResponse](./definitions/DeletePhoneNumbersResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-updateAnsweringRule) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-deleteNumbersFromInventoryV2) in API Explorer. -## deleteAnsweringRule +## assignPhoneNumberV2 -Delete Call Handling Rule +Assign Phone Number -| Name | Value | -| ---------------- | ------------------------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserAnsweringRules` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyPhoneNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).answeringRule(ruleId).delete(); +var result = await rc.restapi().v2().accounts(accountId).phoneNumbers(phoneNumberId).patch(assignPhoneNumberRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is an empty string +- `assignPhoneNumberRequest` is of type [AssignPhoneNumberRequest](./definitions/AssignPhoneNumberRequest.ts) +- `result` is of type [AccountPhoneNumberInfo](./definitions/AccountPhoneNumberInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-deleteAnsweringRule) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-assignPhoneNumberV2) in API Explorer. -## listUserAssignedRoles +## listA2PBatches -List User Assigned Roles +List A2P SMS Batches -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadAssignedRoles` | +| Name | Value | +| ---------------- | ----------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/batches` | +| Rate Limit Group | `Light` | +| App Permission | `A2PSMS` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .assignedRole() - .get(listUserAssignedRolesParameters); +var result = await rc.restapi(apiVersion).account(accountId).a2pSms().batches().list(listA2PBatchesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `listUserAssignedRolesParameters` is of type [ListUserAssignedRolesParameters](./definitions/ListUserAssignedRolesParameters.ts) -- `result` is of type [AssignedRolesResource](./definitions/AssignedRolesResource.ts) +- `listA2PBatchesParameters` is of type [ListA2PBatchesParameters](./definitions/ListA2PBatchesParameters.ts) +- `result` is of type [BatchListResponse](./definitions/BatchListResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listUserAssignedRoles) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-listA2PBatches) in API Explorer. -## updateUserAssignedRoles +## createA2PSMS -Update User Assigned Roles +Send A2P SMS -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role` | -| Rate Limit Group | `Medium` | -| App Permission | `RoleManagement` | -| User Permission | `EditAssignedRoles` | +| Name | Value | +| ---------------- | ----------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/batches` | +| Rate Limit Group | `Light` | +| App Permission | `A2PSMS` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .assignedRole() - .put(assignedRolesResource); +var result = await rc.restapi(apiVersion).account(accountId).a2pSms().batches().post(messageBatchCreateRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `assignedRolesResource` is of type [AssignedRolesResource](./definitions/AssignedRolesResource.ts) -- `result` is of type [AssignedRolesResource](./definitions/AssignedRolesResource.ts) +- `messageBatchCreateRequest` is of type [MessageBatchCreateRequest](./definitions/MessageBatchCreateRequest.ts) +- `result` is of type [MessageBatchResponse](./definitions/MessageBatchResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-updateUserAssignedRoles) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-createA2PSMS) in API Explorer. -## readAuthorizationProfile +## readA2PBatch -Get Authorization Profile +Get A2P SMS Batch -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/authz-profile` | -| Rate Limit Group | `Medium` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/batches/{batchId}` | +| Rate Limit Group | `Light` | +| App Permission | `A2PSMS` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .authzProfile() - .get(readAuthorizationProfileParameters); +var result = await rc.restapi(apiVersion).account(accountId).a2pSms().batches(batchId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `readAuthorizationProfileParameters` is of type [ReadAuthorizationProfileParameters](./definitions/ReadAuthorizationProfileParameters.ts) -- `result` is of type [AuthProfileResource](./definitions/AuthProfileResource.ts) +- `result` is of type [MessageBatchResponse](./definitions/MessageBatchResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Permissions-readAuthorizationProfile) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-readA2PBatch) in API Explorer. -## readUserBusinessHours +## listA2PSMS -Get User Business Hours +List A2P SMS Messages -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/business-hours` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/messages` | +| Rate Limit Group | `Light` | +| App Permission | `A2PSMS` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).businessHours().get(); +var result = await rc.restapi(apiVersion).account(accountId).a2pSms().messages().list(listA2PSMSParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type [GetUserBusinessHoursResponse](./definitions/GetUserBusinessHoursResponse.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Business-Hours-readUserBusinessHours) in API Explorer. +- `listA2PSMSParameters` is of type [ListA2PSMSParameters](./definitions/ListA2PSMSParameters.ts) +- `result` is of type [MessageListResponse](./definitions/MessageListResponse.ts) -## updateUserBusinessHours +[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-listA2PSMS) in API Explorer. -Update User Business Hours +## readA2PSMS -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/business-hours` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserAnsweringRules` | +Get A2P SMS + +| Name | Value | +| ---------------- | ------------------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/messages/{messageId}` | +| Rate Limit Group | `Light` | +| App Permission | `A2PSMS` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .businessHours() - .put(userBusinessHoursUpdateRequest); +var result = await rc.restapi(apiVersion).account(accountId).a2pSms().messages(messageId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `userBusinessHoursUpdateRequest` is of type [UserBusinessHoursUpdateRequest](./definitions/UserBusinessHoursUpdateRequest.ts) -- `result` is of type [UserBusinessHoursUpdateResponse](./definitions/UserBusinessHoursUpdateResponse.ts) +- `result` is of type [MessageDetailsResponse](./definitions/MessageDetailsResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Business-Hours-updateUserBusinessHours) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-readA2PSMS) in API Explorer. -## readUserCallLog +## readA2PSMSOptOuts -List User Call Records +List Opted Out Numbers -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-log` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallLog` | -| User Permission | `ReadCallLog` | +| Name | Value | +| ---------------- | ------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/opt-outs` | +| Rate Limit Group | `Light` | +| App Permission | `A2PSMS` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .callLog() - .list(readUserCallLogParameters); +var result = await rc.restapi(apiVersion).account(accountId).a2pSms().optOuts().get(readA2PSMSOptOutsParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `readUserCallLogParameters` is of type [ReadUserCallLogParameters](./definitions/ReadUserCallLogParameters.ts) -- `result` is of type [CallLogResponse](./definitions/CallLogResponse.ts) +- `readA2PSMSOptOutsParameters` is of type [ReadA2PSMSOptOutsParameters](./definitions/ReadA2PSMSOptOutsParameters.ts) +- `result` is of type [OptOutListResponse](./definitions/OptOutListResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-readUserCallLog) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-readA2PSMSOptOuts) in API Explorer. -## deleteUserCallLog +## aggregateA2PSMSStatuses -Delete User Call Records +List A2P SMS Statuses -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-log` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditCallLog` | -| User Permission | `EditCallLog` | +| Name | Value | +| ---------------- | ------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/a2p-sms/statuses` | +| Rate Limit Group | `Light` | +| App Permission | `A2PSMS` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .callLog() - .delete(deleteUserCallLogParameters); +var result = await rc.restapi(apiVersion).account(accountId).a2pSms().statuses().get(aggregateA2PSMSStatusesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `deleteUserCallLogParameters` is of type [DeleteUserCallLogParameters](./definitions/DeleteUserCallLogParameters.ts) -- `result` is an empty string +- `aggregateA2PSMSStatusesParameters` is of type [AggregateA2PSMSStatusesParameters](./definitions/AggregateA2PSMSStatusesParameters.ts) +- `result` is of type [MessageStatusesResponse](./definitions/MessageStatusesResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-deleteUserCallLog) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#High-Volume-SMS-aggregateA2PSMSStatuses) in API Explorer. -## readUserCallRecord +## listCompanyAnsweringRules -Get User Call Record(s) +List Company Call Handling Rules -| Name | Value | -| ---------------- | ------------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallLog` | -| User Permission | `ReadCallLog` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .callLog(callRecordId) - .get(readUserCallRecordParameters); +var result = await rc.restapi(apiVersion).account(accountId).answeringRule().list(listCompanyAnsweringRulesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `readUserCallRecordParameters` is of type [ReadUserCallRecordParameters](./definitions/ReadUserCallRecordParameters.ts) -- `result` is of type [CallLogRecord](./definitions/CallLogRecord.ts) +- `listCompanyAnsweringRulesParameters` is of type [ListCompanyAnsweringRulesParameters](./definitions/ListCompanyAnsweringRulesParameters.ts) +- `result` is of type [CompanyAnsweringRuleList](./definitions/CompanyAnsweringRuleList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-readUserCallRecord) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-listCompanyAnsweringRules) in API Explorer. -## syncUserCallLog +## createCompanyAnsweringRule -Sync User Call Log +Create Company Call Handling Rule -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-log-sync` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallLog` | -| User Permission | `ReadCallLog` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .callLogSync() - .get(syncUserCallLogParameters); +var result = await rc.restapi(apiVersion).account(accountId).answeringRule().post(companyAnsweringRuleRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `syncUserCallLogParameters` is of type [SyncUserCallLogParameters](./definitions/SyncUserCallLogParameters.ts) -- `result` is of type [CallLogSyncResponse](./definitions/CallLogSyncResponse.ts) +- `companyAnsweringRuleRequest` is of type [CompanyAnsweringRuleRequest](./definitions/CompanyAnsweringRuleRequest.ts) +- `result` is of type [CompanyAnsweringRuleInfo](./definitions/CompanyAnsweringRuleInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-syncUserCallLog) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-createCompanyAnsweringRule) in API Explorer. -## updateUserCallQueues +## readCompanyAnsweringRule -Update User Call Queues +Get Company Call Handling Rule -| Name | Value | -| ---------------- | ------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-queues` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCallQueuePresence` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule/{ruleId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).callQueues().put(userCallQueues); +var result = await rc.restapi(apiVersion).account(accountId).answeringRule(ruleId).get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `userCallQueues` is of type [UserCallQueues](./definitions/UserCallQueues.ts) -- `result` is of type [UserCallQueues](./definitions/UserCallQueues.ts) +- `result` is of type [CompanyAnsweringRuleInfo](./definitions/CompanyAnsweringRuleInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-updateUserCallQueues) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-readCompanyAnsweringRule) in API Explorer. -## readCallerBlockingSettings +## updateCompanyAnsweringRule -Get Caller Blocking Settings +Update Company Call Handling Rule -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadBlockedNumbers` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule/{ruleId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).callerBlocking().get(); +var result = await rc.restapi(apiVersion).account(accountId).answeringRule(ruleId).put(companyAnsweringRuleUpdate); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type [CallerBlockingSettings](./definitions/CallerBlockingSettings.ts) +- `companyAnsweringRuleUpdate` is of type [CompanyAnsweringRuleUpdate](./definitions/CompanyAnsweringRuleUpdate.ts) +- `result` is of type [CompanyAnsweringRuleInfo](./definitions/CompanyAnsweringRuleInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-readCallerBlockingSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-updateCompanyAnsweringRule) in API Explorer. -## updateCallerBlockingSettings +## deleteCompanyAnsweringRule -Update Caller Blocking Settings +Delete Company Call Handling Rule -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking` | -| Rate Limit Group | `Light` | -| App Permission | `EditExtensions` | -| User Permission | `EditBlockedNumbers` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/answering-rule/{ruleId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .callerBlocking() - .put(callerBlockingSettingsUpdate); +var result = await rc.restapi(apiVersion).account(accountId).answeringRule(ruleId).delete(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `callerBlockingSettingsUpdate` is of type [CallerBlockingSettingsUpdate](./definitions/CallerBlockingSettingsUpdate.ts) -- `result` is of type [CallerBlockingSettings](./definitions/CallerBlockingSettings.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-updateCallerBlockingSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-deleteCompanyAnsweringRule) in API Explorer. -## readExtensionCallerId +## listAssignedRoles -Get Extension Caller ID +List Company Assigned Roles -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-id` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCallerIDSettings` | +| Name | Value | +| ---------------- | --------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/assigned-role` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadAssignedRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).callerId().get(); +var result = await rc.restapi(apiVersion).account(accountId).assignedRole().get(listAssignedRolesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type [ExtensionCallerIdInfo](./definitions/ExtensionCallerIdInfo.ts) +- `listAssignedRolesParameters` is of type [ListAssignedRolesParameters](./definitions/ListAssignedRolesParameters.ts) +- `result` is of type [ExtensionWithRolesCollectionResource](./definitions/ExtensionWithRolesCollectionResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readExtensionCallerId) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listAssignedRoles) in API Explorer. -## updateExtensionCallerId +## readAccountBusinessAddress -Update Extension Caller ID +Get Account Business Address -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-id` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditCallerIDSettings` | +| Name | Value | +| ---------------- | ------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/business-address` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .callerId() - .put(extensionCallerIdInfoRequest); +var result = await rc.restapi(apiVersion).account(accountId).businessAddress().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `extensionCallerIdInfoRequest` is of type [ExtensionCallerIdInfoRequest](./definitions/ExtensionCallerIdInfoRequest.ts) -- `result` is of type [ExtensionCallerIdInfo](./definitions/ExtensionCallerIdInfo.ts) +- `result` is of type [AccountBusinessAddressResource](./definitions/AccountBusinessAddressResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateExtensionCallerId) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Company-readAccountBusinessAddress) in API Explorer. -## createInternalTextMessage +## updateAccountBusinessAddress -Create Internal Text Message +Update Company Business Address -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/company-pager` | -| Rate Limit Group | `Medium` | -| App Permission | `InternalMessages` | -| User Permission | `InternalSMS` | +| Name | Value | +| ---------------- | ------------------------------------------------------------ | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/business-address` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .companyPager() - .post(createInternalTextMessageRequest); +var result = await rc.restapi(apiVersion).account(accountId).businessAddress().put(modifyAccountBusinessAddressRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `createInternalTextMessageRequest` is of type [CreateInternalTextMessageRequest](./definitions/CreateInternalTextMessageRequest.ts) -- `result` is of type [GetInternalTextMessageInfoResponse](./definitions/GetInternalTextMessageInfoResponse.ts) +- `modifyAccountBusinessAddressRequest` is of type [ModifyAccountBusinessAddressRequest](./definitions/ModifyAccountBusinessAddressRequest.ts) +- `result` is of type [AccountBusinessAddressResource](./definitions/AccountBusinessAddressResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Pager-Messages-createInternalTextMessage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Company-updateAccountBusinessAddress) in API Explorer. -## readConferencingSettings +## readCompanyBusinessHours -Get User Conferencing Settings +Get Company Business Hours -| Name | Value | -| ---------------- | -------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/conferencing` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `OrganizeConference` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/business-hours` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .conferencing() - .get(readConferencingSettingsParameters); +var result = await rc.restapi(apiVersion).account(accountId).businessHours().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `readConferencingSettingsParameters` is of type [ReadConferencingSettingsParameters](./definitions/ReadConferencingSettingsParameters.ts) -- `result` is of type [GetConferencingInfoResponse](./definitions/GetConferencingInfoResponse.ts) +- `result` is of type [CompanyBusinessHours](./definitions/CompanyBusinessHours.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readConferencingSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Business-Hours-readCompanyBusinessHours) in API Explorer. -## updateConferencingSettings +## updateCompanyBusinessHours -Update User Conferencing Settings +Update Company Business Hours -| Name | Value | -| ---------------- | -------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/conferencing` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `OrganizeConference` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/business-hours` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .conferencing() - .put(updateConferencingInfoRequest); +var result = await rc.restapi(apiVersion).account(accountId).businessHours().put(companyBusinessHoursUpdateRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `updateConferencingInfoRequest` is of type [UpdateConferencingInfoRequest](./definitions/UpdateConferencingInfoRequest.ts) -- `result` is of type [GetConferencingInfoResponse](./definitions/GetConferencingInfoResponse.ts) +- `companyBusinessHoursUpdateRequest` is of type [CompanyBusinessHoursUpdateRequest](./definitions/CompanyBusinessHoursUpdateRequest.ts) +- `result` is of type [CompanyBusinessHours](./definitions/CompanyBusinessHours.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateConferencingSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Business-Hours-updateCompanyBusinessHours) in API Explorer. -## listExtensionDevices +## syncAccountCallLog -List Extension Devices +Sync Company Call Log -| Name | Value | -| ---------------- | -------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/device` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadUserDevices` | +| Name | Value | +| ---------------- | --------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-log-sync` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallLog` | +| User Permission | `ReadCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .device() - .get(listExtensionDevicesParameters); +var result = await rc.restapi(apiVersion).account(accountId).callLogSync().get(syncAccountCallLogParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `listExtensionDevicesParameters` is of type [ListExtensionDevicesParameters](./definitions/ListExtensionDevicesParameters.ts) -- `result` is of type [GetExtensionDevicesResponse](./definitions/GetExtensionDevicesResponse.ts) +- `syncAccountCallLogParameters` is of type [SyncAccountCallLogParameters](./definitions/SyncAccountCallLogParameters.ts) +- `result` is of type [CallLogSyncResponse](./definitions/CallLogSyncResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Devices-listExtensionDevices) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-syncAccountCallLog) in API Explorer. -## listFavoriteContacts +## readCallRecordingSettings -List Favorite Contacts +Get Call Recording Settings -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/favorite` | -| Rate Limit Group | `Light` | -| App Permission | `ReadContacts` | -| User Permission | `ReadPersonalContacts` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).favorite().get(); +var result = await rc.restapi(apiVersion).account(accountId).callRecording().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type [FavoriteContactList](./definitions/FavoriteContactList.ts) +- `result` is of type [CallRecordingSettingsResource](./definitions/CallRecordingSettingsResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#External-Contacts-listFavoriteContacts) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-readCallRecordingSettings) in API Explorer. -## updateFavoriteContactList +## updateCallRecordingSettings -Update Favorite Contact List +Update Call Recording Settings -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/favorite` | -| Rate Limit Group | `Medium` | -| App Permission | `Contacts` | -| User Permission | `EditPersonalContacts` | +| Name | Value | +| ---------------- | ---------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).favorite().put(favoriteCollection); +var result = await rc.restapi(apiVersion).account(accountId).callRecording().put(callRecordingSettingsResource); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `favoriteCollection` is of type [FavoriteCollection](./definitions/FavoriteCollection.ts) -- `result` is of type [FavoriteContactList](./definitions/FavoriteContactList.ts) +- `callRecordingSettingsResource` is of type [CallRecordingSettingsResource](./definitions/CallRecordingSettingsResource.ts) +- `result` is of type [CallRecordingSettingsResource](./definitions/CallRecordingSettingsResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#External-Contacts-updateFavoriteContactList) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-updateCallRecordingSettings) in API Explorer. -## readExtensionFeatures +## deleteCompanyCallRecordings -Get User Features +Delete Company Call Recordings -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/features` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ----------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recordings` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditCallLog` | +| User Permission | `EditCompanyCallRecordings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .features() - .get(readExtensionFeaturesParameters); +var result = await rc.restapi(apiVersion).account(accountId).callRecordings().delete(callRecordingIds); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `readExtensionFeaturesParameters` is of type [ReadExtensionFeaturesParameters](./definitions/ReadExtensionFeaturesParameters.ts) -- `result` is of type [FeatureList](./definitions/FeatureList.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Features-readExtensionFeatures) in API Explorer. +- `callRecordingIds` is of type [CallRecordingIds](./definitions/CallRecordingIds.ts) +- `result` is an empty string -## listExtensionGrants +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recordings-deleteCompanyCallRecordings) in API Explorer. -List Extension Grants +## updateDeviceEmergency -| Name | Value | -| ---------------- | ------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/grant` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +Update Device Emergency Info + +| Name | Value | +| ---------------- | ----------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/device/{deviceId}/emergency` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyDevices` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .grant() - .get(listExtensionGrantsParameters); +var result = await rc.restapi(apiVersion).account(accountId).device(deviceId).emergency().put(accountDeviceUpdate); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `listExtensionGrantsParameters` is of type [ListExtensionGrantsParameters](./definitions/ListExtensionGrantsParameters.ts) -- `result` is of type [GetExtensionGrantListResponse](./definitions/GetExtensionGrantListResponse.ts) +- `accountDeviceUpdate` is of type [AccountDeviceUpdate](./definitions/AccountDeviceUpdate.ts) +- `result` is of type [DeviceResource](./definitions/DeviceResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-listExtensionGrants) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Devices-updateDeviceEmergency) in API Explorer. -## createCustomUserGreeting +## readDeviceSipInfo -Create Custom User Greeting +Get Device SIP Info -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/greeting` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserAnsweringRules` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/device/{deviceId}/sip-info` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyDevices` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .greeting() - .post(createCustomUserGreetingRequest, createCustomUserGreetingParameters); +var result = await rc.restapi(apiVersion).account(accountId).device(deviceId).sipInfo().get(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `createCustomUserGreetingRequest` is of type [CreateCustomUserGreetingRequest](./definitions/CreateCustomUserGreetingRequest.ts) -- `createCustomUserGreetingParameters` is of type [CreateCustomUserGreetingParameters](./definitions/CreateCustomUserGreetingParameters.ts) -- `result` is of type [CustomUserGreetingInfo](./definitions/CustomUserGreetingInfo.ts) +- `result` is of type [SipInfoResource](./definitions/SipInfoResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Greetings-createCustomUserGreeting) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Devices-readDeviceSipInfo) in API Explorer. -## readCustomGreeting +## listExtensionDevices -Get Custom Greeting +List Extension Devices -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/greeting/{greetingId}` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadUserInfo` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/device` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadUserDevices` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).greeting(greetingId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .device() + .get(listExtensionDevicesParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `result` is of type [CustomUserGreetingInfo](./definitions/CustomUserGreetingInfo.ts) +- `listExtensionDevicesParameters` is of type [ListExtensionDevicesParameters](./definitions/ListExtensionDevicesParameters.ts) +- `result` is of type [GetExtensionDevicesResponse](./definitions/GetExtensionDevicesResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Greetings-readCustomGreeting) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Devices-listExtensionDevices) in API Explorer. -## listMessages +## listExtensionGrants -List Messages +List Extension Grants -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store` | -| Rate Limit Group | `Light` | -| App Permission | `ReadMessages` | -| User Permission | `ReadMessages` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/grant` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); @@ -6089,30 +5979,30 @@ var result = await rc .restapi(apiVersion) .account(accountId) .extension(extensionId) - .messageStore() - .list(listMessagesParameters); + .grant() + .get(listExtensionGrantsParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `listMessagesParameters` is of type [ListMessagesParameters](./definitions/ListMessagesParameters.ts) -- `result` is of type [GetMessageList](./definitions/GetMessageList.ts) +- `listExtensionGrantsParameters` is of type [ListExtensionGrantsParameters](./definitions/ListExtensionGrantsParameters.ts) +- `result` is of type [GetExtensionGrantListResponse](./definitions/GetExtensionGrantListResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-listMessages) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-listExtensionGrants) in API Explorer. -## deleteMessageByFilter +## readAccountGreetingContent -Delete Conversation +Get Account Greeting Media Content -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store` | -| Rate Limit Group | `Medium` | -| App Permission | `EditMessages` | -| User Permission | `EditMessages` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/greeting/{greetingId}/content` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); @@ -6120,2124 +6010,2172 @@ await rc.authorize({ jwt }); var result = await rc .restapi(apiVersion) .account(accountId) - .extension(extensionId) - .messageStore() - .deleteAll(deleteMessageByFilterParameters); + .greeting(greetingId) + .content() + .get(readAccountGreetingContentParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `deleteMessageByFilterParameters` is of type [DeleteMessageByFilterParameters](./definitions/DeleteMessageByFilterParameters.ts) -- `result` is an empty string +- `readAccountGreetingContentParameters` is of type [ReadAccountGreetingContentParameters](./definitions/ReadAccountGreetingContentParameters.ts) +- `result` is of type `byte[]` -[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-deleteMessageByFilter) in API Explorer. +### ❗❗❗ Code sample above may not work -## readMessage +Please refer to [Binary content downloading](/README.md#Binary-content-downloading). -Get Message(s) +[Try it out](https://developer.ringcentral.com/api-reference#Greetings-readAccountGreetingContent) in API Explorer. -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}` | -| Rate Limit Group | `Light` | -| App Permission | `ReadMessages` | -| User Permission | `ReadMessages` | +## readCallRecordingContent + +Get Call Recording Content + +| Name | Value | +| ---------------- | --------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/recording/{recordingId}/content` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallRecording` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).messageStore(messageId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .recording(recordingId) + .content() + .get(readCallRecordingContentParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type [GetMessageInfoResponse](./definitions/GetMessageInfoResponse.ts) +- `readCallRecordingContentParameters` is of type [ReadCallRecordingContentParameters](./definitions/ReadCallRecordingContentParameters.ts) +- `result` is of type `byte[]` -[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-readMessage) in API Explorer. +### ❗❗❗ Code sample above may not work -## updateMessage +Please refer to [Binary content downloading](/README.md#Binary-content-downloading). -Update Message(s) +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recordings-readCallRecordingContent) in API Explorer. -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditMessages` | -| User Permission | `EditMessages` | +## getGlipAdaptiveCardNew + +Get Adaptive Card + +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/adaptive-cards/{cardId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .messageStore(messageId) - .put(updateMessageRequest); +var result = await rc.teamMessaging().v1().adaptiveCards(cardId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `updateMessageRequest` is of type [UpdateMessageRequest](./definitions/UpdateMessageRequest.ts) -- `result` is of type [GetMessageInfoResponse](./definitions/GetMessageInfoResponse.ts) +- `result` is of type [AdaptiveCardInfo](./definitions/AdaptiveCardInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-updateMessage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Adaptive-Cards-getGlipAdaptiveCardNew) in API Explorer. -## deleteMessage +## updateGlipAdaptiveCardNew -Delete Message +Update Adaptive Card -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditMessages` | -| User Permission | `EditMessages` | +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/team-messaging/v1/adaptive-cards/{cardId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .messageStore(messageId) - .delete(deleteMessageBulkRequest, deleteMessageParameters); +var result = await rc.teamMessaging().v1().adaptiveCards(cardId).put(adaptiveCardRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `deleteMessageBulkRequest` is of type [DeleteMessageBulkRequest](./definitions/DeleteMessageBulkRequest.ts) -- `deleteMessageParameters` is of type [DeleteMessageParameters](./definitions/DeleteMessageParameters.ts) -- `result` is an empty string +- `adaptiveCardRequest` is of type [AdaptiveCardRequest](./definitions/AdaptiveCardRequest.ts) +- `result` is of type [AdaptiveCardShortInfo](./definitions/AdaptiveCardShortInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-deleteMessage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Adaptive-Cards-updateGlipAdaptiveCardNew) in API Explorer. -## patchMessage +## deleteGlipAdaptiveCardNew -Patch Message(s) +Delete Adaptive Card -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditMessages` | -| User Permission | `EditMessages` | +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/team-messaging/v1/adaptive-cards/{cardId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .messageStore(messageId) - .patch(patchMessageRequest); +var result = await rc.teamMessaging().v1().adaptiveCards(cardId).delete(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `patchMessageRequest` is of type [PatchMessageRequest](./definitions/PatchMessageRequest.ts) -- `result` is of type [GetMessageInfoResponse](./definitions/GetMessageInfoResponse.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-patchMessage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Adaptive-Cards-deleteGlipAdaptiveCardNew) in API Explorer. -## readUserPresenceStatus +## favoriteGlipChatNew -Get User Presence Status +Add Chat to Favorites -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/presence` | -| Rate Limit Group | `Light` | -| App Permission | `ReadPresence` | -| User Permission | `ReadPresenceStatus` | +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/favorite` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .presence() - .get(readUserPresenceStatusParameters); +var result = await rc.teamMessaging().v1().chats(chatId).favorite().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `readUserPresenceStatusParameters` is of type [ReadUserPresenceStatusParameters](./definitions/ReadUserPresenceStatusParameters.ts) -- `result` is of type [GetPresenceInfo](./definitions/GetPresenceInfo.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Presence-readUserPresenceStatus) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Chats-favoriteGlipChatNew) in API Explorer. -## updateUserPresenceStatus +## listChatNotesNew -Update User Presence Status +List Notes -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/presence` | -| Rate Limit Group | `Medium` | -| App Permission | `EditPresence` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/notes` | +| Rate Limit Group | `Heavy` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).presence().put(presenceInfoRequest); +var result = await rc.teamMessaging().v1().chats(chatId).notes().get(listChatNotesNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `presenceInfoRequest` is of type [PresenceInfoRequest](./definitions/PresenceInfoRequest.ts) -- `result` is of type [PresenceInfoResponse](./definitions/PresenceInfoResponse.ts) +- `listChatNotesNewParameters` is of type [ListChatNotesNewParameters](./definitions/ListChatNotesNewParameters.ts) +- `result` is of type [TMNoteList](./definitions/TMNoteList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Presence-updateUserPresenceStatus) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Notes-listChatNotesNew) in API Explorer. -## readUserProfileImageLegacy +## createChatNoteNew -Get User Profile Image +Create Note -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/notes` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).profileImage().list(); +var result = await rc.teamMessaging().v1().chats(chatId).notes().post(tMCreateNoteRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type `byte[]` - -### ❗❗❗ Code sample above may not work - -Please refer to [Binary content downloading](/README.md#Binary-content-downloading). +- `tMCreateNoteRequest` is of type [TMCreateNoteRequest](./definitions/TMCreateNoteRequest.ts) +- `result` is of type [TMNoteInfo](./definitions/TMNoteInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readUserProfileImageLegacy) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Notes-createChatNoteNew) in API Explorer. -## createUserProfileImage +## listChatTasksNew -Upload User Profile Image +List Chat Tasks -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserInfo` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/tasks` | +| Rate Limit Group | `Heavy` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .profileImage() - .post(createUserProfileImageRequest); +var result = await rc.teamMessaging().v1().chats(chatId).tasks().get(listChatTasksNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `createUserProfileImageRequest` is of type [CreateUserProfileImageRequest](./definitions/CreateUserProfileImageRequest.ts) -- `result` is an empty string +- `listChatTasksNewParameters` is of type [ListChatTasksNewParameters](./definitions/ListChatTasksNewParameters.ts) +- `result` is of type [TMTaskList](./definitions/TMTaskList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-createUserProfileImage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Tasks-listChatTasksNew) in API Explorer. -## updateUserProfileImage +## createTaskNew -Update User Profile Image +Create Task -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserInfo` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/chats/{chatId}/tasks` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .profileImage() - .put(updateUserProfileImageRequest); +var result = await rc.teamMessaging().v1().chats(chatId).tasks().post(tMCreateTaskRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `updateUserProfileImageRequest` is of type [UpdateUserProfileImageRequest](./definitions/UpdateUserProfileImageRequest.ts) -- `result` is an empty string +- `tMCreateTaskRequest` is of type [TMCreateTaskRequest](./definitions/TMCreateTaskRequest.ts) +- `result` is of type [TMTaskInfo](./definitions/TMTaskInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateUserProfileImage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Tasks-createTaskNew) in API Explorer. -## deleteUserProfileImage +## listGlipConversationsNew -Delete User Profile Image +List Conversations -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditUserInfo` | +| Name | Value | +| ---------------- | ---------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/conversations` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).profileImage().delete(); +var result = await rc.teamMessaging().v1().conversations().list(listGlipConversationsNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is an empty string +- `listGlipConversationsNewParameters` is of type [ListGlipConversationsNewParameters](./definitions/ListGlipConversationsNewParameters.ts) +- `result` is of type [TMConversationList](./definitions/TMConversationList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-deleteUserProfileImage) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Conversations-listGlipConversationsNew) in API Explorer. -## readScaledProfileImage +## createGlipConversationNew -Get Scaled Profile Image +Create/Open Conversation -| Name | Value | -| ---------------- | --------------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/conversations` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .profileImage(scaleSize) - .get(readScaledProfileImageParameters); +var result = await rc.teamMessaging().v1().conversations().post(createConversationRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `readScaledProfileImageParameters` is of type [ReadScaledProfileImageParameters](./definitions/ReadScaledProfileImageParameters.ts) -- `result` is of type `byte[]` +- `createConversationRequest` is of type [CreateConversationRequest](./definitions/CreateConversationRequest.ts) +- `result` is of type [TMConversationInfo](./definitions/TMConversationInfo.ts) -### ❗❗❗ Code sample above may not work +[Try it out](https://developer.ringcentral.com/api-reference#Conversations-createGlipConversationNew) in API Explorer. -Please refer to [Binary content downloading](/README.md#Binary-content-downloading). +## readGlipConversationNew -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readScaledProfileImage) in API Explorer. +Get Conversation -## createRingOutCall - -Make RingOut Call - -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/ring-out` | -| Rate Limit Group | `Heavy` | -| App Permission | `RingOut` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/conversations/{chatId}` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).ringOut().post(makeRingOutRequest); +var result = await rc.teamMessaging().v1().conversations(chatId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `makeRingOutRequest` is of type [MakeRingOutRequest](./definitions/MakeRingOutRequest.ts) -- `result` is of type [GetRingOutStatusResponse](./definitions/GetRingOutStatusResponse.ts) +- `result` is of type [TMConversationInfo](./definitions/TMConversationInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#RingOut-createRingOutCall) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Conversations-readGlipConversationNew) in API Explorer. -## readRingOutCallStatus +## listDataExportTasksNew -Get RingOut Call Status +List Data Export Tasks -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}` | -| Rate Limit Group | `Light` | -| App Permission | `RingOut` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/data-export` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `Glip` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).ringOut(ringoutId).get(); +var result = await rc.teamMessaging().v1().dataExport().list(listDataExportTasksNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type [GetRingOutStatusResponse](./definitions/GetRingOutStatusResponse.ts) +- `listDataExportTasksNewParameters` is of type [ListDataExportTasksNewParameters](./definitions/ListDataExportTasksNewParameters.ts) +- `result` is of type [DataExportTaskList](./definitions/DataExportTaskList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#RingOut-readRingOutCallStatus) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Compliance-Exports-listDataExportTasksNew) in API Explorer. -## deleteRingOutCall +## createDataExportTaskNew -Cancel RingOut Call +Create Data Export Task -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `RingOut` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/data-export` | +| Rate Limit Group | `Heavy` | +| App Permission | `TeamMessaging` | +| User Permission | `Glip` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).ringOut(ringoutId).delete(); +var result = await rc.teamMessaging().v1().dataExport().post(createDataExportTaskRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is an empty string +- `createDataExportTaskRequest` is of type [CreateDataExportTaskRequest](./definitions/CreateDataExportTaskRequest.ts) +- `result` is of type [DataExportTask](./definitions/DataExportTask.ts) -[Try it out](https://developer.ringcentral.com/api-reference#RingOut-deleteRingOutCall) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Compliance-Exports-createDataExportTaskNew) in API Explorer. -## getForwardAllCompanyCalls +## readDataExportTaskNew -Get Forward All Company Calls +Get Data Export Task -| Name | Value | -| ---------------- | ------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/forward-all-calls` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyAnsweringRules` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/data-export/{taskId}` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `Glip` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).forwardAllCalls().get(); +var result = await rc.teamMessaging().v1().dataExport(taskId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [ForwardAllCompanyCallsInfo](./definitions/ForwardAllCompanyCallsInfo.ts) +- `result` is of type [DataExportTask](./definitions/DataExportTask.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-getForwardAllCompanyCalls) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Compliance-Exports-readDataExportTaskNew) in API Explorer. -## updateForwardAllCompanyCalls +## listGroupEventsNew -Update Forward All Company Calls +List Group Events -| Name | Value | -| ---------------- | ------------------------------------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/forward-all-calls` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyAnsweringRules` | +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/groups/{groupId}/events` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).forwardAllCalls().patch(forwardAllCompanyCallsRequest); +var result = await rc.teamMessaging().v1().groups(groupId).events().get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `forwardAllCompanyCallsRequest` is of type [ForwardAllCompanyCallsRequest](./definitions/ForwardAllCompanyCallsRequest.ts) -- `result` is of type [ForwardAllCompanyCallsInfo](./definitions/ForwardAllCompanyCallsInfo.ts) +- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-updateForwardAllCompanyCalls) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-listGroupEventsNew) in API Explorer. -## readAccountGreetingContent +## createEventByGroupIdNew -Get Account Greeting Media Content +Create Event by Group ID -| Name | Value | -| ---------------- | ------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/greeting/{greetingId}/content` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/groups/{groupId}/events` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .greeting(greetingId) - .content() - .get(readAccountGreetingContentParameters); +var result = await rc.teamMessaging().v1().groups(groupId).events().post(tMCreateEventRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readAccountGreetingContentParameters` is of type [ReadAccountGreetingContentParameters](./definitions/ReadAccountGreetingContentParameters.ts) -- `result` is of type `byte[]` - -### ❗❗❗ Code sample above may not work - -Please refer to [Binary content downloading](/README.md#Binary-content-downloading). +- `tMCreateEventRequest` is of type [TMCreateEventRequest](./definitions/TMCreateEventRequest.ts) +- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Greetings-readAccountGreetingContent) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-createEventByGroupIdNew) in API Explorer. -## readIVRPromptContent +## publishNoteNew -Get IVR Prompt Content +Publish Note -| Name | Value | -| ---------------- | -------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/ivr-prompts/{promptId}/content` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/notes/{noteId}/publish` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .ivrPrompts(promptId) - .content() - .get(readIVRPromptContentParameters); +var result = await rc.teamMessaging().v1().notes(noteId).publish().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readIVRPromptContentParameters` is of type [ReadIVRPromptContentParameters](./definitions/ReadIVRPromptContentParameters.ts) -- `result` is of type `byte[]` - -### ❗❗❗ Code sample above may not work - -Please refer to [Binary content downloading](/README.md#Binary-content-downloading). +- `result` is of type [TMNoteInfo](./definitions/TMNoteInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#IVR-readIVRPromptContent) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Notes-publishNoteNew) in API Explorer. -## createMessageStoreReport +## unlockNoteNew -Create Message Store Report +Unlock Note -| Name | Value | -| ---------------- | ---------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/message-store-report` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadMessages` | -| User Permission | `Users` | +| Name | Value | +| ---------------- | ------------------------------------------ | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/notes/{noteId}/unlock` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).messageStoreReport().post(createMessageStoreReportRequest); +var result = await rc.teamMessaging().v1().notes(noteId).unlock().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `createMessageStoreReportRequest` is of type [CreateMessageStoreReportRequest](./definitions/CreateMessageStoreReportRequest.ts) -- `result` is of type [MessageStoreReport](./definitions/MessageStoreReport.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Message-Exports-createMessageStoreReport) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Notes-unlockNoteNew) in API Explorer. -## readMessageStoreReportTask +## listRecentChatsNew -Get Message Store Report Task +List Recent Chats -| Name | Value | -| ---------------- | ------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/message-store-report/{taskId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadMessages` | -| User Permission | `Users` | +| Name | Value | +| ---------------- | --------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/team-messaging/v1/recent/chats` | +| Rate Limit Group | `Light` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).messageStoreReport(taskId).get(); +var result = await rc.teamMessaging().v1().recent().chats().get(listRecentChatsNewParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [MessageStoreReport](./definitions/MessageStoreReport.ts) +- `listRecentChatsNewParameters` is of type [ListRecentChatsNewParameters](./definitions/ListRecentChatsNewParameters.ts) +- `result` is of type [TMChatListWithoutNavigation](./definitions/TMChatListWithoutNavigation.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Message-Exports-readMessageStoreReportTask) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Chats-listRecentChatsNew) in API Explorer. -## readCallRecordingContent +## leaveGlipTeamNew -Get Call Recording Content +Leave Team -| Name | Value | -| ---------------- | --------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/recording/{recordingId}/content` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadCallRecording` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/teams/{chatId}/leave` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .recording(recordingId) - .content() - .get(readCallRecordingContentParameters); +var result = await rc.teamMessaging().v1().teams(chatId).leave().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readCallRecordingContentParameters` is of type [ReadCallRecordingContentParameters](./definitions/ReadCallRecordingContentParameters.ts) -- `result` is of type `byte[]` - -### ❗❗❗ Code sample above may not work - -Please refer to [Binary content downloading](/README.md#Binary-content-downloading). +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recordings-readCallRecordingContent) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-leaveGlipTeamNew) in API Explorer. -## assignMultipleSites +## rcwHistoryListRecordings -Edit Sites +List Webinar Recordings -| Name | Value | -| ---------------- | ---------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/sites/{siteId}/bulk-assign` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `Sites` | +| Name | Value | +| ---------------- | -------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/webinar/history/v1/recordings` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).sites(siteId).bulkAssign().post(siteMembersBulkUpdate); +var result = await rc.webinar().history().v1().recordings().list(rcwHistoryListRecordingsParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `siteMembersBulkUpdate` is of type [SiteMembersBulkUpdate](./definitions/SiteMembersBulkUpdate.ts) -- `result` is an empty string +- `rcwHistoryListRecordingsParameters` is of type [RcwHistoryListRecordingsParameters](./definitions/RcwHistoryListRecordingsParameters.ts) +- `result` is of type [RecordingListResource](./definitions/RecordingListResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Multi-Site-assignMultipleSites) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Historical-Recordings-rcwHistoryListRecordings) in API Explorer. -## createCallOutCallSession +## rcwHistoryGetRecording -Make CallOut +Get Webinar Recording -| Name | Value | -| ---------------- | -------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/call-out` | -| Rate Limit Group | `Heavy` | -| App Permission | `CallControl` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/webinar/history/v1/recordings/{recordingId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).telephony().callOut().post(makeCallOutRequest); +var result = await rc.webinar().history().v1().recordings(recordingId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `makeCallOutRequest` is of type [MakeCallOutRequest](./definitions/MakeCallOutRequest.ts) -- `result` is of type [CallSession](./definitions/CallSession.ts) +- `result` is of type [RecordingItemExtendedModel](./definitions/RecordingItemExtendedModel.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-createCallOutCallSession) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Historical-Recordings-rcwHistoryGetRecording) in API Explorer. -## createConferenceCallSession +## removeGlipTeamMembersNew -Start Conference Call Session +Remove Team Members -| Name | Value | -| ---------------- | ---------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/conference` | -| Rate Limit Group | `Heavy` | -| App Permission | `CallControl` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------ | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/teams/{chatId}/remove` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).telephony().conference().post(); +var result = await rc.teamMessaging().v1().teams(chatId).remove().post(tMRemoveTeamMembersRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [CallSession](./definitions/CallSession.ts) +- `tMRemoveTeamMembersRequest` is of type [TMRemoveTeamMembersRequest](./definitions/TMRemoveTeamMembersRequest.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-createConferenceCallSession) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-removeGlipTeamMembersNew) in API Explorer. -## readCallSessionStatus +## archiveGlipTeamNew -Get Call Session Status +Archive Team -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}` | -| Rate Limit Group | `Light` | -| App Permission | `CallControl` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/teams/{chatId}/archive` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .telephony() - .sessions(telephonySessionId) - .get(readCallSessionStatusParameters); +var result = await rc.teamMessaging().v1().teams(chatId).archive().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `readCallSessionStatusParameters` is of type [ReadCallSessionStatusParameters](./definitions/ReadCallSessionStatusParameters.ts) -- `result` is of type [CallSessionObject](./definitions/CallSessionObject.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-readCallSessionStatus) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Teams-archiveGlipTeamNew) in API Explorer. -## deleteCallSession +## completeTaskNew -Drop Call Session +Complete Task -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}` | -| Rate Limit Group | `Light` | -| App Permission | `CallControl` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/tasks/{taskId}/complete` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).telephony().sessions(telephonySessionId).delete(); +var result = await rc.teamMessaging().v1().tasks(taskId).complete().post(tMCompleteTaskRequest); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` +- `tMCompleteTaskRequest` is of type [TMCompleteTaskRequest](./definitions/TMCompleteTaskRequest.ts) - `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-deleteCallSession) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Tasks-completeTaskNew) in API Explorer. -## readDefaultRole +## rcwRegGetSession -Get Default User Role +Get Registration Session Info -| Name | Value | -| ---------------- | ------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/default` | -| Rate Limit Group | `Light` | -| App Permission | `RoleManagement` | -| User Permission | `Roles` | +| Name | Value | +| ---------------- | ----------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/webinar/registration/v1/sessions/{sessionId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).userRole().default().get(); +var result = await rc.webinar().registration().v1().sessions(sessionId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [DefaultUserRole](./definitions/DefaultUserRole.ts) +- `result` is of type [RegSessionModel](./definitions/RegSessionModel.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-readDefaultRole) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Registration-Management-rcwRegGetSession) in API Explorer. -## updateDefaultUserRole +## rcwRegUpdateSession -Set Default User Role +Update Registration Session -| Name | Value | -| ---------------- | ------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/default` | -| Rate Limit Group | `Medium` | -| App Permission | `RoleManagement` | -| User Permission | `Roles` | +| Name | Value | +| ---------------- | ----------------------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/webinar/registration/v1/sessions/{sessionId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).userRole().default().put(defaultUserRoleRequest); +var result = await rc.webinar().registration().v1().sessions(sessionId).patch(regSessionModel); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `defaultUserRoleRequest` is of type [DefaultUserRoleRequest](./definitions/DefaultUserRoleRequest.ts) -- `result` is of type [DefaultUserRole](./definitions/DefaultUserRole.ts) +- `regSessionModel` is of type [RegSessionModel](./definitions/RegSessionModel.ts) +- `result` is of type [RegSessionModel](./definitions/RegSessionModel.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-updateDefaultUserRole) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Registration-Management-rcwRegUpdateSession) in API Explorer. -## assignMultipleUserRoles +## activateGlipWebhookNew -Assign Multiple User Roles +Activate Webhook -| Name | Value | -| ---------------- | -------------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/user-role/{roleId}/bulk-assign` | -| Rate Limit Group | `Heavy` | -| App Permission | `RoleManagement` | -| User Permission | `EditUserRoles` | +| Name | Value | +| ---------------- | -------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/team-messaging/v1/webhooks/{webhookId}/activate` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).userRole(roleId).bulkAssign().post(bulkRoleAssignResource); +var result = await rc.teamMessaging().v1().webhooks(webhookId).activate().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `bulkRoleAssignResource` is of type [BulkRoleAssignResource](./definitions/BulkRoleAssignResource.ts) - `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-assignMultipleUserRoles) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-activateGlipWebhookNew) in API Explorer. -## createSIPRegistration +## suspendGlipWebhookNew -Register Device +Suspend Webhook | Name | Value | | ---------------- | ------------------------------------------------- | | HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/client-info/sip-provision` | -| Rate Limit Group | `Heavy` | -| App Permission | `VoipCalling` | +| Endpoint | `/team-messaging/v1/webhooks/{webhookId}/suspend` | +| Rate Limit Group | `Medium` | +| App Permission | `TeamMessaging` | | User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).clientInfo().sipProvision().post(createSipRegistrationRequest); +var result = await rc.teamMessaging().v1().webhooks(webhookId).suspend().post(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `createSipRegistrationRequest` is of type [CreateSipRegistrationRequest](./definitions/CreateSipRegistrationRequest.ts) -- `result` is of type [CreateSipRegistrationResponse](./definitions/CreateSipRegistrationResponse.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Device-SIP-Registration-createSIPRegistration) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-suspendGlipWebhookNew) in API Explorer. -## listFaxCoverPages +## rcwHistoryAdminListRecordings -List Fax Cover Pages +List Webinar Recordings (Admin) -| Name | Value | -| ---------------- | ------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/fax-cover-page` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/webinar/history/v1/company/recordings` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().faxCoverPage().get(listFaxCoverPagesParameters); +var result = await rc.webinar().history().v1().company().recordings().list(rcwHistoryAdminListRecordingsParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `listFaxCoverPagesParameters` is of type [ListFaxCoverPagesParameters](./definitions/ListFaxCoverPagesParameters.ts) -- `result` is of type [ListFaxCoverPagesResponse](./definitions/ListFaxCoverPagesResponse.ts) +- `rcwHistoryAdminListRecordingsParameters` is of type [RcwHistoryAdminListRecordingsParameters](./definitions/RcwHistoryAdminListRecordingsParameters.ts) +- `result` is of type [RecordingAdminListResource](./definitions/RecordingAdminListResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Fax-listFaxCoverPages) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Historical-Recordings-rcwHistoryAdminListRecordings) in API Explorer. -## listPermissions +## rcwHistoryAdminGetRecording -List Permissions +Get Webinar Recording (Admin) -| Name | Value | -| ---------------- | --------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/permission` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/webinar/history/v1/company/recordings/{recordingId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().permission().list(listPermissionsParameters); +var result = await rc.webinar().history().v1().company().recordings(recordingId).get(); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `listPermissionsParameters` is of type [ListPermissionsParameters](./definitions/ListPermissionsParameters.ts) -- `result` is of type [PermissionCollectionResource](./definitions/PermissionCollectionResource.ts) +- `result` is of type [RecordingAdminExtendedItemModel](./definitions/RecordingAdminExtendedItemModel.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Permissions-listPermissions) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Historical-Recordings-rcwHistoryAdminGetRecording) in API Explorer. -## readPermission +## rcwHistoryListAllCompanySessions -Get Permission +List Historical Webinar Sessions across Multiple Webinars / Hosts -| Name | Value | -| ---------------- | ------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/dictionary/permission/{permissionId}` | -| Rate Limit Group | `Light` | -| App Permission | `N/A` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/webinar/history/v1/company/sessions` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).dictionary().permission(permissionId).get(); +var result = await rc.webinar().history().v1().company().sessions().get(rcwHistoryListAllCompanySessionsParameters); await rc.revoke(); ``` -- Parameter `apiVersion` is optional with default value `v1.0` -- `result` is of type [PermissionResource](./definitions/PermissionResource.ts) +- `rcwHistoryListAllCompanySessionsParameters` is of type [RcwHistoryListAllCompanySessionsParameters](./definitions/RcwHistoryListAllCompanySessionsParameters.ts) +- `result` is of type [SessionGlobalListResource](./definitions/SessionGlobalListResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#User-Permissions-readPermission) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryListAllCompanySessions) in API Explorer. -## getGlipAdaptiveCardNew +## rcwHistoryGetSession -Get Adaptive Card +Get Historical Webinar Session -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/adaptive-cards/{cardId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/webinar/history/v1/webinars/{webinarId}/sessions/{sessionId}` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().adaptiveCards(cardId).get(); +var result = await rc.webinar().history().v1().webinars(webinarId).sessions(sessionId).get(); await rc.revoke(); ``` -- `result` is of type [AdaptiveCardInfo](./definitions/AdaptiveCardInfo.ts) +- `result` is of type [SessionResource](./definitions/SessionResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Adaptive-Cards-getGlipAdaptiveCardNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryGetSession) in API Explorer. -## updateGlipAdaptiveCardNew +## caiAnalyzeInteraction -Update Adaptive Card +Interaction Analytics -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/team-messaging/v1/adaptive-cards/{cardId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/ai/insights/v1/async/analyze-interaction` | +| Rate Limit Group | `Heavy` | +| App Permission | `AI` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().adaptiveCards(cardId).put(adaptiveCardRequest); +var result = await rc + .ai() + .insights() + .v1() + .async() + .analyzeInteraction() + .post(interactionInput, caiAnalyzeInteractionParameters); await rc.revoke(); ``` -- `adaptiveCardRequest` is of type [AdaptiveCardRequest](./definitions/AdaptiveCardRequest.ts) -- `result` is of type [AdaptiveCardShortInfo](./definitions/AdaptiveCardShortInfo.ts) +- `interactionInput` is of type [InteractionInput](./definitions/InteractionInput.ts) +- `caiAnalyzeInteractionParameters` is of type [CaiAnalyzeInteractionParameters](./definitions/CaiAnalyzeInteractionParameters.ts) +- `result` is of type [CaiAsyncApiResponse](./definitions/CaiAsyncApiResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Adaptive-Cards-updateGlipAdaptiveCardNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Insights-caiAnalyzeInteraction) in API Explorer. -## deleteGlipAdaptiveCardNew +## getExtensionRecordings -Delete Adaptive Card +List User Recordings -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/team-messaging/v1/adaptive-cards/{cardId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/rcvideo/v1/account/{accountId}/extension/{extensionId}/recordings` | +| Rate Limit Group | `Light` | +| App Permission | `Video` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().adaptiveCards(cardId).delete(); +var result = await rc + .rcvideo() + .v1() + .account(accountId) + .extension(extensionId) + .recordings() + .get(getExtensionRecordingsParameters); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `getExtensionRecordingsParameters` is of type [GetExtensionRecordingsParameters](./definitions/GetExtensionRecordingsParameters.ts) +- `result` is of type [CloudRecordings](./definitions/CloudRecordings.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Adaptive-Cards-deleteGlipAdaptiveCardNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Meeting-Recordings-getExtensionRecordings) in API Explorer. -## favoriteGlipChatNew +## rcvListDelegators -Add Chat to Favorites +Get Delegators -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/favorite` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/rcvideo/v1/accounts/{accountId}/extensions/{extensionId}/delegators` | +| Rate Limit Group | `Medium` | +| App Permission | `Video` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).favorite().post(); +var result = await rc.rcvideo().v1().accounts(accountId).extensions(extensionId).delegators().get(); await rc.revoke(); ``` -- `result` is an empty string +- `result` is of type [DelegatorsListResult](./definitions/DelegatorsListResult.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Chats-favoriteGlipChatNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Delegation-Management-rcvListDelegators) in API Explorer. -## listChatNotesNew +## replacePhoneNumberV2 -List Notes +Replace Phone Number -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/notes` | -| Rate Limit Group | `Heavy` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------ | +| HTTP Method | `POST` | +| Endpoint | `/restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId}/replace` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyPhoneNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).notes().get(listChatNotesNewParameters); +var result = await rc + .restapi() + .v2() + .accounts(accountId) + .phoneNumbers(phoneNumberId) + .replace() + .post(replacePhoneNumberRequest); await rc.revoke(); ``` -- `listChatNotesNewParameters` is of type [ListChatNotesNewParameters](./definitions/ListChatNotesNewParameters.ts) -- `result` is of type [TMNoteList](./definitions/TMNoteList.ts) +- `replacePhoneNumberRequest` is of type [ReplacePhoneNumberRequest](./definitions/ReplacePhoneNumberRequest.ts) +- `result` is of type [AccountPhoneNumberInfo](./definitions/AccountPhoneNumberInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Notes-listChatNotesNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-replacePhoneNumberV2) in API Explorer. -## createChatNoteNew +## sendActivationEmailV2 -Create Note +Send/Resend Activation Email -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/notes` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/v2/accounts/{accountId}/send-activation-email` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `AccountAdministration` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).notes().post(tMCreateNoteRequest); +var result = await rc.restapi().v2().accounts(accountId).sendActivationEmail().post(); await rc.revoke(); ``` -- `tMCreateNoteRequest` is of type [TMCreateNoteRequest](./definitions/TMCreateNoteRequest.ts) -- `result` is of type [TMNoteInfo](./definitions/TMNoteInfo.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Notes-createChatNoteNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Company-sendActivationEmailV2) in API Explorer. -## readGlipPostsNew +## sendWelcomeEmailV2 -List Posts +Send/Resend Welcome Email -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/posts` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/v2/accounts/{accountId}/send-welcome-email` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `Users` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).posts().list(readGlipPostsNewParameters); +var result = await rc.restapi().v2().accounts(accountId).sendWelcomeEmail().post(sendWelcomeEmailV2Request); await rc.revoke(); ``` -- `readGlipPostsNewParameters` is of type [ReadGlipPostsNewParameters](./definitions/ReadGlipPostsNewParameters.ts) -- `result` is of type [TMPostsList](./definitions/TMPostsList.ts) +- `sendWelcomeEmailV2Request` is of type [SendWelcomeEmailV2Request](./definitions/SendWelcomeEmailV2Request.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Posts-readGlipPostsNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Company-sendWelcomeEmailV2) in API Explorer. -## createGlipPostNew +## addressBookBulkUpload -Create Post +Upload Multiple User Contacts -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/posts` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/address-book-bulk-upload` | +| Rate Limit Group | `Heavy` | +| App Permission | `Contacts` | +| User Permission | `EditPersonalContacts` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).posts().post(tMCreatePostRequest); +var result = await rc.restapi(apiVersion).account(accountId).addressBookBulkUpload().post(addressBookBulkUploadRequest); await rc.revoke(); ``` -- `tMCreatePostRequest` is of type [TMCreatePostRequest](./definitions/TMCreatePostRequest.ts) -- `result` is of type [TMPostInfo](./definitions/TMPostInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `addressBookBulkUploadRequest` is of type [AddressBookBulkUploadRequest](./definitions/AddressBookBulkUploadRequest.ts) +- `result` is of type [AddressBookBulkUploadResponse](./definitions/AddressBookBulkUploadResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Posts-createGlipPostNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#External-Contacts-addressBookBulkUpload) in API Explorer. -## readGlipPostNew +## listCallMonitoringGroups -Get Post +List Call Monitoring Groups -| Name | Value | -| ---------------- | -------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/posts/{postId}` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).posts(postId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callMonitoringGroups() + .get(listCallMonitoringGroupsParameters); await rc.revoke(); ``` -- `result` is of type [TMPostInfo](./definitions/TMPostInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `listCallMonitoringGroupsParameters` is of type [ListCallMonitoringGroupsParameters](./definitions/ListCallMonitoringGroupsParameters.ts) +- `result` is of type [CallMonitoringGroups](./definitions/CallMonitoringGroups.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Posts-readGlipPostNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-listCallMonitoringGroups) in API Explorer. -## deleteGlipPostNew +## createCallMonitoringGroup -Delete Post +Create Call Monitoring Group -| Name | Value | -| ---------------- | -------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/posts/{postId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------ | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `Groups` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).posts(postId).delete(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callMonitoringGroups() + .post(createCallMonitoringGroupRequest); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `createCallMonitoringGroupRequest` is of type [CreateCallMonitoringGroupRequest](./definitions/CreateCallMonitoringGroupRequest.ts) +- `result` is of type [CallMonitoringGroup](./definitions/CallMonitoringGroup.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Posts-deleteGlipPostNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-createCallMonitoringGroup) in API Explorer. -## patchGlipPostNew +## updateCallMonitoringGroup -Update Post +Update Call Monitoring Group -| Name | Value | -| ---------------- | -------------------------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/posts/{postId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups/{groupId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `Groups` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).posts(postId).patch(tMUpdatePostRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callMonitoringGroups(groupId) + .put(createCallMonitoringGroupRequest); await rc.revoke(); ``` -- `tMUpdatePostRequest` is of type [TMUpdatePostRequest](./definitions/TMUpdatePostRequest.ts) -- `result` is of type [TMPostInfo](./definitions/TMPostInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `createCallMonitoringGroupRequest` is of type [CreateCallMonitoringGroupRequest](./definitions/CreateCallMonitoringGroupRequest.ts) +- `result` is of type [CallMonitoringGroup](./definitions/CallMonitoringGroup.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Posts-patchGlipPostNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-updateCallMonitoringGroup) in API Explorer. -## listChatTasksNew +## deleteCallMonitoringGroup -List Chat Tasks +Delete Call Monitoring Group -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/tasks` | -| Rate Limit Group | `Heavy` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups/{groupId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `Groups` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).tasks().get(listChatTasksNewParameters); +var result = await rc.restapi(apiVersion).account(accountId).callMonitoringGroups(groupId).delete(); await rc.revoke(); ``` -- `listChatTasksNewParameters` is of type [ListChatTasksNewParameters](./definitions/ListChatTasksNewParameters.ts) -- `result` is of type [TMTaskList](./definitions/TMTaskList.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Tasks-listChatTasksNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-deleteCallMonitoringGroup) in API Explorer. -## createTaskNew +## assignMultipleCallQueueMembers -Create Task +Assign Multiple Call Queue Members -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/tasks` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}/bulk-assign` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditExtensions` | +| User Permission | `Groups` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).tasks().post(tMCreateTaskRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callQueues(groupId) + .bulkAssign() + .post(callQueueBulkAssignResource); await rc.revoke(); ``` -- `tMCreateTaskRequest` is of type [TMCreateTaskRequest](./definitions/TMCreateTaskRequest.ts) -- `result` is of type [TMTaskInfo](./definitions/TMTaskInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `callQueueBulkAssignResource` is of type [CallQueueBulkAssignResource](./definitions/CallQueueBulkAssignResource.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Tasks-createTaskNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-assignMultipleCallQueueMembers) in API Explorer. -## unfavoriteGlipChatNew +## listCallRecordingExtensions -Remove Chat from Favorites +Get Call Recording Extension List -| Name | Value | -| ---------------- | ---------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/chats/{chatId}/unfavorite` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/extensions` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().chats(chatId).unfavorite().post(); +var result = await rc.restapi(apiVersion).account(accountId).callRecording().extensions().get(); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [CallRecordingExtensions](./definitions/CallRecordingExtensions.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Chats-unfavoriteGlipChatNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-listCallRecordingExtensions) in API Explorer. -## listGlipConversationsNew +## searchDirectoryEntries -List Conversations +Search Company Directory Entries -| Name | Value | -| ---------------- | ---------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/conversations` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().conversations().list(listGlipConversationsNewParameters); -await rc.revoke(); -``` - -- `listGlipConversationsNewParameters` is of type [ListGlipConversationsNewParameters](./definitions/ListGlipConversationsNewParameters.ts) -- `result` is of type [TMConversationList](./definitions/TMConversationList.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Conversations-listGlipConversationsNew) in API Explorer. - -## createGlipConversationNew - -Create/Open Conversation - -| Name | Value | -| ---------------- | ---------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/conversations` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().conversations().post(createConversationRequest); -await rc.revoke(); -``` - -- `createConversationRequest` is of type [CreateConversationRequest](./definitions/CreateConversationRequest.ts) -- `result` is of type [TMConversationInfo](./definitions/TMConversationInfo.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Conversations-createGlipConversationNew) in API Explorer. - -## readGlipConversationNew - -Get Conversation - -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/conversations/{chatId}` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().conversations(chatId).get(); -await rc.revoke(); -``` - -- `result` is of type [TMConversationInfo](./definitions/TMConversationInfo.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Conversations-readGlipConversationNew) in API Explorer. - -## listDataExportTasksNew - -List Data Export Tasks - -| Name | Value | -| ---------------- | -------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/data-export` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `Glip` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().dataExport().list(listDataExportTasksNewParameters); -await rc.revoke(); -``` - -- `listDataExportTasksNewParameters` is of type [ListDataExportTasksNewParameters](./definitions/ListDataExportTasksNewParameters.ts) -- `result` is of type [DataExportTaskList](./definitions/DataExportTaskList.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Compliance-Exports-listDataExportTasksNew) in API Explorer. - -## createDataExportTaskNew - -Create Data Export Task - -| Name | Value | -| ---------------- | -------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/data-export` | -| Rate Limit Group | `Heavy` | -| App Permission | `TeamMessaging` | -| User Permission | `Glip` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/directory/entries/search` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().dataExport().post(createDataExportTaskRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .directory() + .entries() + .search() + .post(searchDirectoryEntriesRequest, searchDirectoryEntriesParameters); await rc.revoke(); ``` -- `createDataExportTaskRequest` is of type [CreateDataExportTaskRequest](./definitions/CreateDataExportTaskRequest.ts) -- `result` is of type [DataExportTask](./definitions/DataExportTask.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `searchDirectoryEntriesRequest` is of type [SearchDirectoryEntriesRequest](./definitions/SearchDirectoryEntriesRequest.ts) +- `searchDirectoryEntriesParameters` is of type [SearchDirectoryEntriesParameters](./definitions/SearchDirectoryEntriesParameters.ts) +- `result` is of type [DirectoryResource](./definitions/DirectoryResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Compliance-Exports-createDataExportTaskNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Internal-Contacts-searchDirectoryEntries) in API Explorer. -## readDataExportTaskNew +## listExtensionActiveCalls -Get Data Export Task +List User Active Calls -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/data-export/{taskId}` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `Glip` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/active-calls` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallLog` | +| User Permission | `ReadCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().dataExport(taskId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .activeCalls() + .get(listExtensionActiveCallsParameters); await rc.revoke(); ``` -- `result` is of type [DataExportTask](./definitions/DataExportTask.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `listExtensionActiveCallsParameters` is of type [ListExtensionActiveCallsParameters](./definitions/ListExtensionActiveCallsParameters.ts) +- `result` is of type [CallLogResponse](./definitions/CallLogResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Compliance-Exports-readDataExportTaskNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-listExtensionActiveCalls) in API Explorer. -## listGroupEventsNew +## listAnsweringRules -List Group Events +List Call Handling Rules -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/groups/{groupId}/events` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadUserAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().groups(groupId).events().get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .answeringRule() + .list(listAnsweringRulesParameters); await rc.revoke(); ``` -- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `listAnsweringRulesParameters` is of type [ListAnsweringRulesParameters](./definitions/ListAnsweringRulesParameters.ts) +- `result` is of type [UserAnsweringRuleList](./definitions/UserAnsweringRuleList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-listGroupEventsNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-listAnsweringRules) in API Explorer. -## createEventByGroupIdNew +## createAnsweringRule -Create Event by Group ID +Create Call Handling Rule -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/groups/{groupId}/events` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().groups(groupId).events().post(tMCreateEventRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .answeringRule() + .post(createAnsweringRuleRequest); await rc.revoke(); ``` -- `tMCreateEventRequest` is of type [TMCreateEventRequest](./definitions/TMCreateEventRequest.ts) -- `result` is of type [TMEventInfo](./definitions/TMEventInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `createAnsweringRuleRequest` is of type [CreateAnsweringRuleRequest](./definitions/CreateAnsweringRuleRequest.ts) +- `result` is of type [CustomAnsweringRuleInfo](./definitions/CustomAnsweringRuleInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Calendar-Events-createEventByGroupIdNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-createAnsweringRule) in API Explorer. -## listGlipGroupWebhooksNew +## readAnsweringRule -List Webhooks in Group +Get Call Handling Rule -| Name | Value | -| ---------------- | ---------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/groups/{groupId}/webhooks` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadUserAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().groups(groupId).webhooks().get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .answeringRule(ruleId) + .get(readAnsweringRuleParameters); await rc.revoke(); ``` -- `result` is of type [TMWebhookList](./definitions/TMWebhookList.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `readAnsweringRuleParameters` is of type [ReadAnsweringRuleParameters](./definitions/ReadAnsweringRuleParameters.ts) +- `result` is of type [CallHandlingRuleInfo](./definitions/CallHandlingRuleInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-listGlipGroupWebhooksNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-readAnsweringRule) in API Explorer. -## createGlipGroupWebhookNew +## updateAnsweringRule -Create Webhook in Group +Update Call Handling Rule -| Name | Value | -| ---------------- | ---------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/groups/{groupId}/webhooks` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().groups(groupId).webhooks().post(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .answeringRule(ruleId) + .put(updateAnsweringRuleRequest); await rc.revoke(); ``` -- `result` is of type [TMWebhookInfo](./definitions/TMWebhookInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `updateAnsweringRuleRequest` is of type [UpdateAnsweringRuleRequest](./definitions/UpdateAnsweringRuleRequest.ts) +- `result` is of type [CallHandlingRuleInfo](./definitions/CallHandlingRuleInfo.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-createGlipGroupWebhookNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-updateAnsweringRule) in API Explorer. -## publishNoteNew +## deleteAnsweringRule -Publish Note +Delete Call Handling Rule -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/notes/{noteId}/publish` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().notes(noteId).publish().post(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).answeringRule(ruleId).delete(); await rc.revoke(); ``` -- `result` is of type [TMNoteInfo](./definitions/TMNoteInfo.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Notes-publishNoteNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Handling-Rules-deleteAnsweringRule) in API Explorer. -## unlockNoteNew +## listUserAssignedRoles -Unlock Note +List User Assigned Roles -| Name | Value | -| ---------------- | ------------------------------------------ | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/notes/{noteId}/unlock` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadAssignedRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().notes(noteId).unlock().post(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .assignedRole() + .get(listUserAssignedRolesParameters); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `listUserAssignedRolesParameters` is of type [ListUserAssignedRolesParameters](./definitions/ListUserAssignedRolesParameters.ts) +- `result` is of type [AssignedRolesResource](./definitions/AssignedRolesResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Notes-unlockNoteNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listUserAssignedRoles) in API Explorer. -## listRecentChatsNew +## updateUserAssignedRoles -List Recent Chats +Update User Assigned Roles -| Name | Value | -| ---------------- | --------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/team-messaging/v1/recent/chats` | -| Rate Limit Group | `Light` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role` | +| Rate Limit Group | `Medium` | +| App Permission | `RoleManagement` | +| User Permission | `EditAssignedRoles` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().recent().chats().get(listRecentChatsNewParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .assignedRole() + .put(assignedRolesResource); await rc.revoke(); ``` -- `listRecentChatsNewParameters` is of type [ListRecentChatsNewParameters](./definitions/ListRecentChatsNewParameters.ts) -- `result` is of type [TMChatListWithoutNavigation](./definitions/TMChatListWithoutNavigation.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `assignedRolesResource` is of type [AssignedRolesResource](./definitions/AssignedRolesResource.ts) +- `result` is of type [AssignedRolesResource](./definitions/AssignedRolesResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Chats-listRecentChatsNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-updateUserAssignedRoles) in API Explorer. -## completeTaskNew +## readAuthorizationProfile -Complete Task +Get Authorization Profile -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/tasks/{taskId}/complete` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/authz-profile` | +| Rate Limit Group | `Medium` | +| App Permission | `N/A` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().tasks(taskId).complete().post(tMCompleteTaskRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .authzProfile() + .get(readAuthorizationProfileParameters); await rc.revoke(); ``` -- `tMCompleteTaskRequest` is of type [TMCompleteTaskRequest](./definitions/TMCompleteTaskRequest.ts) -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `readAuthorizationProfileParameters` is of type [ReadAuthorizationProfileParameters](./definitions/ReadAuthorizationProfileParameters.ts) +- `result` is of type [AuthProfileResource](./definitions/AuthProfileResource.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Tasks-completeTaskNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Permissions-readAuthorizationProfile) in API Explorer. -## archiveGlipTeamNew +## readUserBusinessHours -Archive Team +Get User Business Hours -| Name | Value | -| ---------------- | ------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/teams/{chatId}/archive` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/business-hours` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).archive().post(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).businessHours().get(); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [GetUserBusinessHoursResponse](./definitions/GetUserBusinessHoursResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-archiveGlipTeamNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Business-Hours-readUserBusinessHours) in API Explorer. -## leaveGlipTeamNew +## updateUserBusinessHours -Leave Team +Update User Business Hours -| Name | Value | -| ---------------- | ----------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/teams/{chatId}/leave` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/business-hours` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserAnsweringRules` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).leave().post(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .businessHours() + .put(userBusinessHoursUpdateRequest); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `userBusinessHoursUpdateRequest` is of type [UserBusinessHoursUpdateRequest](./definitions/UserBusinessHoursUpdateRequest.ts) +- `result` is of type [UserBusinessHoursUpdateResponse](./definitions/UserBusinessHoursUpdateResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-leaveGlipTeamNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Business-Hours-updateUserBusinessHours) in API Explorer. -## removeGlipTeamMembersNew +## syncUserCallLog -Remove Team Members +Sync User Call Log -| Name | Value | -| ---------------- | ------------------------------------------ | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/teams/{chatId}/remove` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/call-log-sync` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallLog` | +| User Permission | `ReadCallLog` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).remove().post(tMRemoveTeamMembersRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .callLogSync() + .get(syncUserCallLogParameters); await rc.revoke(); ``` -- `tMRemoveTeamMembersRequest` is of type [TMRemoveTeamMembersRequest](./definitions/TMRemoveTeamMembersRequest.ts) -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `syncUserCallLogParameters` is of type [SyncUserCallLogParameters](./definitions/SyncUserCallLogParameters.ts) +- `result` is of type [CallLogSyncResponse](./definitions/CallLogSyncResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-removeGlipTeamMembersNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Log-syncUserCallLog) in API Explorer. -## unarchiveGlipTeamNew +## readCallerBlockingSettings -Unarchive Team +Get Caller Blocking Settings -| Name | Value | -| ---------------- | --------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/teams/{chatId}/unarchive` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadBlockedNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().teams(chatId).unarchive().post(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).callerBlocking().get(); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [CallerBlockingSettings](./definitions/CallerBlockingSettings.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Teams-unarchiveGlipTeamNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-readCallerBlockingSettings) in API Explorer. -## activateGlipWebhookNew +## updateCallerBlockingSettings -Activate Webhook +Update Caller Blocking Settings -| Name | Value | -| ---------------- | -------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/webhooks/{webhookId}/activate` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking` | +| Rate Limit Group | `Light` | +| App Permission | `EditExtensions` | +| User Permission | `EditBlockedNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().webhooks(webhookId).activate().post(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .callerBlocking() + .put(callerBlockingSettingsUpdate); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `callerBlockingSettingsUpdate` is of type [CallerBlockingSettingsUpdate](./definitions/CallerBlockingSettingsUpdate.ts) +- `result` is of type [CallerBlockingSettings](./definitions/CallerBlockingSettings.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-activateGlipWebhookNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-updateCallerBlockingSettings) in API Explorer. -## suspendGlipWebhookNew +## createInternalTextMessage -Suspend Webhook +Create Internal Text Message -| Name | Value | -| ---------------- | ------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/team-messaging/v1/webhooks/{webhookId}/suspend` | -| Rate Limit Group | `Medium` | -| App Permission | `TeamMessaging` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/company-pager` | +| Rate Limit Group | `Medium` | +| App Permission | `InternalMessages` | +| User Permission | `InternalSMS` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.teamMessaging().v1().webhooks(webhookId).suspend().post(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .companyPager() + .post(createInternalTextMessageRequest); await rc.revoke(); ``` -- `result` is an empty string +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `createInternalTextMessageRequest` is of type [CreateInternalTextMessageRequest](./definitions/CreateInternalTextMessageRequest.ts) +- `result` is of type [GetInternalTextMessageInfoResponse](./definitions/GetInternalTextMessageInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Incoming-Webhooks-suspendGlipWebhookNew) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Pager-Messages-createInternalTextMessage) in API Explorer. -## rcwConfigListAllSessions +## readConferencingSettings -List Sessions across Multiple Webinars +Get User Conferencing Settings -| Name | Value | -| ---------------- | ------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/webinar/configuration/v1/sessions` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/conferencing` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `OrganizeConference` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().configuration().v1().sessions().get(rcwConfigListAllSessionsParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .conferencing() + .get(readConferencingSettingsParameters); await rc.revoke(); ``` -- `rcwConfigListAllSessionsParameters` is of type [RcwConfigListAllSessionsParameters](./definitions/RcwConfigListAllSessionsParameters.ts) -- `result` is of type [WcsSessionGlobalListResource](./definitions/WcsSessionGlobalListResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `readConferencingSettingsParameters` is of type [ReadConferencingSettingsParameters](./definitions/ReadConferencingSettingsParameters.ts) +- `result` is of type [GetConferencingInfoResponse](./definitions/GetConferencingInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigListAllSessions) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readConferencingSettings) in API Explorer. -## rcwConfigListWebinars +## updateConferencingSettings -List User's Webinars +Update User Conferencing Settings -| Name | Value | -| ---------------- | ------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/webinar/configuration/v1/webinars` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/conferencing` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `OrganizeConference` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().configuration().v1().webinars().list(rcwConfigListWebinarsParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .conferencing() + .put(updateConferencingInfoRequest); await rc.revoke(); ``` -- `rcwConfigListWebinarsParameters` is of type [RcwConfigListWebinarsParameters](./definitions/RcwConfigListWebinarsParameters.ts) -- `result` is of type [WebinarListResource](./definitions/WebinarListResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `updateConferencingInfoRequest` is of type [UpdateConferencingInfoRequest](./definitions/UpdateConferencingInfoRequest.ts) +- `result` is of type [GetConferencingInfoResponse](./definitions/GetConferencingInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigListWebinars) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateConferencingSettings) in API Explorer. -## rcwConfigCreateWebinar +## readGreetingContent -Create Webinar +Get Extension Greeting Media Content -| Name | Value | -| ---------------- | ------------------------------------ | -| HTTP Method | `POST` | -| Endpoint | `/webinar/configuration/v1/webinars` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ------------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/greeting/{greetingId}/content` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().configuration().v1().webinars().post(webinarCreationRequest); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .greeting(greetingId) + .content() + .get(readGreetingContentParameters); await rc.revoke(); ``` -- `webinarCreationRequest` is of type [WebinarCreationRequest](./definitions/WebinarCreationRequest.ts) -- `result` is of type [WcsWebinarResource](./definitions/WcsWebinarResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `readGreetingContentParameters` is of type [ReadGreetingContentParameters](./definitions/ReadGreetingContentParameters.ts) +- `result` is of type `byte[]` -[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigCreateWebinar) in API Explorer. +### ❗❗❗ Code sample above may not work -## rcwConfigGetWebinar +Please refer to [Binary content downloading](/README.md#Binary-content-downloading). -Get Webinar +[Try it out](https://developer.ringcentral.com/api-reference#Greetings-readGreetingContent) in API Explorer. -| Name | Value | -| ---------------- | ------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/webinar/configuration/v1/webinars/{webinarId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +## listMessages + +List Messages + +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store` | +| Rate Limit Group | `Light` | +| App Permission | `ReadMessages` | +| User Permission | `ReadMessages` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().configuration().v1().webinars(webinarId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .messageStore() + .list(listMessagesParameters); await rc.revoke(); ``` -- `result` is of type [WcsWebinarResource](./definitions/WcsWebinarResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `listMessagesParameters` is of type [ListMessagesParameters](./definitions/ListMessagesParameters.ts) +- `result` is of type [GetMessageList](./definitions/GetMessageList.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigGetWebinar) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-listMessages) in API Explorer. -## rcwConfigDeleteWebinar +## deleteMessageByFilter -Delete Webinar +Delete Conversation -| Name | Value | -| ---------------- | ------------------------------------------------ | -| HTTP Method | `DELETE` | -| Endpoint | `/webinar/configuration/v1/webinars/{webinarId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store` | +| Rate Limit Group | `Medium` | +| App Permission | `EditMessages` | +| User Permission | `EditMessages` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().configuration().v1().webinars(webinarId).delete(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .messageStore() + .deleteAll(deleteMessageByFilterParameters); await rc.revoke(); ``` +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `deleteMessageByFilterParameters` is of type [DeleteMessageByFilterParameters](./definitions/DeleteMessageByFilterParameters.ts) - `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigDeleteWebinar) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-deleteMessageByFilter) in API Explorer. -## rcwConfigUpdateWebinar +## readMessage -Update Webinar +Get Message(s) -| Name | Value | -| ---------------- | ------------------------------------------------ | -| HTTP Method | `PATCH` | -| Endpoint | `/webinar/configuration/v1/webinars/{webinarId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}` | +| Rate Limit Group | `Light` | +| App Permission | `ReadMessages` | +| User Permission | `ReadMessages` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().configuration().v1().webinars(webinarId).patch(webinarBaseModel); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).messageStore(messageId).get(); await rc.revoke(); ``` -- `webinarBaseModel` is of type [WebinarBaseModel](./definitions/WebinarBaseModel.ts) -- `result` is of type [WcsWebinarResource](./definitions/WcsWebinarResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [GetMessageInfoResponse](./definitions/GetMessageInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigUpdateWebinar) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-readMessage) in API Explorer. -## rcwHistoryAdminListRecordings +## updateMessage -List Webinar Recordings (Admin) +Update Message(s) -| Name | Value | -| ---------------- | ---------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/webinar/history/v1/company/recordings` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditMessages` | +| User Permission | `EditMessages` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().history().v1().company().recordings().list(rcwHistoryAdminListRecordingsParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .messageStore(messageId) + .put(updateMessageRequest); await rc.revoke(); ``` -- `rcwHistoryAdminListRecordingsParameters` is of type [RcwHistoryAdminListRecordingsParameters](./definitions/RcwHistoryAdminListRecordingsParameters.ts) -- `result` is of type [RecordingAdminListResource](./definitions/RecordingAdminListResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `updateMessageRequest` is of type [UpdateMessageRequest](./definitions/UpdateMessageRequest.ts) +- `result` is of type [GetMessageInfoResponse](./definitions/GetMessageInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Historical-Recordings-rcwHistoryAdminListRecordings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-updateMessage) in API Explorer. -## rcwHistoryAdminGetRecording +## deleteMessage -Get Webinar Recording (Admin) +Delete Message -| Name | Value | -| ---------------- | ------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/webinar/history/v1/company/recordings/{recordingId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditMessages` | +| User Permission | `EditMessages` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().history().v1().company().recordings(recordingId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .messageStore(messageId) + .delete(deleteMessageBulkRequest, deleteMessageParameters); await rc.revoke(); ``` -- `result` is of type [RecordingAdminExtendedItemModel](./definitions/RecordingAdminExtendedItemModel.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `deleteMessageBulkRequest` is of type [DeleteMessageBulkRequest](./definitions/DeleteMessageBulkRequest.ts) +- `deleteMessageParameters` is of type [DeleteMessageParameters](./definitions/DeleteMessageParameters.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Historical-Recordings-rcwHistoryAdminGetRecording) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-deleteMessage) in API Explorer. -## rcwHistoryListRecordings +## patchMessage -List Webinar Recordings +Patch Message(s) -| Name | Value | -| ---------------- | -------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/webinar/history/v1/recordings` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditMessages` | +| User Permission | `EditMessages` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().history().v1().recordings().list(rcwHistoryListRecordingsParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .messageStore(messageId) + .patch(patchMessageRequest); await rc.revoke(); ``` -- `rcwHistoryListRecordingsParameters` is of type [RcwHistoryListRecordingsParameters](./definitions/RcwHistoryListRecordingsParameters.ts) -- `result` is of type [RecordingListResource](./definitions/RecordingListResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `patchMessageRequest` is of type [PatchMessageRequest](./definitions/PatchMessageRequest.ts) +- `result` is of type [GetMessageInfoResponse](./definitions/GetMessageInfoResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Historical-Recordings-rcwHistoryListRecordings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-patchMessage) in API Explorer. -## rcwHistoryGetRecording +## syncMessages -Get Webinar Recording +Sync Messages -| Name | Value | -| ---------------- | ---------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/webinar/history/v1/recordings/{recordingId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-sync` | +| Rate Limit Group | `Light` | +| App Permission | `ReadMessages` | +| User Permission | `ReadMessages` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().history().v1().recordings(recordingId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .messageSync() + .get(syncMessagesParameters); await rc.revoke(); ``` -- `result` is of type [RecordingItemExtendedModel](./definitions/RecordingItemExtendedModel.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `syncMessagesParameters` is of type [SyncMessagesParameters](./definitions/SyncMessagesParameters.ts) +- `result` is of type [GetMessageSyncResponse](./definitions/GetMessageSyncResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Historical-Recordings-rcwHistoryGetRecording) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-syncMessages) in API Explorer. -## rcwHistoryListAllCompanySessions +## listExtensionPhoneNumbers -List Historical Webinar Sessions across Multiple Webinars / Hosts +Get Extension Phone Number List -| Name | Value | -| ---------------- | -------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/webinar/history/v1/company/sessions` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/phone-number` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadUserPhoneNumbers` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().history().v1().company().sessions().get(rcwHistoryListAllCompanySessionsParameters); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .phoneNumber() + .get(listExtensionPhoneNumbersParameters); await rc.revoke(); ``` -- `rcwHistoryListAllCompanySessionsParameters` is of type [RcwHistoryListAllCompanySessionsParameters](./definitions/RcwHistoryListAllCompanySessionsParameters.ts) -- `result` is of type [SessionGlobalListResource](./definitions/SessionGlobalListResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `listExtensionPhoneNumbersParameters` is of type [ListExtensionPhoneNumbersParameters](./definitions/ListExtensionPhoneNumbersParameters.ts) +- `result` is of type [GetExtensionPhoneNumbersResponse](./definitions/GetExtensionPhoneNumbersResponse.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryListAllCompanySessions) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-listExtensionPhoneNumbers) in API Explorer. -## rcwHistoryGetSession +## readUserProfileImageLegacy -Get Historical Webinar Session +Get User Profile Image -| Name | Value | -| ---------------- | --------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/webinar/history/v1/webinars/{webinarId}/sessions/{sessionId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().history().v1().webinars(webinarId).sessions(sessionId).get(); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).profileImage().list(); await rc.revoke(); ``` -- `result` is of type [SessionResource](./definitions/SessionResource.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `result` is of type `byte[]` -[Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryGetSession) in API Explorer. +### ❗❗❗ Code sample above may not work -## rcwRegGetSession +Please refer to [Binary content downloading](/README.md#Binary-content-downloading). -Get Registration Session Info +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readUserProfileImageLegacy) in API Explorer. -| Name | Value | -| ---------------- | ----------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/webinar/registration/v1/sessions/{sessionId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | +## createUserProfileImage + +Upload User Profile Image + +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().registration().v1().sessions(sessionId).get(); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .profileImage() + .post(createUserProfileImageRequest); await rc.revoke(); ``` -- `result` is of type [RegSessionModel](./definitions/RegSessionModel.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `createUserProfileImageRequest` is of type [CreateUserProfileImageRequest](./definitions/CreateUserProfileImageRequest.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Registration-Management-rcwRegGetSession) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-createUserProfileImage) in API Explorer. -## rcwRegUpdateSession +## updateUserProfileImage -Update Registration Session +Update User Profile Image -| Name | Value | -| ---------------- | ----------------------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/webinar/registration/v1/sessions/{sessionId}` | -| Rate Limit Group | `Heavy` | -| App Permission | `EditWebinars` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image` | +| Rate Limit Group | `Heavy` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc.webinar().registration().v1().sessions(sessionId).patch(regSessionModel); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .extension(extensionId) + .profileImage() + .put(updateUserProfileImageRequest); await rc.revoke(); ``` -- `regSessionModel` is of type [RegSessionModel](./definitions/RegSessionModel.ts) -- `result` is of type [RegSessionModel](./definitions/RegSessionModel.ts) +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `updateUserProfileImageRequest` is of type [UpdateUserProfileImageRequest](./definitions/UpdateUserProfileImageRequest.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Registration-Management-rcwRegUpdateSession) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateUserProfileImage) in API Explorer. -## syncMessages +## deleteUserProfileImage -Sync Messages +Delete User Profile Image -| Name | Value | -| ---------------- | -------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-sync` | -| Rate Limit Group | `Light` | -| App Permission | `ReadMessages` | -| User Permission | `ReadMessages` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditUserInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .extension(extensionId) - .messageSync() - .get(syncMessagesParameters); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).profileImage().delete(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `syncMessagesParameters` is of type [SyncMessagesParameters](./definitions/SyncMessagesParameters.ts) -- `result` is of type [GetMessageSyncResponse](./definitions/GetMessageSyncResponse.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-syncMessages) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-deleteUserProfileImage) in API Explorer. -## listExtensionPhoneNumbers +## readScaledProfileImage -Get Extension Phone Number List +Get Scaled Profile Image -| Name | Value | -| ---------------- | -------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/phone-number` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadUserPhoneNumbers` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); @@ -8246,18 +8184,22 @@ var result = await rc .restapi(apiVersion) .account(accountId) .extension(extensionId) - .phoneNumber() - .get(listExtensionPhoneNumbersParameters); + .profileImage(scaleSize) + .get(readScaledProfileImageParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `listExtensionPhoneNumbersParameters` is of type [ListExtensionPhoneNumbersParameters](./definitions/ListExtensionPhoneNumbersParameters.ts) -- `result` is of type [GetExtensionPhoneNumbersResponse](./definitions/GetExtensionPhoneNumbersResponse.ts) +- `readScaledProfileImageParameters` is of type [ReadScaledProfileImageParameters](./definitions/ReadScaledProfileImageParameters.ts) +- `result` is of type `byte[]` -[Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-listExtensionPhoneNumbers) in API Explorer. +### ❗❗❗ Code sample above may not work + +Please refer to [Binary content downloading](/README.md#Binary-content-downloading). + +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readScaledProfileImage) in API Explorer. ## listCompanyMessageTemplates @@ -8426,6 +8368,100 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Paging-Only-Groups-listPagingGroupUsers) in API Explorer. +## readCallPartyStatus + +Get Call Party Status + +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}` | +| Rate Limit Group | `Light` | +| App Permission | `CallControl` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .telephony() + .sessions(telephonySessionId) + .parties(partyId) + .get(); +await rc.revoke(); +``` + +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is of type [CallParty](./definitions/CallParty.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-readCallPartyStatus) in API Explorer. + +## deleteCallParty + +Delete Call Party + +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}` | +| Rate Limit Group | `Light` | +| App Permission | `CallControl` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .telephony() + .sessions(telephonySessionId) + .parties(partyId) + .delete(); +await rc.revoke(); +``` + +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `result` is an empty string + +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-deleteCallParty) in API Explorer. + +## updateCallParty + +Update Call Party + +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------------------------- | +| HTTP Method | `PATCH` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}` | +| Rate Limit Group | `Light` | +| App Permission | `CallControl` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .telephony() + .sessions(telephonySessionId) + .parties(partyId) + .patch(partyUpdateRequest); +await rc.revoke(); +``` + +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `partyUpdateRequest` is of type [PartyUpdateRequest](./definitions/PartyUpdateRequest.ts) +- `result` is of type [CallParty](./definitions/CallParty.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-updateCallParty) in API Explorer. + ## listPermissionCategories List Permission Categories @@ -8499,6 +8535,36 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Adaptive-Cards-createGlipAdaptiveCardNew) in API Explorer. +## rcwConfigListAllCompanySessions + +List Sessions across Multiple Webinars/Hosts + +| Name | Value | +| ---------------- | -------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/webinar/configuration/v1/company/sessions` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadWebinars` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .webinar() + .configuration() + .v1() + .company() + .sessions() + .get(rcwConfigListAllCompanySessionsParameters); +await rc.revoke(); +``` + +- `rcwConfigListAllCompanySessionsParameters` is of type [RcwConfigListAllCompanySessionsParameters](./definitions/RcwConfigListAllCompanySessionsParameters.ts) +- `result` is of type [WcsSessionGlobalListResource](./definitions/WcsSessionGlobalListResource.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigListAllCompanySessions) in API Explorer. + ## rcwHistoryGetRecordingDownload Get Webinar Recording Download Resource @@ -8837,29 +8903,6 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Phone-Numbers-getBulkAddTaskResultsV2) in API Explorer. -## sendActivationEmailV2 - -Send/Resend Activation Email - -| Name | Value | -| ---------------- | -------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/v2/accounts/{accountId}/send-activation-email` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `AccountAdministration` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.restapi().v2().accounts(accountId).sendActivationEmail().post(); -await rc.revoke(); -``` - -- `result` is an empty string - -[Try it out](https://developer.ringcentral.com/api-reference#Company-sendActivationEmailV2) in API Explorer. - ## addA2PSMSOptOuts Add Opt-In/Out Numbers @@ -8919,65 +8962,146 @@ await rc.revoke(); ## listCallMonitoringGroupMembers -List Call Monitoring Group Members +List Call Monitoring Group Members + +| Name | Value | +| ---------------- | ------------------------------------------------------------------------------------ | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups/{groupId}/members` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadExtensions` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callMonitoringGroups(groupId) + .members() + .get(listCallMonitoringGroupMembersParameters); +await rc.revoke(); +``` + +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `listCallMonitoringGroupMembersParameters` is of type [ListCallMonitoringGroupMembersParameters](./definitions/ListCallMonitoringGroupMembersParameters.ts) +- `result` is of type [CallMonitoringGroupMemberList](./definitions/CallMonitoringGroupMemberList.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-listCallMonitoringGroupMembers) in API Explorer. + +## updateCallRecordingExtensionList + +Update Call Recording Extension List + +| Name | Value | +| ---------------- | ---------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/bulk-assign` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callRecording() + .bulkAssign() + .post(bulkAccountCallRecordingsResource); +await rc.revoke(); +``` + +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `bulkAccountCallRecordingsResource` is of type [BulkAccountCallRecordingsResource](./definitions/BulkAccountCallRecordingsResource.ts) +- `result` is an empty string + +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-updateCallRecordingExtensionList) in API Explorer. + +## listCallRecordingCustomGreetings + +Get Call Recording Custom Greeting List + +| Name | Value | +| ---------------- | --------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/custom-greetings` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadCompanyInfo` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .restapi(apiVersion) + .account(accountId) + .callRecording() + .customGreetings() + .get(listCallRecordingCustomGreetingsParameters); +await rc.revoke(); +``` + +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- `listCallRecordingCustomGreetingsParameters` is of type [ListCallRecordingCustomGreetingsParameters](./definitions/ListCallRecordingCustomGreetingsParameters.ts) +- `result` is of type [CallRecordingCustomGreetings](./definitions/CallRecordingCustomGreetings.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-listCallRecordingCustomGreetings) in API Explorer. + +## deleteCallRecordingCustomGreetingList + +Delete Call Recording Custom Greeting List -| Name | Value | -| ---------------- | ------------------------------------------------------------------------------------ | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-monitoring-groups/{groupId}/members` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadExtensions` | +| Name | Value | +| ---------------- | --------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/custom-greetings` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callMonitoringGroups(groupId) - .members() - .get(listCallMonitoringGroupMembersParameters); +var result = await rc.restapi(apiVersion).account(accountId).callRecording().customGreetings().deleteAll(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `listCallMonitoringGroupMembersParameters` is of type [ListCallMonitoringGroupMembersParameters](./definitions/ListCallMonitoringGroupMembersParameters.ts) -- `result` is of type [CallMonitoringGroupMemberList](./definitions/CallMonitoringGroupMemberList.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-listCallMonitoringGroupMembers) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-deleteCallRecordingCustomGreetingList) in API Explorer. -## updateCallRecordingExtensionList +## deleteCallRecordingCustomGreeting -Update Call Recording Extension List +Delete Call Recording Custom Greeting -| Name | Value | -| ---------------- | ---------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/bulk-assign` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------------------- | +| HTTP Method | `DELETE` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/custom-greetings/{greetingId}` | +| Rate Limit Group | `Medium` | +| App Permission | `EditAccounts` | +| User Permission | `EditCompanyInfo` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callRecording() - .bulkAssign() - .post(bulkAccountCallRecordingsResource); +var result = await rc.restapi(apiVersion).account(accountId).callRecording().customGreetings(greetingId).delete(); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `bulkAccountCallRecordingsResource` is of type [BulkAccountCallRecordingsResource](./definitions/BulkAccountCallRecordingsResource.ts) - `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-updateCallRecordingExtensionList) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-deleteCallRecordingCustomGreeting) in API Explorer. ## getExtensionBulkUpdateTask @@ -9381,6 +9505,32 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Role-Management-listOfAvailableForAssigningRoles) in API Explorer. +## assignDefaultRole + +Assign Default Role + +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role/default` | +| Rate Limit Group | `Medium` | +| App Permission | `RoleManagement` | +| User Permission | `Users` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).assignedRole().default().put(); +await rc.revoke(); +``` + +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [AssignedRolesResource](./definitions/AssignedRolesResource.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-assignDefaultRole) in API Explorer. + ## checkUserPermission Check User Permission @@ -9827,17 +9977,17 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Call-Forwarding-deleteForwardingNumber) in API Explorer. -## readGreetingContent +## readMessageContent -Get Extension Greeting Media Content +Get Message Attachment Content -| Name | Value | -| ---------------- | ------------------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/greeting/{greetingId}/content` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadAccounts` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | -------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}` | +| Rate Limit Group | `Medium` | +| App Permission | `ReadMessages` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); @@ -9846,35 +9996,61 @@ var result = await rc .restapi(apiVersion) .account(accountId) .extension(extensionId) - .greeting(greetingId) - .content() - .get(readGreetingContentParameters); + .messageStore(messageId) + .content(attachmentId) + .get(readMessageContentParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `readGreetingContentParameters` is of type [ReadGreetingContentParameters](./definitions/ReadGreetingContentParameters.ts) +- `readMessageContentParameters` is of type [ReadMessageContentParameters](./definitions/ReadMessageContentParameters.ts) - `result` is of type `byte[]` ### ❗❗❗ Code sample above may not work Please refer to [Binary content downloading](/README.md#Binary-content-downloading). -[Try it out](https://developer.ringcentral.com/api-reference#Greetings-readGreetingContent) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-readMessageContent) in API Explorer. -## readMessageContent +## readNotificationSettings -Get Message Attachment Content +Get Notification Settings -| Name | Value | -| ---------------- | -------------------------------------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadMessages` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/notification-settings` | +| Rate Limit Group | `Light` | +| App Permission | `ReadAccounts` | +| User Permission | `ReadMessagesNotificationsSettings` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).notificationSettings().get(); +await rc.revoke(); +``` + +- Parameter `apiVersion` is optional with default value `v1.0` +- Parameter `accountId` is optional with default value `~` +- Parameter `extensionId` is optional with default value `~` +- `result` is of type [NotificationSettings](./definitions/NotificationSettings.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readNotificationSettings) in API Explorer. + +## updateNotificationSettings + +Update Notification Settings + +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------------- | +| HTTP Method | `PUT` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/notification-settings` | +| Rate Limit Group | `Medium` | +| App Permission | `EditExtensions` | +| User Permission | `EditMessagesNotificationsSettings` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); @@ -9883,23 +10059,18 @@ var result = await rc .restapi(apiVersion) .account(accountId) .extension(extensionId) - .messageStore(messageId) - .content(attachmentId) - .get(readMessageContentParameters); + .notificationSettings() + .put(notificationSettingsUpdateRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` - Parameter `extensionId` is optional with default value `~` -- `readMessageContentParameters` is of type [ReadMessageContentParameters](./definitions/ReadMessageContentParameters.ts) -- `result` is of type `byte[]` - -### ❗❗❗ Code sample above may not work - -Please refer to [Binary content downloading](/README.md#Binary-content-downloading). +- `notificationSettingsUpdateRequest` is of type [NotificationSettingsUpdateRequest](./definitions/NotificationSettingsUpdateRequest.ts) +- `result` is of type [NotificationSettings](./definitions/NotificationSettings.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Message-Store-readMessageContent) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateNotificationSettings) in API Explorer. ## readUnifiedPresence @@ -10123,48 +10294,17 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Paging-Only-Groups-listPagingGroupDevices) in API Explorer. -## readCallPartyStatus - -Get Call Party Status - -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}` | -| Rate Limit Group | `Light` | -| App Permission | `CallControl` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .telephony() - .sessions(telephonySessionId) - .parties(partyId) - .get(); -await rc.revoke(); -``` - -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is of type [CallParty](./definitions/CallParty.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-readCallPartyStatus) in API Explorer. - -## deleteCallParty +## callFlipParty -Delete Call Party +Call Flip on Party -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}` | -| Rate Limit Group | `Light` | -| App Permission | `CallControl` | -| User Permission | `N/A` | +| Name | Value | +| ---------------- | ---------------------------------------------------------------------------------------------------------- | +| HTTP Method | `POST` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/flip` | +| Rate Limit Group | `Light` | +| App Permission | `CallControl` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); @@ -10175,56 +10315,26 @@ var result = await rc .telephony() .sessions(telephonySessionId) .parties(partyId) - .delete(); + .flip() + .post(callPartyFlip); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` +- `callPartyFlip` is of type [CallPartyFlip](./definitions/CallPartyFlip.ts) - `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-deleteCallParty) in API Explorer. - -## updateCallParty - -Update Call Party - -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------------------------- | -| HTTP Method | `PATCH` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}` | -| Rate Limit Group | `Light` | -| App Permission | `CallControl` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .telephony() - .sessions(telephonySessionId) - .parties(partyId) - .patch(partyUpdateRequest); -await rc.revoke(); -``` - -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `partyUpdateRequest` is of type [PartyUpdateRequest](./definitions/PartyUpdateRequest.ts) -- `result` is of type [CallParty](./definitions/CallParty.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-updateCallParty) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-callFlipParty) in API Explorer. -## callFlipParty +## holdCallParty -Call Flip on Party +Hold Call Party | Name | Value | | ---------------- | ---------------------------------------------------------------------------------------------------------- | | HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/flip` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/hold` | | Rate Limit Group | `Light` | | App Permission | `CallControl` | | User Permission | `N/A` | @@ -10238,17 +10348,17 @@ var result = await rc .telephony() .sessions(telephonySessionId) .parties(partyId) - .flip() - .post(callPartyFlip); + .hold() + .post(holdCallPartyRequest); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- `callPartyFlip` is of type [CallPartyFlip](./definitions/CallPartyFlip.ts) -- `result` is an empty string +- `holdCallPartyRequest` is of type [HoldCallPartyRequest](./definitions/HoldCallPartyRequest.ts) +- `result` is of type [CallParty](./definitions/CallParty.ts) -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-callFlipParty) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-holdCallParty) in API Explorer. ## callParkParty @@ -10368,36 +10478,6 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Company-listDomesticCountries) in API Explorer. -## rcwConfigListAllCompanySessions - -List Sessions across Multiple Webinars/Hosts - -| Name | Value | -| ---------------- | -------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/webinar/configuration/v1/company/sessions` | -| Rate Limit Group | `Heavy` | -| App Permission | `ReadWebinars` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc - .webinar() - .configuration() - .v1() - .company() - .sessions() - .get(rcwConfigListAllCompanySessionsParameters); -await rc.revoke(); -``` - -- `rcwConfigListAllCompanySessionsParameters` is of type [RcwConfigListAllCompanySessionsParameters](./definitions/RcwConfigListAllCompanySessionsParameters.ts) -- `result` is of type [WcsSessionGlobalListResource](./definitions/WcsSessionGlobalListResource.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Webinars-and-Sessions-rcwConfigListAllCompanySessions) in API Explorer. - ## rcwConfigCreateSession Create Webinar Session @@ -10688,6 +10768,39 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Registrants-rcwRegDeleteRegistrant) in API Explorer. +## getRecordingInsights + +Get Recording Insights + +| Name | Value | +| ---------------- | ------------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/ai/ringsense/v1/public/accounts/{accountId}/domains/{domain}/records/{sourceRecordId}/insights` | +| Rate Limit Group | `Light` | +| App Permission | `RingSense` | +| User Permission | `N/A` | + +```ts +const rc = new RingCentral({ clientId, clientSecret, server }); +await rc.authorize({ jwt }); +var result = await rc + .ai() + .ringsense() + .v1() + .public() + .accounts(accountId) + .domains(domain) + .records(sourceRecordId) + .insights() + .get(getRecordingInsightsParameters); +await rc.revoke(); +``` + +- `getRecordingInsightsParameters` is of type [GetRecordingInsightsParameters](./definitions/GetRecordingInsightsParameters.ts) +- `result` is of type [RecordingInsights](./definitions/RecordingInsights.ts) + +[Try it out](https://developer.ringcentral.com/api-reference#RingSense-getRecordingInsights) in API Explorer. + ## readCallFlipSettings Get Call Flip Settings @@ -10772,87 +10885,6 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Call-Monitoring-Groups-updateCallMonitoringGroupList) in API Explorer. -## listCallRecordingCustomGreetings - -Get Call Recording Custom Greeting List - -| Name | Value | -| ---------------- | --------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/custom-greetings` | -| Rate Limit Group | `Medium` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadCompanyInfo` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .callRecording() - .customGreetings() - .get(listCallRecordingCustomGreetingsParameters); -await rc.revoke(); -``` - -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `listCallRecordingCustomGreetingsParameters` is of type [ListCallRecordingCustomGreetingsParameters](./definitions/ListCallRecordingCustomGreetingsParameters.ts) -- `result` is of type [CallRecordingCustomGreetings](./definitions/CallRecordingCustomGreetings.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-listCallRecordingCustomGreetings) in API Explorer. - -## deleteCallRecordingCustomGreetingList - -Delete Call Recording Custom Greeting List - -| Name | Value | -| ---------------- | --------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/custom-greetings` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyInfo` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callRecording().customGreetings().deleteAll(); -await rc.revoke(); -``` - -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is an empty string - -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-deleteCallRecordingCustomGreetingList) in API Explorer. - -## deleteCallRecordingCustomGreeting - -Delete Call Recording Custom Greeting - -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------------------- | -| HTTP Method | `DELETE` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/custom-greetings/{greetingId}` | -| Rate Limit Group | `Medium` | -| App Permission | `EditAccounts` | -| User Permission | `EditCompanyInfo` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).callRecording().customGreetings(greetingId).delete(); -await rc.revoke(); -``` - -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `result` is an empty string - -[Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-deleteCallRecordingCustomGreeting) in API Explorer. - ## listDevicesAutomaticLocationUpdates List Devices @@ -11624,32 +11656,6 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-validateMultipleWirelessPoints) in API Explorer. -## assignDefaultRole - -Assign Default Role - -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role/default` | -| Rate Limit Group | `Medium` | -| App Permission | `RoleManagement` | -| User Permission | `Users` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).assignedRole().default().put(); -await rc.revoke(); -``` - -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type [AssignedRolesResource](./definitions/AssignedRolesResource.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Role-Management-assignDefaultRole) in API Explorer. - ## listBlockedAllowedNumbers List Blocked/Allowed Phone Numbers @@ -11971,43 +11977,17 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#SMS-Templates-deleteUserMessageTemplate) in API Explorer. -## readNotificationSettings - -Get Notification Settings - -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------------- | -| HTTP Method | `GET` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/notification-settings` | -| Rate Limit Group | `Light` | -| App Permission | `ReadAccounts` | -| User Permission | `ReadMessagesNotificationsSettings` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).notificationSettings().get(); -await rc.revoke(); -``` - -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `result` is of type [NotificationSettings](./definitions/NotificationSettings.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-readNotificationSettings) in API Explorer. - -## updateNotificationSettings +## readMultichannelCallRecordingContent -Update Notification Settings +Get Multichannel Call Recording Content -| Name | Value | -| ---------------- | ----------------------------------------------------------------------------------------- | -| HTTP Method | `PUT` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/notification-settings` | -| Rate Limit Group | `Medium` | -| App Permission | `EditExtensions` | -| User Permission | `EditMessagesNotificationsSettings` | +| Name | Value | +| ---------------- | ----------------------------------------------------------------------------------------------------------- | +| HTTP Method | `GET` | +| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/metadata/multichannel-recordings/{metadataId}/content` | +| Rate Limit Group | `Heavy` | +| App Permission | `ReadCallRecording` | +| User Permission | `N/A` | ```ts const rc = new RingCentral({ clientId, clientSecret, server }); @@ -12015,19 +11995,20 @@ await rc.authorize({ jwt }); var result = await rc .restapi(apiVersion) .account(accountId) - .extension(extensionId) - .notificationSettings() - .put(notificationSettingsUpdateRequest); + .telephony() + .metadata() + .multichannelRecordings(metadataId) + .content() + .get(readMultichannelCallRecordingContentParameters); await rc.revoke(); ``` - Parameter `apiVersion` is optional with default value `v1.0` - Parameter `accountId` is optional with default value `~` -- Parameter `extensionId` is optional with default value `~` -- `notificationSettingsUpdateRequest` is of type [NotificationSettingsUpdateRequest](./definitions/NotificationSettingsUpdateRequest.ts) -- `result` is of type [NotificationSettings](./definitions/NotificationSettings.ts) +- `readMultichannelCallRecordingContentParameters` is of type [ReadMultichannelCallRecordingContentParameters](./definitions/ReadMultichannelCallRecordingContentParameters.ts) +- `result` is an empty string -[Try it out](https://developer.ringcentral.com/api-reference#User-Settings-updateNotificationSettings) in API Explorer. +[Try it out](https://developer.ringcentral.com/api-reference#Telephony-Metadata-readMultichannelCallRecordingContent) in API Explorer. ## createCallPartyWithBringIn @@ -12161,39 +12142,6 @@ await rc.revoke(); [Try it out](https://developer.ringcentral.com/api-reference#Call-Control-forwardCallParty) in API Explorer. -## holdCallParty - -Hold Call Party - -| Name | Value | -| ---------------- | ---------------------------------------------------------------------------------------------------------- | -| HTTP Method | `POST` | -| Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/hold` | -| Rate Limit Group | `Light` | -| App Permission | `CallControl` | -| User Permission | `N/A` | - -```ts -const rc = new RingCentral({ clientId, clientSecret, server }); -await rc.authorize({ jwt }); -var result = await rc - .restapi(apiVersion) - .account(accountId) - .telephony() - .sessions(telephonySessionId) - .parties(partyId) - .hold() - .post(holdCallPartyRequest); -await rc.revoke(); -``` - -- Parameter `apiVersion` is optional with default value `v1.0` -- Parameter `accountId` is optional with default value `~` -- `holdCallPartyRequest` is of type [HoldCallPartyRequest](./definitions/HoldCallPartyRequest.ts) -- `result` is of type [CallParty](./definitions/CallParty.ts) - -[Try it out](https://developer.ringcentral.com/api-reference#Call-Control-holdCallParty) in API Explorer. - ## ignoreCallInQueue Ignore Call in Queue