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) Go to Authentication > /oauth/token
- 2) Enter app_key, app_secret, username, password fields and then click \"Try it out!\"
- 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
Class | Method | HTTP request | Description |
---|---|---|---|
APIInfoApi | GetAPIVersion | Get /restapi | Get API Versions |
APIInfoApi | GetVersionInfo | Get /restapi/{apiVersion} | Get Version Info |
APIInfoApi | LoadAPIStatus | Get /restapi/v1.0/status | Get Status |
AccountProvisioningApi | BulkAssign | Post /restapi/v1.0/account/{accountId}/department/bulk-assign | Edit Call Queue Members |
AccountProvisioningApi | CreateAccount | Post /restapi/v1.0/account | Create Account |
AccountProvisioningApi | CreateDeviceOrder | Post /restapi/v1.0/account/{accountId}/order | Create Device Order |
AccountProvisioningApi | CreateLicensesOrder | Post /restapi/v1.0/account/{accountId}/licenses/bulk-purchase | Order Licenses |
AccountProvisioningApi | DeleteLicense | Delete /restapi/v1.0/account/{accountId}/licenses/{licenseId} | Delete License |
AccountProvisioningApi | DeletePhoneNumberById | Delete /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId} | Delete Phone Number |
AccountProvisioningApi | GetBrandInfo | Get /restapi/v1.0/dictionary/brand/{brandId} | Get Brand Info |
AccountProvisioningApi | GetDeviceModels | Get /restapi/v1.0/dictionary/device | Get Device Catalog |
AccountProvisioningApi | GetExtensionFreeNumbers | Get /restapi/v1.0/account/{accountId}/extension/free-numbers | Get Free Extension Numbers |
AccountProvisioningApi | GetPagingOnlyGroupDevices | Get /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devices | Get Paging Only Group Devices |
AccountProvisioningApi | GetPagingOnlyGroupUsers | Get /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/users | Get Paging Only Group Users |
AccountProvisioningApi | GetParkLocationUsers | Get /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/users | Get Park Location Users |
AccountProvisioningApi | GetServicePlanInfo | Get /restapi/v1.0/dictionary/service-plan/{servicePlanId} | Get Service Plan |
AccountProvisioningApi | ListAccountDevices | Get /restapi/v1.0/account/{accountId}/device | Get Account Devices |
AccountProvisioningApi | ListAccountPhoneNumbers | Get /restapi/v1.0/account/{accountId}/phone-number | Get All Company Phone Numbers |
AccountProvisioningApi | ListDepartmentMembers | Get /restapi/v1.0/account/{accountId}/department/{departmentId}/members | Get Department Member List |
AccountProvisioningApi | ListExtensionDevices | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/device | Get User Device Info |
AccountProvisioningApi | ListLicenseTypes | Get /restapi/v1.0/dictionary/license-types | Get License Types |
AccountProvisioningApi | ListLicenses | Get /restapi/v1.0/account/{accountId}/licenses | Get License List |
AccountProvisioningApi | ListShippingOptions | Get /restapi/v1.0/dictionary/shipping-options | Get Shipping Options |
AccountProvisioningApi | LoadAccountDevice | Get /restapi/v1.0/account/{accountId}/device/{deviceId} | Get Device Info |
AccountProvisioningApi | LoadAccountPhoneNumber | Get /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId} | Get Phone Number |
AccountProvisioningApi | LoadDeviceOrder | Get /restapi/v1.0/account/{accountId}/order/{orderId} | Get Device Order by ID |
AccountProvisioningApi | LoadLicense | Get /restapi/v1.0/account/{accountId}/licenses/{licenseId} | Get License |
AccountProvisioningApi | LookupPhoneNumbers | Post /restapi/v1.0/number-pool/lookup | Get Numbers |
AccountProvisioningApi | ParsePhoneNumber | Post /restapi/v1.0/number-parser/parse | Parse Phone Number |
AccountProvisioningApi | ProvisionPhoneNumber | Post /restapi/v1.0/account/{accountId}/phone-number | Provision Phone Numbers |
AccountProvisioningApi | ReassignPhoneNumberById | Put /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId} | Reassign Phone Number |
AccountProvisioningApi | ReservePhoneNumbers | Post /restapi/v1.0/number-pool/reserve | Reserve/ Un-reserve Numbers |
AccountProvisioningApi | UpdateDevice | Put /restapi/v1.0/account/{accountId}/device/{deviceId} | Update Device |
AccountProvisioningApi | UpdatePagingOnlyGroupUsersAndDevices | Post /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign | Edit Paging Group Users & Devices |
AccountProvisioningApi | UpdateParkLocationUsers | Post /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/bulk-assign | Adds and/or removes park location users |
ApplicationSettingsApi | CreateSipRegistration | Post /restapi/v1.0/client-info/sip-provision | Register SIP Device |
ApplicationSettingsApi | DeleteCustomData | Delete /restapi/v1.0/client-info/custom-data/{key} | Delete Custom Data |
ApplicationSettingsApi | GetAttachment | Get /restapi/v1.0/client-info/custom-data/{key}/content | Get Custom Data Attachment |
ApplicationSettingsApi | GetCustomData | Get /restapi/v1.0/client-info/custom-data/{key} | Get Custom Data |
ApplicationSettingsApi | GetInProductMessage | Get /restapi/v1.0/client-info/banners | Get In Product Message List |
ApplicationSettingsApi | GetSpecialNumberRules | Get /restapi/v1.0/client-info/special-number-rule | Get Special Numbers Calling Limitation |
ApplicationSettingsApi | LoadClientInfo | Get /restapi/v1.0/client-info | Get App Settings |
ApplicationSettingsApi | LoadPhoneData | Get /restapi/v1.0/number-parser/phonedata.xml | Get Phonedata |
ApplicationSettingsApi | UpdateCustomData | Put /restapi/v1.0/client-info/custom-data/{key} | Create/Update Custom Data |
CallHandlingSettingsApi | BlockNumber | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number | Add Blocked Numbers |
CallHandlingSettingsApi | CreateAnsweringRuleInfo | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule | Create Custom Call Handling Rules |
CallHandlingSettingsApi | CreateCompanyAnsweringRuleInfo | Post /restapi/v1.0/account/{accountId}/answering-rule | Create Company Call Handling Rule |
CallHandlingSettingsApi | CreateExtensionForwardingNumber | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number | Create Forwarding Numbers |
CallHandlingSettingsApi | CreateGreeting | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting | Create User Custom Greeting |
CallHandlingSettingsApi | CreateIVRMenu | Post /restapi/v1.0/account/{accountId}/ivr-menus | Create IVR Menu |
CallHandlingSettingsApi | CreatePrompts | Post /restapi/v1.0/account/{accountId}/ivr-prompts | Create IVR Prompt |
CallHandlingSettingsApi | DeleteAnsweringRule | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} | Delete Call Handling Rule |
CallHandlingSettingsApi | DeleteExtensionForwardingNumber | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} | Delete Forwarding Number |
CallHandlingSettingsApi | DeleteIVRPrompt | Delete /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId} | Delete IVR Prompt |
CallHandlingSettingsApi | GetCompanyGreeting | Post /restapi/v1.0/account/{accountId}/greeting | Create Custom Company Greeting |
CallHandlingSettingsApi | GetForwardingNumber | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} | Get Forwarding Number |
CallHandlingSettingsApi | GetGreeting | Get /restapi/v1.0/dictionary/greeting/{greetingId} | Get Greeting Info |
CallHandlingSettingsApi | GetGreetingByID | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId} | Get Custom Greeting Info |
CallHandlingSettingsApi | GetGreetings | Get /restapi/v1.0/dictionary/greeting | Get Standard Greetings |
CallHandlingSettingsApi | GetIVRMenuById | Get /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId} | Get IVR Menu |
CallHandlingSettingsApi | GetIVRPrompt | Get /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId} | Get IVR Prompt |
CallHandlingSettingsApi | GetIVRPromptContent | Get /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content | Get IVR Prompt Content |
CallHandlingSettingsApi | GetIVRPrompts | Get /restapi/v1.0/account/{accountId}/ivr-prompts | Get IVR Prompts |
CallHandlingSettingsApi | ListBlockedNumbers | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number | Get Blocked Numbers |
CallHandlingSettingsApi | ListCompanyAnsweringRule | Get /restapi/v1.0/account/{accountId}/answering-rule | Get Company Call Handling Rules |
CallHandlingSettingsApi | ListExtensionForwardingNumbers | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number | Get Forwarding Numbers |
CallHandlingSettingsApi | LoadAnsweringRuleInfo | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} | Get Call Handling Rule |
CallHandlingSettingsApi | LoadAnsweringRulesList | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule | Get Call Handling Rules |
CallHandlingSettingsApi | LoadBlockedNumber | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId} | Get Blocked Number |
CallHandlingSettingsApi | LoadBusinesshoursInfo | Get /restapi/v1.0/account/{accountId}/business-hours | Get Company Business Hours |
CallHandlingSettingsApi | LoadCompanyAnsweringRuleInfo | Get /restapi/v1.0/account/{accountId}/answering-rule/{ruleId} | Get Company Call Handling Rule |
CallHandlingSettingsApi | LoadUserBusinessHours | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours | Get User Business Hours |
CallHandlingSettingsApi | RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut | Put /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId} | Update IVR Menu |
CallHandlingSettingsApi | UnblockNumber | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId} | Delete Blocked Number |
CallHandlingSettingsApi | UpdateAnsweringRuleInfo | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} | Update Custom Call Handling Rule |
CallHandlingSettingsApi | UpdateBlockedNumber | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId} | Update Blocked Number |
CallHandlingSettingsApi | UpdateCompanyAnsweringRuleInfo | Put /restapi/v1.0/account/{accountId}/answering-rule/{ruleId} | Update Company Call Handling Rule |
CallHandlingSettingsApi | UpdateCompanyBusinessHours | Put /restapi/v1.0/account/{accountId}/business-hours | Update Company Business Hours |
CallHandlingSettingsApi | UpdateExtensionForwardingNumber | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} | Update Forwarding Numbers |
CallHandlingSettingsApi | UpdateUserBusinessHours | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours | Update User Business Hours |
CallLogApi | DeleteAccountCallLog | Delete /restapi/v1.0/account/{accountId}/call-log | Delete Call Log Records by Filter |
CallLogApi | DeleteAccountCallLogRecord | Delete /restapi/v1.0/account/{accountId}/call-log/{callRecordId} | Delete Account Call Log Record(s) by ID |
CallLogApi | DeleteExtensionCallLog | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log | Delete Call Log Records by Filter |
CallLogApi | GetCallRecords | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId} | Get Call Records by ID |
CallLogApi | ListCallRecordingData | Get /restapi/v1.0/account/{accountId}/recording/{recordingId}/content | Get Call Recordings Data |
CallLogApi | ListCallRecordings | Get /restapi/v1.0/account/{accountId}/recording/{recordingId} | Get Call Recordings |
CallLogApi | ListCompanyActiveCalls | Get /restapi/v1.0/account/{accountId}/active-calls | Get User Active Calls |
CallLogApi | ListExtensionActiveCalls | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls | Get User Active Calls |
CallLogApi | LoadAccountCallLog | Get /restapi/v1.0/account/{accountId}/call-log | Get Call Log Records by Filter |
CallLogApi | LoadAccountCallLogRecord | Get /restapi/v1.0/account/{accountId}/call-log/{callRecordId} | Get Account Call Log Record(s) by ID |
CallLogApi | LoadExtensionCallLog | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log | Get Call Log Records by Filter |
CallLogApi | SyncAccountCallLog | Get /restapi/v1.0/account/{accountId}/call-log-sync | Call Log Synchronization |
CallLogApi | SyncExtensionCallLog | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-sync | Call Log Synchronization |
CompanyContactsApi | CreateBotExtension | Post /restapi/v1.0/account/{accountId}/bot | Create Bot Extension |
CompanyContactsApi | CreateExtension | Post /restapi/v1.0/account/{accountId}/extension | Create Extension |
CompanyContactsApi | ListCompanyDirectoryContacts | Get /restapi/v1.0/account/{accountId}/directory/contacts | Get Company Directory |
CompanyContactsApi | ListExtensions | Get /restapi/v1.0/account/{accountId}/extension | Get Extensions |
CompanyContactsApi | LoadCompanyDirectoryContact | Get /restapi/v1.0/account/{accountId}/directory/contacts/{contactId} | Get Company Directory Contact |
CompanyContactsApi | LoadCompanyDirectoryExtensionNumbers | Get /restapi/v1.0/account/{accountId}/directory/extension-numbers | Get Existing Extension Numbers |
CompanyContactsApi | LoadCompanyDirectoryFederation | Get /restapi/v1.0/account/{accountId}/directory/federation | Get Account Federation |
CompanyContactsApi | LoadCompanyDirectoryFederationConflicts | Get /restapi/v1.0/account/{accountId}/directory/federation-conflicts | Get Account Federation Conflicts |
CompanySettingsApi | DeleteAccount | Delete /restapi/v1.0/account/{accountId} | Delete Account |
CompanySettingsApi | ListDialingPlans | Get /restapi/v1.0/account/{accountId}/dialing-plan | Get Available Dialing Plans |
CompanySettingsApi | LoadAccount | Get /restapi/v1.0/account/{accountId} | Get Company Info |
CompanySettingsApi | LoadAccountBusinessAddress | Get /restapi/v1.0/account/{accountId}/business-address | Get Company Business Address |
CompanySettingsApi | LoadServiceInfo | Get /restapi/v1.0/account/{accountId}/service-info | Get Account Service Info |
CompanySettingsApi | ModifyAccount | Put /restapi/v1.0/account/{accountId} | Update Company |
CompanySettingsApi | UpdateAccountBusinessAddress | Put /restapi/v1.0/account/{accountId}/business-address | Update Company Business Address |
CompanySettingsApi | UpdateServiceInfo | Put /restapi/v1.0/account/{accountId}/service-info | Update Account Service Info [Beta] |
GlipApi | CreateGlipFile | Post /restapi/v1.0/glip/files | Upload File |
GlipApi | CreateGroup | Post /restapi/v1.0/glip/groups | Create Group |
GlipApi | CreatePost | Post /restapi/v1.0/glip/groups/{groupId}/posts | Create Post |
GlipApi | LoadCompany | Get /restapi/v1.0/glip/companies/{companyId} | Get Company Info |
GlipApi | LoadGlipFile | Get /restapi/v1.0/glip/files/{fileId} | Get File Info |
GlipApi | LoadGroup | Get /restapi/v1.0/glip/groups/{groupId} | Get Group |
GlipApi | LoadGroupList | Get /restapi/v1.0/glip/groups | Get User Groups |
GlipApi | LoadPerson | Get /restapi/v1.0/glip/persons/{personId} | Get Person |
GlipApi | LoadPosts | Get /restapi/v1.0/glip/groups/{groupId}/posts | Get Posts |
GlipApi | LoadUnreadMessageCount | Get /restapi/v1.0/glip/profile | Glip Unread Message Count |
GlipApi | UpdateGroup | Post /restapi/v1.0/glip/groups/{groupId}/bulk-assign | Edit Group Members |
MeetingsApi | CreateMeeting | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting | Create Meetings |
MeetingsApi | DeleteMeeting | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId} | Delete Meeting |
MeetingsApi | EndMeeting | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/end | End Meeting |
MeetingsApi | GetLiveMeetings | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting | Get Scheduled Meetings |
MeetingsApi | GetMeetingDetails | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId} | Get Meeting Info |
MeetingsApi | GetMeetingServiceInfo | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-info | Get Meeting Service Info |
MeetingsApi | UpdateMeeting | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId} | Update Meeting |
MessagesApi | DeleteMessage | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId} | Delete Message(s) by ID |
MessagesApi | DeleteMessagesByFilter | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store | Delete Conversations by ID's |
MessagesApi | GetFaxCoverPages | Get /restapi/v1.0/dictionary/fax-cover-page | Get Fax Cover Pages |
MessagesApi | ListMessages | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store | Get Message List |
MessagesApi | LoadMessage | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId} | Get Message(s) by ID |
MessagesApi | LoadMessageAttachment | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId} | Get Message Attachment |
MessagesApi | SendFaxMessage | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax | Create Fax Message |
MessagesApi | SendInternalMessage | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager | Create Pager Message |
MessagesApi | SendSMS | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/sms | Create SMS Message |
MessagesApi | SyncMessages | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-sync | Get Message Sync |
MessagesApi | UpdateMessage | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId} | Update Message(s) by ID |
PhoneNumbersApi | ListExtensionPhoneNumbers | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number | Get Extension Phone Number List |
PresenceApi | AccountPresence | Get /restapi/v1.0/account/{accountId}/presence | Get all user statuses |
PresenceApi | GetMonitoringExtensions | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permission | Get User Presence Permissions |
PresenceApi | GetPresenceLine | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/{lineId} | Get Monitored Extensions by Id |
PresenceApi | GetPresenceStatus | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence | Get User Status |
PresenceApi | ListMonitoredExtensions | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line | Get Monitored Extensions |
PresenceApi | PutMonitoringExtensions | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permission | Update User Presence Permissions |
PresenceApi | UpdatePresenceLines | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line | Update Monitored Extensions |
PresenceApi | UpdatePresenceStatus | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence | Update User Status |
PushNotificationsApi | CreateSubscription | Post /restapi/v1.0/subscription | Create Subscription |
PushNotificationsApi | DeleteSubscription | Delete /restapi/v1.0/subscription/{subscriptionId} | Cancel Subscription |
PushNotificationsApi | GetSubscriptions | Get /restapi/v1.0/subscription | Get Subscriptions |
PushNotificationsApi | LoadSubscription | Get /restapi/v1.0/subscription/{subscriptionId} | Get Subscription |
PushNotificationsApi | RenewSubscription | Post /restapi/v1.0/subscription/{subscriptionId}/renew | Renew Subscription |
PushNotificationsApi | UpdateSubscription | Put /restapi/v1.0/subscription/{subscriptionId} | Renew Subscription / Update Event Filters |
RegionalSettingsApi | ListCountries | Get /restapi/v1.0/dictionary/country | Get Country List |
RegionalSettingsApi | ListLanguages | Get /restapi/v1.0/dictionary/language | Get Language List |
RegionalSettingsApi | ListLocations | Get /restapi/v1.0/dictionary/location | Get Location List |
RegionalSettingsApi | ListTimezones | Get /restapi/v1.0/dictionary/timezone | Get Timezone List |
RegionalSettingsApi | LoadCountry | Get /restapi/v1.0/dictionary/country/{countryId} | Get Country |
RegionalSettingsApi | LoadLanguage | Get /restapi/v1.0/dictionary/language/{languageId} | Get Language |
RegionalSettingsApi | LoadState | Get /restapi/v1.0/dictionary/state/{stateId} | Get State |
RegionalSettingsApi | LoadTimezone | Get /restapi/v1.0/dictionary/timezone/{timezoneId} | Get Timezone |
RegionalSettingsApi | LoadlistStates | Get /restapi/v1.0/dictionary/state | Get State List |
ReportingApi | LoadReportingSettings | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/reporting/settings | Get Reporting Settings |
ReportingApi | UpdateReportingSettings | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/reporting/settings | Update Reporting Settings |
RingOutApi | CancelRingOutCall | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId} | Cancel RingOut Call |
RingOutApi | CancelRingOutCallNew | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId} | Cancel RingOut Call |
RingOutApi | CreateDirectRingOut | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/direct | |
RingOutApi | CreateDirectRingOutNew | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/direct-ring-out | Make Direct RingOut Call |
RingOutApi | GetRingOutCallStatus | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId} | Get Status of RingOut Call |
RingOutApi | GetRingOutCallStatusNew | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId} | Get Status of RingOut Call |
RingOutApi | MakeRingOutCall | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout | Make RingOut Call |
RingOutApi | MakeRingOutCallNew | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out | Make RingOut Call |
RolesAndPermissionsApi | CheckPermission | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check | Check User Permissions |
RolesAndPermissionsApi | GetPermission | Get /restapi/v1.0/dictionary/permission/{permissionId} | Get Permission Info |
RolesAndPermissionsApi | GetPermissionCategory | Get /restapi/v1.0/dictionary/permission-category/{permissionCategoryId} | Get Permission Category |
RolesAndPermissionsApi | GetProfile | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile | Get User Permissions |
RolesAndPermissionsApi | GetSystemRole | Get /restapi/v1.0/dictionary/user-role/{roleId} | Get User Role |
RolesAndPermissionsApi | ListPermissionCategories | Get /restapi/v1.0/dictionary/permission-category | Get Permissions Categories |
RolesAndPermissionsApi | ListPermissions | Get /restapi/v1.0/dictionary/permission | Get Permissions |
RolesAndPermissionsApi | ListSystemRoles | Get /restapi/v1.0/dictionary/user-role | Get Standard User Roles |
RolesAndPermissionsApi | LoadUserRole | Get /restapi/v1.0/account/{accountId}/user-role/default | Get Default User Role |
RolesAndPermissionsApi | UpdateUserRole | Put /restapi/v1.0/account/{accountId}/user-role/default | Set Default User Role |
SCIMApi | CreateUser | Post /scim/v2/Users | Create User |
SCIMApi | DeleteUser | Delete /scim/v2/Users/{id} | Delete User |
SCIMApi | GetServiceProviderConfig | Get /scim/v2/ServiceProviderConfig | Get Service Provider Config |
SCIMApi | GetUserById | Get /scim/v2/Users/{id} | Get User |
SCIMApi | ListUsers | Get /scim/v2/Users | Get User List |
SCIMApi | PatchUser | Patch /scim/v2/Users/{id} | Partially update/patch a user |
SCIMApi | SearchUsersViaPost | Post /scim/v2/Users/.search | search or list users |
SCIMApi | UpdateUser | Put /scim/v2/Users/{id} | Update or replace user |
UserContactsApi | ContactFavorite | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite | Get Favorite Contacts |
UserContactsApi | CreateContact | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact | Create Contact |
UserContactsApi | CreateContacts | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite | Update Favorite Contacts |
UserContactsApi | DeleteContact | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} | Delete Contact(s) by ID |
UserContactsApi | ListContacts | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact | Get Contacts |
UserContactsApi | LoadContact | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} | Get Contact(s) by ID |
UserContactsApi | SyncAddressBook | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync | Address Book Synchronization |
UserContactsApi | UpdateContact | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} | Update Contact(s) by ID |
UserSettingsApi | DeleteExtension | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId} | Delete Extension |
UserSettingsApi | DownloadImage | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Get User Profile Image |
UserSettingsApi | GetNotificationSettings | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings | Get Notification Settings |
UserSettingsApi | ListExtensionGrants | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/grant | Get Extension Grants |
UserSettingsApi | ListSecretQuestions | Get /restapi/v1.0/dictionary/secret-question | Get Secret Questions |
UserSettingsApi | LoadConferencingInfo | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing | Get User Conferencing Settings |
UserSettingsApi | LoadExtensionCallerId | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id | Get Extension Caller ID |
UserSettingsApi | LoadExtensionInfo | Get /restapi/v1.0/account/{accountId}/extension/{extensionId} | Get Extension Info |
UserSettingsApi | LoadExtensionProfileImage | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize} | Get Extension Profile Image (Scaled) |
UserSettingsApi | LoadExtensionUserCredentials | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials | Get User Credentials |
UserSettingsApi | LoadSecretQuestion | Get /restapi/v1.0/dictionary/secret-question/{questionId} | Get Secret Question |
UserSettingsApi | UpdateConferencingInfo | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing | Update User Conferencing Settings |
UserSettingsApi | UpdateExtension | Put /restapi/v1.0/account/{accountId}/extension/{extensionId} | Update Extension |
UserSettingsApi | UpdateExtensionCallerId | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id | Update Extension Caller ID |
UserSettingsApi | UpdateExtensionUserCredentials | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials | Update User Credentials |
UserSettingsApi | UpdateNotificationSettings | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings | Update Notification Settings |
UserSettingsApi | UploadImageByPostForm | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Upload User Profile Image |
UserSettingsApi | UploadImageByPutForm | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Update User Profile Image |
UserSettingsApi | ValidateExtensionUserCredentials | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/validate | Validate User Credentials |
UserSettingsApi | VerifyExtensionUserCredentials | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/verify | Verify Extension User Credentials |
Documentation For Models
- AcceptableLanguageTag
- AcceptableMediaType
- AcceptableToken
- AccessValidationResource
- AccountActiveCallsResponse
- AccountBusinessAddressResource
- AccountCallLogResponse
- AccountDeviceUpdate
- AccountLimits
- AccountLimitsResource
- AccountPhoneNumbers
- AccountPresenceEvent
- AccountPresenceInfo
- AccountResource
- AccountServiceInfo
- AccountServiceInfoResource
- AccountSignupInfoRequest
- AccountStatusInfo
- ActiveCallInfo
- ActiveCallInfoWithoutSip
- ActivePermissionResource
- AdbPresenceInfoResource
- Addon
- AddonInfo
- Address
- AddressBookResource
- AddressBookSync
- AddressFormCountryResource
- AddressFormResource
- AddressInfo
- AddressInfoRequest
- AdminNoticeResource
- AlertInfo
- AnsweringForwardingResource
- AnsweringForwardingRuleResource
- AnsweringRuleInfo
- AnsweringRuleResource
- AnsweringRulesResource
- ApiVersionResource
- ApnsInfo
- ApplicationInfoResource
- ApplicationResource
- ApsInfo
- AssignedRoleResource
- AssignedRolesResource
- AttachmentInfo
- AttachmentInfoReporting
- AudioPromptInfo
- AuthProfileCheckResource
- AuthProfileResource
- AuthenticationScheme
- AuthenticationSchemes
- BannerInfo
- BillingPlanInfo
- BillingPlanResource
- BillingStatementResource
- Binary
- BlacklistEntriesResource
- BlacklistEntryResource
- BlockedNumberInfo
- BlockedNumbersList
- BotExtensionCreation
- BotExtensionCreationRequest
- Brand
- BrandInfo
- BrandResource
- BulkAssignItem
- BulkProvisionExtensionResource
- BulkProvisionUnassignedExtensionsRequestResource
- BulkProvisionUnassignedExtensionsResponseResource
- BulkRoleAssignResource
- BulkSupported
- BusinessAddressInfo
- BusinessHoursResource
- CallLogCallerInfo
- CallLogRecord
- CallLogRecordDeviceInfo
- CallLogRecordLegInfo
- CallLogRecordResource
- CallLogRecordingInfoResource
- CallLogRecordingResource
- CallLogRecords
- CallLogSync
- CallQueueInfo
- CallQueueInfoRequest
- CalledNumberInfo
- CallerIdByDevice
- CallerIdByDeviceInfo
- CallerIdByFeature
- CallerIdByFeatureInfo
- CallerIdDeviceInfo
- CallerIdPhoneInfo
- CallerInfo
- CallerInfoFrom
- CallerInfoTo
- CallerResource
- CallersInfo
- CallersInfoRequest
- CfaAttachments
- CfaRecurrence
- CfaSchedule
- CfaSettingsResource
- CfaView
- ClientApiResponse
- ClientApplicationInfo
- ClientInfoResource
- ClientInfoSpecialNumberResource
- ClientInfoSpecialNumbersResource
- ClientProvisioningHintInfo
- ClientProvisioningHintsInfo
- ClientProvisioningInfo
- ClientProvisioningWebUriInfo
- ClientResource
- CompanyAnsweringRuleCalledNumberInfo
- CompanyAnsweringRuleCalledNumberInfoRequest
- CompanyAnsweringRuleCallersInfoRequest
- CompanyAnsweringRuleExtensionInfoRequest
- CompanyAnsweringRuleInfo
- CompanyAnsweringRuleList
- CompanyAnsweringRuleRangesInfoRequest
- CompanyAnsweringRuleRequest
- CompanyAnsweringRuleScheduleInfo
- CompanyAnsweringRuleScheduleInfoRequest
- CompanyAnsweringRuleTimeIntervalRequest
- CompanyAnsweringRuleUpdate
- CompanyAnsweringRuleWeeklyScheduleInfoRequest
- CompanyBusinessHours
- CompanyBusinessHoursScheduleInfo
- CompanyBusinessHoursUpdateRequest
- CompanyDirectoryAccountInfo
- CompanyDirectoryContactInfo
- CompanyDirectoryContacts
- CompanyDirectoryPhoneNumberInfo
- CompanyDirectoryProfileImageInfo
- ConferencePhoneNumberInfo
- ConferencingInfoResource
- ConferencingNumberResource
- ConflictsInfo
- ContactAddressInfo
- ContactDirectoryEvent
- ContactInfo
- ContactInfoUpdateRequest
- ContactList
- ContactsCollection
- ContactsInput
- ContentDisposition
- ConversationResource
- Cookie
- CountriesResource
- CountryInfo
- CountryResource
- CreateAccountRequest
- CreateAnsweringRuleRequest
- CreateFaxMessageRequest
- CreateForwardingNumberRequest
- CreatePagerMessageRequest
- CreateSipRegistrationRequest
- CreateSipRegistrationResponse
- CreateSmsMessage
- CreateSubscriptionRequest
- Currency
- CustomCompanyGreetingAnsweringRuleInfo
- CustomCompanyGreetingInfo
- CustomCompanyGreetingRequest
- CustomDataApiResponse
- CustomDataAttachmentInfo
- CustomDataRequest
- CustomDataResource
- CustomGreetingAnsweringRuleInfo
- CustomGreetingAnsweringRuleInfoRequest
- CustomGreetingRequest
- DateTimeIntervalResource
- DefaultUserRoleRequest
- DeliveryModeResource
- DepartmentBulkAssignResource
- DepartmentInfo
- DepartmentMemberList
- DepartmentResource
- DetailedCallInfo
- DetailedExtensionPresenceEvent
- DetailedExtensionPresenceWithSipEvent
- DeviceInfoRequest
- DeviceInstance
- DeviceModelExtResource
- DeviceModelExtsResource
- DeviceModelResource
- DeviceOrder
- DeviceOrderCreation
- DeviceOrderResource
- DeviceResource
- DeviceToRegister
- DevicesResource
- DialInNumberResource
- DictionaryGreetingInfo
- DictionaryGreetingList
- DictionaryShippingOptions
- EditGroupRequest
- EditPagingGroupRequest
- EditParkLocationRequest
- EmailInfo
- EmailInfoRequest
- EmailResource
- EmergencyAddress
- EmergencyAddressInfo
- EmergencyAddressInfoRequest
- EmergencyServiceAddressResource
- EnterpriseUser
- EntityTag
- ErrorEntity
- ExtensionActiveCallsResponse
- ExtensionAssignmentResult
- ExtensionCallLogResponse
- ExtensionCallerIdInfo
- ExtensionCountryInfoRequest
- ExtensionCreationRequest
- ExtensionFavoritesEvent
- ExtensionFavoritesPresenceEvent
- ExtensionFormattingLocaleInfoRequest
- ExtensionGrantListEvent
- ExtensionGrantResource
- ExtensionGrantsResource
- ExtensionGreetingLanguageInfoRequest
- ExtensionIdResource
- ExtensionInfo
- ExtensionInfoCallLog
- ExtensionInfoEvent
- ExtensionInfoGrants
- ExtensionInfoIntId
- ExtensionInfoMonitoredLines
- ExtensionInfoProvisionPhoneNumbers
- ExtensionInfoSip
- ExtensionLanguageInfoRequest
- ExtensionListEvent
- ExtensionNotificationInfo
- ExtensionPermissions
- ExtensionPermissionsResource
- ExtensionPresenceEvent
- ExtensionPresenceLineEvent
- ExtensionReferenceResource
- ExtensionRegionalSettingRequest
- ExtensionResource
- ExtensionResourceIntId
- ExtensionSecretQuestionInfo
- ExtensionServiceFeatureInfo
- ExtensionStatusInfo
- ExtensionTimezoneInfoRequest
- ExtensionUpdateRequest
- ExtensionUserCredentailsRequest
- ExtensionUserCredentials
- ExtensionUserGroupsResource
- ExtensionWithRolesCollectionResource
- ExtensionWithRolesResource
- Extensions
- FavoriteCollection
- FavoriteContactResource
- FaxCallerInfo
- FaxCountryInfo
- FaxResendInfo
- FaxResponse
- Feature
- Features
- FederationAccountInfo
- FederationConflicts
- FederationConflictsAccountInfo
- FederationExtensionInfo
- FederationExtensionNumbers
- FederationExtensionNumbersExtensionInfo
- FederationInfo
- FederationMainNumberInfo
- FeeChargeResource
- File
- FilterSupported
- FixedOrderAgents
- FormDataContentDisposition
- FormFieldResource
- FormattingLocaleInfo
- ForwardingInfo
- ForwardingInfoCreateRuleRequest
- ForwardingNumberInfo
- ForwardingNumberInfoRules
- ForwardingNumberInfoRulesCreateRuleRequest
- ForwardingNumberResource
- ForwardingNumbersResource
- GcmData
- GcmInfo
- GetAccountCallLogRecordResponse
- GetAccountDevicesResponse
- GetAccountInfoResponse
- GetCallRecordingResponse
- GetConferencingInfoResponse
- GetCountryInfoConferencing
- GetCountryInfoDictionaryResponse
- GetCountryInfoNumberParser
- GetCountryInfoState
- GetCountryListResponse
- GetDeviceInfoResponse
- GetDialingPlanCountryInfo
- GetDialingPlanInfo
- GetExtensionCallLogRecordResponse
- GetExtensionDevicesResponse
- GetExtensionForwardingNumberListResponse
- GetExtensionGrantListResponse
- GetExtensionInfoResponse
- GetExtensionListResponse
- GetExtensionPhoneNumbersResponse
- GetLocationListResponse
- GetMessageInfoResponse
- GetMessageInfoResponseIntId
- GetMessageList
- GetMessageSyncResponse
- GetMonitoredExtensionsResponse
- GetPresenceExtensionInfo
- GetPresenceInfo
- GetReportingSettingsResponse
- GetRingOutStatusResponse
- GetRingOutStatusResponseIntId
- GetSecretQuestionListResponse
- GetServiceInfoResponse
- GetStateInfoResponse
- GetStateListResponse
- GetTimezoneInfoResponse
- GetTimezoneListResponse
- GetUserBusinessHoursResponse
- GetUserListResponse
- GetVersionResponse
- GetVersionsResponse
- GlipApnsInfo
- GlipCompany
- GlipCreateGroup
- GlipCreatePost
- GlipGroupInfo
- GlipGroupList
- GlipGroupsEvent
- GlipMentionsInfo
- GlipMessageAttachmentAuthorInfo
- GlipMessageAttachmentFieldsInfo
- GlipMessageAttachmentFootnoteInfo
- GlipMessageAttachmentInfo
- GlipMessageAttachmentInfoRequest
- GlipNavigationInfo
- GlipPersonInfo
- GlipPostEvent
- GlipPostInfo
- GlipPosts
- GlipUnreadMessageCount
- GlipUnreadMessageCountEvent
- GlipUnreadMessageCountInfo
- GrantInfo
- GreetingInfo
- GreetingLanguageInfo
- GroupContactsCollection
- GroupResource
- GroupsCollection
- HintResource
- HintsResource
- HomeCountry
- HomeCountryResource
- HostInfoRequest
- InProductMessages
- InboundFaxesInfo
- InboundMessageEvent
- InboundTextsInfo
- IncomingCallEvent
- IncomingCallInformationResource
- InlinedExtensionResource
- InstantMessageEvent
- InternalMessageResource
- IntervalResource
- InvoiceSettingsResource
- IvrMenuActionsInfo
- IvrMenuExtensionInfo
- IvrMenuInfo
- IvrMenuPromptInfo
- IvrPrompts
- LanguageInfo
- LanguageInfoResource
- LanguageInfoResources
- LanguageList
- LanguageResource
- LicenseExtensionInfo
- LicenseFeatureInfo
- LicenseInfo
- LicenseInfoRequest
- LicenseList
- LicenseTypeInfo
- LicenseTypeInfoRequest
- LicenseTypes
- LineInfo
- ListCompanyAnsweringRuleInfo
- Locale
- LocationInfo
- LocationResource
- LocationsResource
- LookupPhoneNumberInfo
- MakeRingOutCallerInfoRequestFrom
- MakeRingOutCallerInfoRequestTo
- MakeRingOutCountryInfo
- MakeRingOutRequest
- MatchingEntityTag
- MediaType
- MeetingExternalUserInfoResource
- MeetingLinks
- MeetingRequestResource
- MeetingResponseResource
- MeetingScheduleResource
- MeetingServiceInfoResource
- MeetingsResource
- MessageAttachmentInfo
- MessageAttachmentInfoIntId
- MessageChanges
- MessageEvent
- MessageInfoResource
- MessageStoreCallerInfoRequest
- MessageStoreCallerInfoResponse
- Messages
- MetaInfo
- MethodInfo
- MethodResource
- MissedCallEvent
- MissedCallsInfo
- ModelInfo
- ModifyAccountBusinessAddressRequest
- ModifySubscriptionRequest
- MonitoringExtensionResource
- MonitoringExtensionsResource
- NameInfo
- NameInfoRequest
- NavigableCollectionResourceExtensionIdResource
- NavigableCollectionResourceUserGroupResource
- Navigation
- NavigationInfo
- NavigationInfoUri
- NewCookie
- NotificationBlacklistedData
- NotificationDeliveryMode
- NotificationDeliveryModeRequest
- NotificationInfo
- NotificationRecipientInfo
- NotificationSettings
- NotificationSettingsUpdateRequest
- NumberPoolPhoneNumberRequest
- NumberPortingRequest
- OptionInfo
- OptionInfoReason
- OrderLicensesRequest
- OrderResource
- OrganizationResource
- OutboundFaxesInfo
- PagesInfoReporting
- Paging
- PagingDeviceInfo
- PagingGroupExtensionInfo
- PagingInfo
- PagingOnlyGroupDevices
- PagingOnlyGroupUsers
- ParameterizedHeader
- ParkLocationResponse
- ParsePhoneNumberRequest
- ParsePhoneNumberResponse
- ParsedNumberResource
- ParsedPhoneNumbersResource
- PatchOperationInfo
- PathPattern
- PatternWithGroups
- PaymentInfoAddressResource
- PaymentInfoCardHolderResource
- PaymentInfoCardResource
- PaymentInfoResource
- Permission
- PermissionCategoryCollectionResource
- PermissionCategoryIdResource
- PermissionCategoryResource
- PermissionCollectionResource
- PermissionIdResource
- PermissionInfo
- PermissionResource
- PersonalContactResource
- PhoneLineResource
- PhoneLinesInfo
- PhoneNumberForProvisioningResource
- PhoneNumberInfo
- PhoneNumberInfoConferencing
- PhoneNumberInfoIntId
- PhoneNumberInfoNumberParser
- PhoneNumberInfoRequest
- PhoneNumberResource
- PhoneNumberResourceIntId
- PhoneNumberStringsResource
- PhoneNumbers
- PhoneNumbersRecordsResource
- PhoneNumbersResource
- PhotoInfo
- PoolRequestResource
- PoolResponseResource
- PostGlipFile
- PresenceExtensionInfo
- PresenceInfoResource
- PresenceLineInfo
- PresenceLineResource
- PresenceLinesNavigationResource
- PresencePermissions
- PresencePermissionsExtensionInfoRequest
- PresetInfo
- Principal
- ProfileImageInfo
- ProfileImageInfoUri
- ProfileImageResource
- PromotionCodeResource
- PromptInfo
- PromptLanguageInfo
- PronouncedNameInfo
- PropertiesDelegate
- ProvisionPhoneNumberRequest
- ProvisioningResource
- PutPresenceResource
- QueueInfo
- RangesInfo
- RcVideoNotificationsEvent
- RcvParticipantsInfo
- RcvRecordingInfo
- Reason
- ReassignPhoneNumberResource
- RecipientInfo
- RecordingInfo
- RecordsCollectionResourceSubscriptionResponse
- RecurrenceInfoReporting
- Reference
- ReferenceInfo
- RegionalSettings
- RegionalSettingsResource
- RegistrationRequest
- RegistrationResponse
- ReportingAttachmentInfo
- ReportingPagesInfo
- ReportingRecurrenceInfo
- ReportingSchedulesInfo
- ReportingSettings
- ReportingViewInfo
- Request
- ReservationDate
- ReservePhoneNumberResource
- ReservePhoneNumbersRecordsResource
- ResourceLink
- ResourceModelComponent
- RingOutCountry
- RingOutFromInfo
- RingOutPhoneNumberInfo
- RingOutResource
- RingOutStatusInfo
- RoleIdResource
- RoleResource
- RolesCollectionResource
- RuleInfo
- RuleInfoCreateRuleRequest
- SaveRequestResource
- ScaledProfileImageResource
- ScheduleInfo
- ScheduleInfoUserBusinessHours
- ScheduleResource
- SchedulesInfoReporting
- ScimErrorResponse
- ScimSearchRequestInfo
- ScimUserPatch
- SecretQuestionInfo
- SecretQuestionInfoResource
- SecretQuestionInfoValidationRequest
- SecretQuestionInfoVerificationRequest
- SecretQuestionsInfoResource
- SecurityContext
- SenderInfo
- ServiceFeatureInfo
- ServiceFeatureValue
- ServiceInfo
- ServiceInfoRequest
- ServiceParameterResource
- ServicePlan
- ServicePlanInfo
- ServicePlanResource
- ServiceProviderConfig
- SessionResource
- SessionsResource
- SetReportingSettingsRequest
- ShippingAddressInfo
- ShippingInfo
- ShippingMethod
- ShippingOptionResource
- ShippingOptionsResource
- ShippingResource
- SignupInfoResource
- SimpleResource
- SipDetailsToRegister
- SipFlags
- SipFlagsRespones
- SipInfo
- SipInfoRequest
- SipInfoResource
- SipInfoResponse
- SiteInfo
- SmsResource
- SpecialNumberFeaturesInfo
- SpecialNumberInfo
- StackTraceElement
- StateResource
- StatesResource
- StatusInfo
- StatusType
- SubResource
- SubscriptionInfo
- SubscriptionRequest
- SubscriptionResponse
- Supported
- SyncCallLogRecords
- SyncInfo
- SyncInfoCallLog
- SyncInfoMessages
- SyncMessages
- TargetServicePlanInfo
- TaskInfo
- TesterFlagsResource
- TimeInterval
- TimezoneInfo
- TimezoneResource
- TimezonesResource
- TouchRequestResource
- TranscriptionResult
- TransferredExtensionInfo
- TransitionInfo
- Type
- UnconditionalForwardingInfo
- UnconditionalForwardingResource
- UpdateAccountRequest
- UpdateAnsweringRuleRequest
- UpdateConferencingInfoRequest
- UpdateForwardingNumberRequest
- UpdateMessageRequest
- UpdatePresenceLinesRequest
- UpdatePresenceLinesResponse
- UriTemplate
- UrnInfoRequest
- UserBusinessHoursScheduleInfo
- UserBusinessHoursUpdate
- UserBusinessHoursUpdateRequest
- UserCallLogRecord
- UserCreationRequest
- UserGroupBulkAssignResource
- UserGroupIdResource
- UserGroupManagerResource
- UserGroupResource
- UserInfo
- UserPresencePermissionsUpdateRequest
- UserUpdateRequest
- ValidateExtensionUserCredentials
- VerifyExtensionUserCredentials
- VersionInfo
- VersionedResource
- VersioningResource
- ViewInfoReporting
- VoicemailInfo
- VoicemailSettingsResource
- VoicemailsInfo
- WebUrisResource
- WeeklyScheduleInfo
Documentation For Authorization
OAuth2
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://platform.devtest.ringcentral.com/restapi/oauth/authorize
- Scopes: N/A
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