package
2.3.5+incompatible
Repository: https://github.com/nmludwig/go-ringcentral.git
Documentation: pkg.go.dev

# README

Go API client for ringcentral

This is a beta interactive API explorer for the RingCentral Connect Platform. To use this service, you will need to have an account with the proper credentials to generate an OAuth2 access token.

Quick Start

  1. 1) Go to Authentication > /oauth/token
  2. 2) Enter app_key, app_secret, username, password fields and then click \"Try it out!\"
  3. 3) Upon success, your access_token is loaded and you can access any form requiring authorization.

Links

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./ringcentral"

Documentation for API Endpoints

All URIs are relative to https://platform.devtest.ringcentral.com

ClassMethodHTTP requestDescription
APIInfoApiGetAPIVersionGet /restapiGet API Versions
APIInfoApiGetVersionInfoGet /restapi/{apiVersion}Get Version Info
APIInfoApiLoadAPIStatusGet /restapi/v1.0/statusGet Status
AccountProvisioningApiBulkAssignPost /restapi/v1.0/account/{accountId}/department/bulk-assignEdit Call Queue Members
AccountProvisioningApiCreateAccountPost /restapi/v1.0/accountCreate Account
AccountProvisioningApiCreateDeviceOrderPost /restapi/v1.0/account/{accountId}/orderCreate Device Order
AccountProvisioningApiCreateLicensesOrderPost /restapi/v1.0/account/{accountId}/licenses/bulk-purchaseOrder Licenses
AccountProvisioningApiDeleteLicenseDelete /restapi/v1.0/account/{accountId}/licenses/{licenseId}Delete License
AccountProvisioningApiDeletePhoneNumberByIdDelete /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}Delete Phone Number
AccountProvisioningApiGetBrandInfoGet /restapi/v1.0/dictionary/brand/{brandId}Get Brand Info
AccountProvisioningApiGetDeviceModelsGet /restapi/v1.0/dictionary/deviceGet Device Catalog
AccountProvisioningApiGetExtensionFreeNumbersGet /restapi/v1.0/account/{accountId}/extension/free-numbersGet Free Extension Numbers
AccountProvisioningApiGetPagingOnlyGroupDevicesGet /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devicesGet Paging Only Group Devices
AccountProvisioningApiGetPagingOnlyGroupUsersGet /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/usersGet Paging Only Group Users
AccountProvisioningApiGetParkLocationUsersGet /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/usersGet Park Location Users
AccountProvisioningApiGetServicePlanInfoGet /restapi/v1.0/dictionary/service-plan/{servicePlanId}Get Service Plan
AccountProvisioningApiListAccountDevicesGet /restapi/v1.0/account/{accountId}/deviceGet Account Devices
AccountProvisioningApiListAccountPhoneNumbersGet /restapi/v1.0/account/{accountId}/phone-numberGet All Company Phone Numbers
AccountProvisioningApiListDepartmentMembersGet /restapi/v1.0/account/{accountId}/department/{departmentId}/membersGet Department Member List
AccountProvisioningApiListExtensionDevicesGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/deviceGet User Device Info
AccountProvisioningApiListLicenseTypesGet /restapi/v1.0/dictionary/license-typesGet License Types
AccountProvisioningApiListLicensesGet /restapi/v1.0/account/{accountId}/licensesGet License List
AccountProvisioningApiListShippingOptionsGet /restapi/v1.0/dictionary/shipping-optionsGet Shipping Options
AccountProvisioningApiLoadAccountDeviceGet /restapi/v1.0/account/{accountId}/device/{deviceId}Get Device Info
AccountProvisioningApiLoadAccountPhoneNumberGet /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}Get Phone Number
AccountProvisioningApiLoadDeviceOrderGet /restapi/v1.0/account/{accountId}/order/{orderId}Get Device Order by ID
AccountProvisioningApiLoadLicenseGet /restapi/v1.0/account/{accountId}/licenses/{licenseId}Get License
AccountProvisioningApiLookupPhoneNumbersPost /restapi/v1.0/number-pool/lookupGet Numbers
AccountProvisioningApiParsePhoneNumberPost /restapi/v1.0/number-parser/parseParse Phone Number
AccountProvisioningApiProvisionPhoneNumberPost /restapi/v1.0/account/{accountId}/phone-numberProvision Phone Numbers
AccountProvisioningApiReassignPhoneNumberByIdPut /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}Reassign Phone Number
AccountProvisioningApiReservePhoneNumbersPost /restapi/v1.0/number-pool/reserveReserve/ Un-reserve Numbers
AccountProvisioningApiUpdateDevicePut /restapi/v1.0/account/{accountId}/device/{deviceId}Update Device
AccountProvisioningApiUpdatePagingOnlyGroupUsersAndDevicesPost /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assignEdit Paging Group Users & Devices
AccountProvisioningApiUpdateParkLocationUsersPost /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/bulk-assignAdds and/or removes park location users
ApplicationSettingsApiCreateSipRegistrationPost /restapi/v1.0/client-info/sip-provisionRegister SIP Device
ApplicationSettingsApiDeleteCustomDataDelete /restapi/v1.0/client-info/custom-data/{key}Delete Custom Data
ApplicationSettingsApiGetAttachmentGet /restapi/v1.0/client-info/custom-data/{key}/contentGet Custom Data Attachment
ApplicationSettingsApiGetCustomDataGet /restapi/v1.0/client-info/custom-data/{key}Get Custom Data
ApplicationSettingsApiGetInProductMessageGet /restapi/v1.0/client-info/bannersGet In Product Message List
ApplicationSettingsApiGetSpecialNumberRulesGet /restapi/v1.0/client-info/special-number-ruleGet Special Numbers Calling Limitation
ApplicationSettingsApiLoadClientInfoGet /restapi/v1.0/client-infoGet App Settings
ApplicationSettingsApiLoadPhoneDataGet /restapi/v1.0/number-parser/phonedata.xmlGet Phonedata
ApplicationSettingsApiUpdateCustomDataPut /restapi/v1.0/client-info/custom-data/{key}Create/Update Custom Data
CallHandlingSettingsApiBlockNumberPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-numberAdd Blocked Numbers
CallHandlingSettingsApiCreateAnsweringRuleInfoPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-ruleCreate Custom Call Handling Rules
CallHandlingSettingsApiCreateCompanyAnsweringRuleInfoPost /restapi/v1.0/account/{accountId}/answering-ruleCreate Company Call Handling Rule
CallHandlingSettingsApiCreateExtensionForwardingNumberPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-numberCreate Forwarding Numbers
CallHandlingSettingsApiCreateGreetingPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/greetingCreate User Custom Greeting
CallHandlingSettingsApiCreateIVRMenuPost /restapi/v1.0/account/{accountId}/ivr-menusCreate IVR Menu
CallHandlingSettingsApiCreatePromptsPost /restapi/v1.0/account/{accountId}/ivr-promptsCreate IVR Prompt
CallHandlingSettingsApiDeleteAnsweringRuleDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}Delete Call Handling Rule
CallHandlingSettingsApiDeleteExtensionForwardingNumberDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}Delete Forwarding Number
CallHandlingSettingsApiDeleteIVRPromptDelete /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}Delete IVR Prompt
CallHandlingSettingsApiGetCompanyGreetingPost /restapi/v1.0/account/{accountId}/greetingCreate Custom Company Greeting
CallHandlingSettingsApiGetForwardingNumberGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}Get Forwarding Number
CallHandlingSettingsApiGetGreetingGet /restapi/v1.0/dictionary/greeting/{greetingId}Get Greeting Info
CallHandlingSettingsApiGetGreetingByIDGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}Get Custom Greeting Info
CallHandlingSettingsApiGetGreetingsGet /restapi/v1.0/dictionary/greetingGet Standard Greetings
CallHandlingSettingsApiGetIVRMenuByIdGet /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}Get IVR Menu
CallHandlingSettingsApiGetIVRPromptGet /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}Get IVR Prompt
CallHandlingSettingsApiGetIVRPromptContentGet /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/contentGet IVR Prompt Content
CallHandlingSettingsApiGetIVRPromptsGet /restapi/v1.0/account/{accountId}/ivr-promptsGet IVR Prompts
CallHandlingSettingsApiListBlockedNumbersGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-numberGet Blocked Numbers
CallHandlingSettingsApiListCompanyAnsweringRuleGet /restapi/v1.0/account/{accountId}/answering-ruleGet Company Call Handling Rules
CallHandlingSettingsApiListExtensionForwardingNumbersGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-numberGet Forwarding Numbers
CallHandlingSettingsApiLoadAnsweringRuleInfoGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}Get Call Handling Rule
CallHandlingSettingsApiLoadAnsweringRulesListGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-ruleGet Call Handling Rules
CallHandlingSettingsApiLoadBlockedNumberGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}Get Blocked Number
CallHandlingSettingsApiLoadBusinesshoursInfoGet /restapi/v1.0/account/{accountId}/business-hoursGet Company Business Hours
CallHandlingSettingsApiLoadCompanyAnsweringRuleInfoGet /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}Get Company Call Handling Rule
CallHandlingSettingsApiLoadUserBusinessHoursGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hoursGet User Business Hours
CallHandlingSettingsApiRestapiV10AccountAccountIdIvrMenusIvrMenuIdPutPut /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}Update IVR Menu
CallHandlingSettingsApiUnblockNumberDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}Delete Blocked Number
CallHandlingSettingsApiUpdateAnsweringRuleInfoPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}Update Custom Call Handling Rule
CallHandlingSettingsApiUpdateBlockedNumberPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}Update Blocked Number
CallHandlingSettingsApiUpdateCompanyAnsweringRuleInfoPut /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}Update Company Call Handling Rule
CallHandlingSettingsApiUpdateCompanyBusinessHoursPut /restapi/v1.0/account/{accountId}/business-hoursUpdate Company Business Hours
CallHandlingSettingsApiUpdateExtensionForwardingNumberPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}Update Forwarding Numbers
CallHandlingSettingsApiUpdateUserBusinessHoursPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hoursUpdate User Business Hours
CallLogApiDeleteAccountCallLogDelete /restapi/v1.0/account/{accountId}/call-logDelete Call Log Records by Filter
CallLogApiDeleteAccountCallLogRecordDelete /restapi/v1.0/account/{accountId}/call-log/{callRecordId}Delete Account Call Log Record(s) by ID
CallLogApiDeleteExtensionCallLogDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-logDelete Call Log Records by Filter
CallLogApiGetCallRecordsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}Get Call Records by ID
CallLogApiListCallRecordingDataGet /restapi/v1.0/account/{accountId}/recording/{recordingId}/contentGet Call Recordings Data
CallLogApiListCallRecordingsGet /restapi/v1.0/account/{accountId}/recording/{recordingId}Get Call Recordings
CallLogApiListCompanyActiveCallsGet /restapi/v1.0/account/{accountId}/active-callsGet User Active Calls
CallLogApiListExtensionActiveCallsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/active-callsGet User Active Calls
CallLogApiLoadAccountCallLogGet /restapi/v1.0/account/{accountId}/call-logGet Call Log Records by Filter
CallLogApiLoadAccountCallLogRecordGet /restapi/v1.0/account/{accountId}/call-log/{callRecordId}Get Account Call Log Record(s) by ID
CallLogApiLoadExtensionCallLogGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-logGet Call Log Records by Filter
CallLogApiSyncAccountCallLogGet /restapi/v1.0/account/{accountId}/call-log-syncCall Log Synchronization
CallLogApiSyncExtensionCallLogGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-syncCall Log Synchronization
CompanyContactsApiCreateBotExtensionPost /restapi/v1.0/account/{accountId}/botCreate Bot Extension
CompanyContactsApiCreateExtensionPost /restapi/v1.0/account/{accountId}/extensionCreate Extension
CompanyContactsApiListCompanyDirectoryContactsGet /restapi/v1.0/account/{accountId}/directory/contactsGet Company Directory
CompanyContactsApiListExtensionsGet /restapi/v1.0/account/{accountId}/extensionGet Extensions
CompanyContactsApiLoadCompanyDirectoryContactGet /restapi/v1.0/account/{accountId}/directory/contacts/{contactId}Get Company Directory Contact
CompanyContactsApiLoadCompanyDirectoryExtensionNumbersGet /restapi/v1.0/account/{accountId}/directory/extension-numbersGet Existing Extension Numbers
CompanyContactsApiLoadCompanyDirectoryFederationGet /restapi/v1.0/account/{accountId}/directory/federationGet Account Federation
CompanyContactsApiLoadCompanyDirectoryFederationConflictsGet /restapi/v1.0/account/{accountId}/directory/federation-conflictsGet Account Federation Conflicts
CompanySettingsApiDeleteAccountDelete /restapi/v1.0/account/{accountId}Delete Account
CompanySettingsApiListDialingPlansGet /restapi/v1.0/account/{accountId}/dialing-planGet Available Dialing Plans
CompanySettingsApiLoadAccountGet /restapi/v1.0/account/{accountId}Get Company Info
CompanySettingsApiLoadAccountBusinessAddressGet /restapi/v1.0/account/{accountId}/business-addressGet Company Business Address
CompanySettingsApiLoadServiceInfoGet /restapi/v1.0/account/{accountId}/service-infoGet Account Service Info
CompanySettingsApiModifyAccountPut /restapi/v1.0/account/{accountId}Update Company
CompanySettingsApiUpdateAccountBusinessAddressPut /restapi/v1.0/account/{accountId}/business-addressUpdate Company Business Address
CompanySettingsApiUpdateServiceInfoPut /restapi/v1.0/account/{accountId}/service-infoUpdate Account Service Info [Beta]
GlipApiCreateGlipFilePost /restapi/v1.0/glip/filesUpload File
GlipApiCreateGroupPost /restapi/v1.0/glip/groupsCreate Group
GlipApiCreatePostPost /restapi/v1.0/glip/groups/{groupId}/postsCreate Post
GlipApiLoadCompanyGet /restapi/v1.0/glip/companies/{companyId}Get Company Info
GlipApiLoadGlipFileGet /restapi/v1.0/glip/files/{fileId}Get File Info
GlipApiLoadGroupGet /restapi/v1.0/glip/groups/{groupId}Get Group
GlipApiLoadGroupListGet /restapi/v1.0/glip/groupsGet User Groups
GlipApiLoadPersonGet /restapi/v1.0/glip/persons/{personId}Get Person
GlipApiLoadPostsGet /restapi/v1.0/glip/groups/{groupId}/postsGet Posts
GlipApiLoadUnreadMessageCountGet /restapi/v1.0/glip/profileGlip Unread Message Count
GlipApiUpdateGroupPost /restapi/v1.0/glip/groups/{groupId}/bulk-assignEdit Group Members
MeetingsApiCreateMeetingPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/meetingCreate Meetings
MeetingsApiDeleteMeetingDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}Delete Meeting
MeetingsApiEndMeetingPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/endEnd Meeting
MeetingsApiGetLiveMeetingsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/meetingGet Scheduled Meetings
MeetingsApiGetMeetingDetailsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}Get Meeting Info
MeetingsApiGetMeetingServiceInfoGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-infoGet Meeting Service Info
MeetingsApiUpdateMeetingPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}Update Meeting
MessagesApiDeleteMessageDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}Delete Message(s) by ID
MessagesApiDeleteMessagesByFilterDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-storeDelete Conversations by ID's
MessagesApiGetFaxCoverPagesGet /restapi/v1.0/dictionary/fax-cover-pageGet Fax Cover Pages
MessagesApiListMessagesGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-storeGet Message List
MessagesApiLoadMessageGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}Get Message(s) by ID
MessagesApiLoadMessageAttachmentGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}Get Message Attachment
MessagesApiSendFaxMessagePost /restapi/v1.0/account/{accountId}/extension/{extensionId}/faxCreate Fax Message
MessagesApiSendInternalMessagePost /restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pagerCreate Pager Message
MessagesApiSendSMSPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/smsCreate SMS Message
MessagesApiSyncMessagesGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-syncGet Message Sync
MessagesApiUpdateMessagePut /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}Update Message(s) by ID
PhoneNumbersApiListExtensionPhoneNumbersGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-numberGet Extension Phone Number List
PresenceApiAccountPresenceGet /restapi/v1.0/account/{accountId}/presenceGet all user statuses
PresenceApiGetMonitoringExtensionsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permissionGet User Presence Permissions
PresenceApiGetPresenceLineGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/{lineId}Get Monitored Extensions by Id
PresenceApiGetPresenceStatusGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/presenceGet User Status
PresenceApiListMonitoredExtensionsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/lineGet Monitored Extensions
PresenceApiPutMonitoringExtensionsPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permissionUpdate User Presence Permissions
PresenceApiUpdatePresenceLinesPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/lineUpdate Monitored Extensions
PresenceApiUpdatePresenceStatusPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/presenceUpdate User Status
PushNotificationsApiCreateSubscriptionPost /restapi/v1.0/subscriptionCreate Subscription
PushNotificationsApiDeleteSubscriptionDelete /restapi/v1.0/subscription/{subscriptionId}Cancel Subscription
PushNotificationsApiGetSubscriptionsGet /restapi/v1.0/subscriptionGet Subscriptions
PushNotificationsApiLoadSubscriptionGet /restapi/v1.0/subscription/{subscriptionId}Get Subscription
PushNotificationsApiRenewSubscriptionPost /restapi/v1.0/subscription/{subscriptionId}/renewRenew Subscription
PushNotificationsApiUpdateSubscriptionPut /restapi/v1.0/subscription/{subscriptionId}Renew Subscription / Update Event Filters
RegionalSettingsApiListCountriesGet /restapi/v1.0/dictionary/countryGet Country List
RegionalSettingsApiListLanguagesGet /restapi/v1.0/dictionary/languageGet Language List
RegionalSettingsApiListLocationsGet /restapi/v1.0/dictionary/locationGet Location List
RegionalSettingsApiListTimezonesGet /restapi/v1.0/dictionary/timezoneGet Timezone List
RegionalSettingsApiLoadCountryGet /restapi/v1.0/dictionary/country/{countryId}Get Country
RegionalSettingsApiLoadLanguageGet /restapi/v1.0/dictionary/language/{languageId}Get Language
RegionalSettingsApiLoadStateGet /restapi/v1.0/dictionary/state/{stateId}Get State
RegionalSettingsApiLoadTimezoneGet /restapi/v1.0/dictionary/timezone/{timezoneId}Get Timezone
RegionalSettingsApiLoadlistStatesGet /restapi/v1.0/dictionary/stateGet State List
ReportingApiLoadReportingSettingsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/reporting/settingsGet Reporting Settings
ReportingApiUpdateReportingSettingsPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/reporting/settingsUpdate Reporting Settings
RingOutApiCancelRingOutCallDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId}Cancel RingOut Call
RingOutApiCancelRingOutCallNewDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}Cancel RingOut Call
RingOutApiCreateDirectRingOutPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/direct
RingOutApiCreateDirectRingOutNewPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/direct-ring-outMake Direct RingOut Call
RingOutApiGetRingOutCallStatusGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId}Get Status of RingOut Call
RingOutApiGetRingOutCallStatusNewGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}Get Status of RingOut Call
RingOutApiMakeRingOutCallPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringoutMake RingOut Call
RingOutApiMakeRingOutCallNewPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-outMake RingOut Call
RolesAndPermissionsApiCheckPermissionGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/checkCheck User Permissions
RolesAndPermissionsApiGetPermissionGet /restapi/v1.0/dictionary/permission/{permissionId}Get Permission Info
RolesAndPermissionsApiGetPermissionCategoryGet /restapi/v1.0/dictionary/permission-category/{permissionCategoryId}Get Permission Category
RolesAndPermissionsApiGetProfileGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profileGet User Permissions
RolesAndPermissionsApiGetSystemRoleGet /restapi/v1.0/dictionary/user-role/{roleId}Get User Role
RolesAndPermissionsApiListPermissionCategoriesGet /restapi/v1.0/dictionary/permission-categoryGet Permissions Categories
RolesAndPermissionsApiListPermissionsGet /restapi/v1.0/dictionary/permissionGet Permissions
RolesAndPermissionsApiListSystemRolesGet /restapi/v1.0/dictionary/user-roleGet Standard User Roles
RolesAndPermissionsApiLoadUserRoleGet /restapi/v1.0/account/{accountId}/user-role/defaultGet Default User Role
RolesAndPermissionsApiUpdateUserRolePut /restapi/v1.0/account/{accountId}/user-role/defaultSet Default User Role
SCIMApiCreateUserPost /scim/v2/UsersCreate User
SCIMApiDeleteUserDelete /scim/v2/Users/{id}Delete User
SCIMApiGetServiceProviderConfigGet /scim/v2/ServiceProviderConfigGet Service Provider Config
SCIMApiGetUserByIdGet /scim/v2/Users/{id}Get User
SCIMApiListUsersGet /scim/v2/UsersGet User List
SCIMApiPatchUserPatch /scim/v2/Users/{id}Partially update/patch a user
SCIMApiSearchUsersViaPostPost /scim/v2/Users/.searchsearch or list users
SCIMApiUpdateUserPut /scim/v2/Users/{id}Update or replace user
UserContactsApiContactFavoriteGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/favoriteGet Favorite Contacts
UserContactsApiCreateContactPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contactCreate Contact
UserContactsApiCreateContactsPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/favoriteUpdate Favorite Contacts
UserContactsApiDeleteContactDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}Delete Contact(s) by ID
UserContactsApiListContactsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contactGet Contacts
UserContactsApiLoadContactGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}Get Contact(s) by ID
UserContactsApiSyncAddressBookGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-syncAddress Book Synchronization
UserContactsApiUpdateContactPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}Update Contact(s) by ID
UserSettingsApiDeleteExtensionDelete /restapi/v1.0/account/{accountId}/extension/{extensionId}Delete Extension
UserSettingsApiDownloadImageGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-imageGet User Profile Image
UserSettingsApiGetNotificationSettingsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settingsGet Notification Settings
UserSettingsApiListExtensionGrantsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/grantGet Extension Grants
UserSettingsApiListSecretQuestionsGet /restapi/v1.0/dictionary/secret-questionGet Secret Questions
UserSettingsApiLoadConferencingInfoGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencingGet User Conferencing Settings
UserSettingsApiLoadExtensionCallerIdGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-idGet Extension Caller ID
UserSettingsApiLoadExtensionInfoGet /restapi/v1.0/account/{accountId}/extension/{extensionId}Get Extension Info
UserSettingsApiLoadExtensionProfileImageGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}Get Extension Profile Image (Scaled)
UserSettingsApiLoadExtensionUserCredentialsGet /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentialsGet User Credentials
UserSettingsApiLoadSecretQuestionGet /restapi/v1.0/dictionary/secret-question/{questionId}Get Secret Question
UserSettingsApiUpdateConferencingInfoPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencingUpdate User Conferencing Settings
UserSettingsApiUpdateExtensionPut /restapi/v1.0/account/{accountId}/extension/{extensionId}Update Extension
UserSettingsApiUpdateExtensionCallerIdPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-idUpdate Extension Caller ID
UserSettingsApiUpdateExtensionUserCredentialsPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentialsUpdate User Credentials
UserSettingsApiUpdateNotificationSettingsPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settingsUpdate Notification Settings
UserSettingsApiUploadImageByPostFormPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-imageUpload User Profile Image
UserSettingsApiUploadImageByPutFormPut /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-imageUpdate User Profile Image
UserSettingsApiValidateExtensionUserCredentialsPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/validateValidate User Credentials
UserSettingsApiVerifyExtensionUserCredentialsPost /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/verifyVerify Extension User Credentials

Documentation For Models

Documentation For Authorization

OAuth2

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIClient manages communication with the RingCentral Connect Platform API Explorer API v1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Official name of a formatting language.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericOpenAPIError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Returned if WebHook subscription is blacklisted.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author