ringcentral

package
v0.3.22 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 28, 2024 License: MIT Imports: 21 Imported by: 21

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

  • RingCentral SDKs on Github
  • RingCentral Developer Support Email

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

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

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶ 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶ 

type APIClient struct {
	APIInfoApi *APIInfoApiService

	AccountProvisioningApi *AccountProvisioningApiService

	ApplicationSettingsApi *ApplicationSettingsApiService

	CallHandlingSettingsApi *CallHandlingSettingsApiService

	CallLogApi *CallLogApiService

	CompanyContactsApi *CompanyContactsApiService

	CompanySettingsApi *CompanySettingsApiService

	GlipApi *GlipApiService

	MeetingsApi *MeetingsApiService

	MessagesApi *MessagesApiService

	PhoneNumbersApi *PhoneNumbersApiService

	PresenceApi *PresenceApiService

	PushNotificationsApi *PushNotificationsApiService

	RegionalSettingsApi *RegionalSettingsApiService

	ReportingApi *ReportingApiService

	RingOutApi *RingOutApiService

	RolesAndPermissionsApi *RolesAndPermissionsApiService

	SCIMApi *SCIMApiService

	UserContactsApi *UserContactsApiService

	UserSettingsApi *UserSettingsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the RingCentral Connect Platform API Explorer API v1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶ 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶ 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

func (*APIClient) HTTPClient ¶ 

func (apiClient *APIClient) HTTPClient() *http.Client

type APIInfoApiService ¶ 

type APIInfoApiService service

func (*APIInfoApiService) GetAPIVersion ¶ 

func (a *APIInfoApiService) GetAPIVersion(ctx context.Context) (GetVersionsResponse, *http.Response, error)

APIInfoApiService Get API Versions <p style='font-style:italic;'>Since 1.0.0</p><p>Returns current API version(s) and server info.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetVersionsResponse

func (*APIInfoApiService) GetVersionInfo ¶ 

func (a *APIInfoApiService) GetVersionInfo(ctx context.Context, apiVersion string) (GetVersionResponse, *http.Response, error)

APIInfoApiService Get Version Info <p style='font-style:italic;'>Since 1.0.0</p><p>Returns current API version info by apiVersion.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param apiVersion API version to be requested, for example 'v1.0'

@return GetVersionResponse

func (*APIInfoApiService) LoadAPIStatus ¶ 

func (a *APIInfoApiService) LoadAPIStatus(ctx context.Context) (*http.Response, error)

APIInfoApiService Get Status <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Returns the API status; status '200' means the API is working fine, and '503' means it is temporary unavailable.</p><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type APIKey ¶ 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶ 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶ 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶ 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AcceptableLanguageTag ¶ 

type AcceptableLanguageTag struct {
	Tag        string `json:"tag,omitempty"`
	PrimaryTag string `json:"primaryTag,omitempty"`
	SubTags    string `json:"subTags,omitempty"`
	Quality    int32  `json:"quality,omitempty"`
	AsLocale   Locale `json:"asLocale,omitempty"`
}

type AcceptableMediaType ¶ 

type AcceptableMediaType struct {
	Type            string `json:"type,omitempty"`
	Subtype         string `json:"subtype,omitempty"`
	Quality         int32  `json:"quality,omitempty"`
	WildcardType    bool   `json:"wildcardType,omitempty"`
	WildcardSubtype bool   `json:"wildcardSubtype,omitempty"`
}

type AcceptableToken ¶ 

type AcceptableToken struct {
	Token   string `json:"token,omitempty"`
	Quality int32  `json:"quality,omitempty"`
}

type AccessValidationResource ¶ 

type AccessValidationResource struct {
	Uri            string   `json:"uri,omitempty"`
	ApplicationId  string   `json:"applicationId,omitempty"`
	EndpointId     string   `json:"endpointId,omitempty"`
	SessionId      string   `json:"sessionId,omitempty"`
	CredentialType string   `json:"credentialType,omitempty"`
	Scope          []string `json:"scope,omitempty"`
	AccountId      string   `json:"accountId,omitempty"`
	ExtensionId    string   `json:"extensionId,omitempty"`
	BrandId        string   `json:"brandId,omitempty"`
	TierId         string   `json:"tierId,omitempty"`
}

type AccountActiveCallsResponse ¶ 

type AccountActiveCallsResponse struct {
	// List of call log records
	Records    []CallLogRecord `json:"records"`
	Navigation NavigationInfo  `json:"navigation"`
	Paging     PagingInfo      `json:"paging"`
}

type AccountBusinessAddressResource ¶ 

type AccountBusinessAddressResource struct {
	Uri             string             `json:"uri,omitempty"`
	BusinessAddress ContactAddressInfo `json:"businessAddress,omitempty"`
	Company         string             `json:"company,omitempty"`
	Email           string             `json:"email,omitempty"`
}

type AccountCallLogResponse ¶ 

type AccountCallLogResponse struct {
	// List of call log records
	Records    []CallLogRecord `json:"records"`
	Navigation NavigationInfo  `json:"navigation"`
	Paging     PagingInfo      `json:"paging"`
}

type AccountDeviceUpdate ¶ 

type AccountDeviceUpdate struct {
	EmergencyServiceAddress EmergencyAddressInfoRequest `json:"emergencyServiceAddress,omitempty"`
}

type AccountLimits ¶ 

type AccountLimits struct {
	// The maximum number of free softphone phone lines per user extension
	FreeSoftPhoneLinesPerExtension int32 `json:"freeSoftPhoneLinesPerExtension,omitempty"`
	// The maximum number of participants in RingCentral Meeting hosted by this account's user
	MeetingSize int32 `json:"meetingSize,omitempty"`
	// The maximum number of extensions which can be included in the list of users monitored for Presence
	MaxMonitoredExtensionsPerUser int32 `json:"maxMonitoredExtensionsPerUser,omitempty"`
	// Maximum length for extension numbers of an account; depends on account type. The default value is 5
	MaxExtensionNumberLength int32 `json:"maxExtensionNumberLength,omitempty"`
}

type AccountLimitsResource ¶ 

type AccountLimitsResource struct {
	FreeSoftPhoneLinesPerExtension int32 `json:"freeSoftPhoneLinesPerExtension,omitempty"`
	MeetingSize                    int32 `json:"meetingSize,omitempty"`
	MaxMonitoredExtensionsPerUser  int32 `json:"maxMonitoredExtensionsPerUser,omitempty"`
	MaxFreeDigitalLines            int32 `json:"maxFreeDigitalLines,omitempty"`
}

type AccountPhoneNumbers ¶ 

type AccountPhoneNumbers struct {
	// List of account phone numbers
	Records    []PhoneNumberInfo `json:"records,omitempty"`
	Navigation NavigationInfo    `json:"navigation,omitempty"`
	Paging     PagingInfo        `json:"paging,omitempty"`
}

type AccountPresenceEvent ¶ 

type AccountPresenceEvent struct {
	// Internal identifier of an extension. Optional parameter
	ExtensionId string `json:"extensionId,omitempty"`
	// Telephony presence status. Returned if telephony status is changed.
	TelephonyStatus string `json:"telephonyStatus,omitempty"`
	// Order number of a notification to state the chronology
	Sequence int32 `json:"sequence,omitempty"`
	// Aggregated presence status, calculated from a number of sources
	PresenceStatus string `json:"presenceStatus,omitempty"`
	// User-defined presence status (as previously published by the user)
	UserStatus string `json:"userStatus,omitempty"`
	// Extended DnD (Do not Disturb) status
	DndStatus string `json:"dndStatus,omitempty"`
	// If 'True' enables other extensions to see the extension presence status
	AllowSeeMyPresence bool `json:"allowSeeMyPresence,omitempty"`
	// If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
	RingOnMonitoredCall bool `json:"ringOnMonitoredCall,omitempty"`
	// If 'True' enables the extension user to pick up a monitored line on hold
	PickUpCallsOnHold bool `json:"pickUpCallsOnHold,omitempty"`
}

type AccountPresenceInfo ¶ 

type AccountPresenceInfo struct {
	// Canonical URI of account presence resource
	Uri string `json:"uri,omitempty"`
	// List of Prompts
	Records    []GetPresenceInfo `json:"records,omitempty"`
	Navigation NavigationInfo    `json:"navigation,omitempty"`
	Paging     PagingInfo        `json:"paging,omitempty"`
}

type AccountProvisioningApiService ¶ 

type AccountProvisioningApiService service

func (*AccountProvisioningApiService) BulkAssign ¶ 

func (a *AccountProvisioningApiService) BulkAssign(ctx context.Context, accountId string, localVarOptionals *BulkAssignOpts) (*http.Response, error)

func (*AccountProvisioningApiService) CreateAccount ¶ 

func (a *AccountProvisioningApiService) CreateAccount(ctx context.Context, createAccountRequest CreateAccountRequest) (GetAccountInfoResponse, *http.Response, error)

AccountProvisioningApiService Create Account <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Creates the account in Initial state.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Accounts</td><td>Managing accounts: creating new accounts, viewing and updating account information, deleting existing accounts</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createAccountRequest JSON body

@return GetAccountInfoResponse

func (*AccountProvisioningApiService) CreateDeviceOrder ¶ 

func (a *AccountProvisioningApiService) CreateDeviceOrder(ctx context.Context, accountId string, localVarOptionals *CreateDeviceOrderOpts) (DeviceOrderCreation, *http.Response, error)

func (*AccountProvisioningApiService) CreateLicensesOrder ¶ 

func (a *AccountProvisioningApiService) CreateLicensesOrder(ctx context.Context, accountId string, orderLicensesRequest OrderLicensesRequest) (*http.Response, error)

AccountProvisioningApiService Order Licenses <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Purchases licenses for add-on features: Rooms, Room Connector, Webinar, Live Reports, etc.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param orderLicensesRequest JSON body

func (*AccountProvisioningApiService) DeleteLicense ¶ 

func (a *AccountProvisioningApiService) DeleteLicense(ctx context.Context, accountId string, licenseId string) (*http.Response, error)

AccountProvisioningApiService Delete License <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Removes a license for a specific user. Please note: It is not allowed to remove assigned licenses (only Webinars and Large Meetings can be assigned).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param licenseId Internal identifier of a license

func (*AccountProvisioningApiService) DeletePhoneNumberById ¶ 

func (a *AccountProvisioningApiService) DeletePhoneNumberById(ctx context.Context, phoneNumberId int64, accountId string) (*http.Response, error)

AccountProvisioningApiService Delete Phone Number <p style='font-style:italic;'>Since 1.0.11 (Release 6.3) </p><p>Deletes a phone number belonging to a certain account/extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumberId
  • @param accountId

func (*AccountProvisioningApiService) GetBrandInfo ¶ 

func (a *AccountProvisioningApiService) GetBrandInfo(ctx context.Context, brandId string) (BrandResource, *http.Response, error)

AccountProvisioningApiService Get Brand Info

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param brandId

@return BrandResource

func (*AccountProvisioningApiService) GetDeviceModels ¶ 

func (a *AccountProvisioningApiService) GetDeviceModels(ctx context.Context) (DeviceModelExtsResource, *http.Response, error)

AccountProvisioningApiService Get Device Catalog

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DeviceModelExtsResource

func (*AccountProvisioningApiService) GetExtensionFreeNumbers ¶ 

func (a *AccountProvisioningApiService) GetExtensionFreeNumbers(ctx context.Context, accountId string) (BulkProvisionUnassignedExtensionsResponseResource, *http.Response, error)

AccountProvisioningApiService Get Free Extension Numbers

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId

@return BulkProvisionUnassignedExtensionsResponseResource

func (*AccountProvisioningApiService) GetPagingOnlyGroupDevices ¶ 

func (a *AccountProvisioningApiService) GetPagingOnlyGroupDevices(ctx context.Context, accountId string, pagingOnlyGroupId string, localVarOptionals *GetPagingOnlyGroupDevicesOpts) (PagingOnlyGroupDevices, *http.Response, error)

func (*AccountProvisioningApiService) GetPagingOnlyGroupUsers ¶ 

func (a *AccountProvisioningApiService) GetPagingOnlyGroupUsers(ctx context.Context, accountId string, pagingOnlyGroupId string, localVarOptionals *GetPagingOnlyGroupUsersOpts) (PagingOnlyGroupUsers, *http.Response, error)

func (*AccountProvisioningApiService) GetParkLocationUsers ¶ 

func (a *AccountProvisioningApiService) GetParkLocationUsers(ctx context.Context, accountId string, parkLocationId string, localVarOptionals *GetParkLocationUsersOpts) (ParkLocationResponse, *http.Response, error)

func (*AccountProvisioningApiService) GetServicePlanInfo ¶ 

func (a *AccountProvisioningApiService) GetServicePlanInfo(ctx context.Context, servicePlanId string) (ServicePlanResource, *http.Response, error)

AccountProvisioningApiService Get Service Plan

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param servicePlanId

@return ServicePlanResource

func (*AccountProvisioningApiService) ListAccountDevices ¶ 

func (a *AccountProvisioningApiService) ListAccountDevices(ctx context.Context, accountId string) (GetAccountDevicesResponse, *http.Response, error)

AccountProvisioningApiService Get Account Devices <p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns all the devices for a particular extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return GetAccountDevicesResponse

func (*AccountProvisioningApiService) ListAccountPhoneNumbers ¶ 

func (a *AccountProvisioningApiService) ListAccountPhoneNumbers(ctx context.Context, accountId string, localVarOptionals *ListAccountPhoneNumbersOpts) (AccountPhoneNumbers, *http.Response, error)

func (*AccountProvisioningApiService) ListDepartmentMembers ¶ 

func (a *AccountProvisioningApiService) ListDepartmentMembers(ctx context.Context, accountId string, departmentId int32, localVarOptionals *ListDepartmentMembersOpts) (DepartmentMemberList, *http.Response, error)

func (*AccountProvisioningApiService) ListExtensionDevices ¶ 

func (a *AccountProvisioningApiService) ListExtensionDevices(ctx context.Context, accountId string, extensionId string, localVarOptionals *ListExtensionDevicesOpts) (GetExtensionDevicesResponse, *http.Response, error)

func (*AccountProvisioningApiService) ListLicenseTypes ¶ 

func (a *AccountProvisioningApiService) ListLicenseTypes(ctx context.Context) (LicenseTypes, *http.Response, error)

AccountProvisioningApiService Get License Types <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns supported license types.</p><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LicenseTypes

func (*AccountProvisioningApiService) ListLicenses ¶ 

func (a *AccountProvisioningApiService) ListLicenses(ctx context.Context, accountId string, localVarOptionals *ListLicensesOpts) (LicenseList, *http.Response, error)

func (*AccountProvisioningApiService) ListShippingOptions ¶ 

func (a *AccountProvisioningApiService) ListShippingOptions(ctx context.Context, localVarOptionals *ListShippingOptionsOpts) (DictionaryShippingOptions, *http.Response, error)

func (*AccountProvisioningApiService) LoadAccountDevice ¶ 

func (a *AccountProvisioningApiService) LoadAccountDevice(ctx context.Context, accountId string, deviceId string) (GetDeviceInfoResponse, *http.Response, error)

AccountProvisioningApiService Get Device Info <p style='font-style:italic;'>Since 1.0.9 (Release 6.1)</p><p>Returns account device(s) by their ID(s).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param deviceId Internal identifier of a device

@return GetDeviceInfoResponse

func (*AccountProvisioningApiService) LoadAccountPhoneNumber ¶ 

func (a *AccountProvisioningApiService) LoadAccountPhoneNumber(ctx context.Context, accountId string, phoneNumberId int32) (PhoneNumberInfo, *http.Response, error)

AccountProvisioningApiService Get Phone Number <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param phoneNumberId Internal identifier of a phone number

@return PhoneNumberInfo

func (*AccountProvisioningApiService) LoadDeviceOrder ¶ 

func (a *AccountProvisioningApiService) LoadDeviceOrder(ctx context.Context, accountId string, orderId int32) (DeviceOrder, *http.Response, error)

AccountProvisioningApiService Get Device Order by ID <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param orderId Internal identifier of an order

@return DeviceOrder

func (*AccountProvisioningApiService) LoadLicense ¶ 

func (a *AccountProvisioningApiService) LoadLicense(ctx context.Context, accountId string, licenseId string) (LicenseInfo, *http.Response, error)

AccountProvisioningApiService Get License <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns license information by its ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param licenseId Internal identifier of a license

@return LicenseInfo

func (*AccountProvisioningApiService) LookupPhoneNumbers ¶ 

func (a *AccountProvisioningApiService) LookupPhoneNumbers(ctx context.Context, localVarOptionals *LookupPhoneNumbersOpts) (PhoneNumbers, *http.Response, error)

func (*AccountProvisioningApiService) ParsePhoneNumber ¶ 

func (a *AccountProvisioningApiService) ParsePhoneNumber(ctx context.Context, parsePhoneNumberRequest ParsePhoneNumberRequest, localVarOptionals *ParsePhoneNumberOpts) (ParsePhoneNumberResponse, *http.Response, error)

func (*AccountProvisioningApiService) ProvisionPhoneNumber ¶ 

func (a *AccountProvisioningApiService) ProvisionPhoneNumber(ctx context.Context, accountId string, provisionPhoneNumberRequest ProvisionPhoneNumberRequest) (PhoneNumberInfo, *http.Response, error)

AccountProvisioningApiService Provision Phone Numbers <p style='font-style:italic;'>Since 1.0.11 (Release 6.3)</p><p>Provisions a phone number.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param provisionPhoneNumberRequest JSON body

@return PhoneNumberInfo

func (*AccountProvisioningApiService) ReassignPhoneNumberById ¶ 

func (a *AccountProvisioningApiService) ReassignPhoneNumberById(ctx context.Context, phoneNumberId int64, accountId string, localVarOptionals *ReassignPhoneNumberByIdOpts) (PhoneNumberResource, *http.Response, error)

func (*AccountProvisioningApiService) ReservePhoneNumbers ¶ 

func (a *AccountProvisioningApiService) ReservePhoneNumbers(ctx context.Context, numberPoolPhoneNumberRequest NumberPoolPhoneNumberRequest) (ReservePhoneNumbersRecordsResource, *http.Response, error)

AccountProvisioningApiService Reserve/ Un-reserve Numbers <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>NumberLookup</td><td>Looking-up and reserving available phone number</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param numberPoolPhoneNumberRequest JSON body

@return ReservePhoneNumbersRecordsResource

func (*AccountProvisioningApiService) UpdateDevice ¶ 

func (a *AccountProvisioningApiService) UpdateDevice(ctx context.Context, accountId string, deviceId string, accountDeviceUpdate AccountDeviceUpdate) (DeviceResource, *http.Response, error)

AccountProvisioningApiService Update Device

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param deviceId
  • @param accountDeviceUpdate

@return DeviceResource

func (*AccountProvisioningApiService) UpdatePagingOnlyGroupUsersAndDevices ¶ 

func (a *AccountProvisioningApiService) UpdatePagingOnlyGroupUsersAndDevices(ctx context.Context, accountId string, pagingOnlyGroupId string, localVarOptionals *UpdatePagingOnlyGroupUsersAndDevicesOpts) (*http.Response, error)

func (*AccountProvisioningApiService) UpdateParkLocationUsers ¶ 

func (a *AccountProvisioningApiService) UpdateParkLocationUsers(ctx context.Context, accountId string, parkLocationId string, localVarOptionals *UpdateParkLocationUsersOpts) (*http.Response, error)

type AccountResource ¶ 

type AccountResource struct {
	Uri              string                     `json:"uri,omitempty"`
	Id               string                     `json:"id,omitempty"`
	ServiceInfo      AccountServiceInfoResource `json:"serviceInfo,omitempty"`
	PartnerId        string                     `json:"partnerId,omitempty"`
	Operator         ExtensionResource          `json:"operator"`
	MainNumber       string                     `json:"mainNumber,omitempty"`
	ReservationId    string                     `json:"reservationId,omitempty"`
	SessionId        string                     `json:"sessionId,omitempty"`
	Status           string                     `json:"status,omitempty"`
	StatusInfo       StatusInfo                 `json:"statusInfo,omitempty"`
	SignupInfo       SignupInfoResource         `json:"signupInfo,omitempty"`
	SetupWizardState string                     `json:"setupWizardState,omitempty"`
	TesterFlags      []string                   `json:"testerFlags,omitempty"`
	PromotionCode    string                     `json:"promotionCode,omitempty"`
}

type AccountServiceInfo ¶ 

type AccountServiceInfo struct {
	// Canonical URI of the account Service Info resource
	Uri string `json:"uri,omitempty"`
	// Account Service Plan name
	ServicePlanName string          `json:"servicePlanName,omitempty"`
	Brand           BrandInfo       `json:"brand,omitempty"`
	ServicePlan     ServicePlanInfo `json:"servicePlan,omitempty"`
	BillingPlan     BillingPlanInfo `json:"billingPlan,omitempty"`
	// Service features information, see Service Feature List
	ServiceFeatures []ServiceFeatureInfo `json:"serviceFeatures,omitempty"`
	Limits          AccountLimits        `json:"limits,omitempty"`
}

type AccountServiceInfoResource ¶ 

type AccountServiceInfoResource struct {
	Uri               string                `json:"uri,omitempty"`
	ServicePlanName   string                `json:"servicePlanName,omitempty"`
	Brand             Brand                 `json:"brand,omitempty"`
	ServicePlan       ServicePlan           `json:"servicePlan,omitempty"`
	TargetServicePlan ServicePlan           `json:"targetServicePlan,omitempty"`
	BillingPlan       BillingPlanResource   `json:"billingPlan,omitempty"`
	ServiceFeatures   []ServiceFeatureValue `json:"serviceFeatures,omitempty"`
	Limits            AccountLimitsResource `json:"limits,omitempty"`
}

type AccountSignupInfoRequest ¶ 

type AccountSignupInfoRequest struct {
	//  Specifies whether marketing information is sent to the user
	MarketingAccepted bool `json:"marketingAccepted,omitempty"`
}

type AccountStatusInfo ¶ 

type AccountStatusInfo struct {
	// A free-form user comment, describing the status change reason
	Comment string `json:"comment,omitempty"`
	// Type of suspension
	Reason string `json:"reason,omitempty"`
	// Date until which the account will get deleted. The default value is 30 days since current date
	Till string `json:"till,omitempty"`
}

type ActiveCallInfo ¶ 

type ActiveCallInfo struct {
	// Internal identifier of a call
	Id string `json:"id,omitempty"`
	// Call direction
	Direction string `json:"direction,omitempty"`
	// Phone number or extension number of a caller
	From string `json:"from,omitempty"`
	// Phone number or extension number of a callee
	To string `json:"to,omitempty"`
	// Telephony call status
	TelephonyStatus string           `json:"telephonyStatus,omitempty"`
	SipData         DetailedCallInfo `json:"sipData,omitempty"`
	// Internal identifier of a call session
	SessionId string `json:"sessionId,omitempty"`
	// Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices
	TerminationType string `json:"terminationType,omitempty"`
}

type ActiveCallInfoWithoutSip ¶ 

type ActiveCallInfoWithoutSip struct {
	// Internal identifier of a call
	Id string `json:"id,omitempty"`
	// Call direction
	Direction string `json:"direction,omitempty"`
	// Phone number or extension number of a caller
	From string `json:"from,omitempty"`
	// Phone number or extension number of a callee
	To string `json:"to,omitempty"`
	// Telephony call status
	TelephonyStatus string `json:"telephonyStatus,omitempty"`
	// Internal identifier of a call session
	SessionId string `json:"sessionId,omitempty"`
	// Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices
	TerminationType string `json:"terminationType,omitempty"`
}

type ActivePermissionResource ¶ 

type ActivePermissionResource struct {
	Permission    PermissionIdResource `json:"permission,omitempty"`
	EffectiveRole RoleIdResource       `json:"effectiveRole,omitempty"`
	Scopes        []string             `json:"scopes,omitempty"`
}

type AdbPresenceInfoResource ¶ 

type AdbPresenceInfoResource struct {
	AccountId                string `json:"accountId,omitempty"`
	ExtensionId              string `json:"extensionId,omitempty"`
	ExtensionType            string `json:"extensionType,omitempty"`
	ExtensionStatus          string `json:"extensionStatus,omitempty"`
	DndStatus                string `json:"dndStatus,omitempty"`
	UserStatus               string `json:"userStatus,omitempty"`
	Message                  string `json:"message,omitempty"`
	AgentStatus              string `json:"agentStatus,omitempty"`
	ExtensionNumber          string `json:"extensionNumber,omitempty"`
	AllowSeeMyPresence       bool   `json:"allowSeeMyPresence,omitempty"`
	RingOnMonitoredCall      bool   `json:"ringOnMonitoredCall,omitempty"`
	PickUpCallsOnHold        bool   `json:"pickUpCallsOnHold,omitempty"`
	PresenceFeatureAvailable bool   `json:"presenceFeatureAvailable,omitempty"`
	DndFeatureAvailable      bool   `json:"dndFeatureAvailable,omitempty"`
}

type Addon ¶ 

type Addon struct {
	Id    string `json:"id,omitempty"`
	Name  string `json:"name,omitempty"`
	Count int32  `json:"count,omitempty"`
}

type AddonInfo ¶ 

type AddonInfo struct {
	Id    string `json:"id,omitempty"`
	Count string `json:"count,omitempty"`
}

type Address ¶ 

type Address struct {
	Country string `json:"country,omitempty"`
	State   string `json:"state,omitempty"`
	City    string `json:"city,omitempty"`
	Street  string `json:"street,omitempty"`
	Zip     string `json:"zip,omitempty"`
}

type AddressBookResource ¶ 

type AddressBookResource struct {
	Uri      string       `json:"uri,omitempty"`
	Contacts ResourceLink `json:"contacts,omitempty"`
	Groups   ResourceLink `json:"groups,omitempty"`
}

type AddressBookSync ¶ 

type AddressBookSync struct {
	Uri         string                    `json:"uri,omitempty"`
	Records     []PersonalContactResource `json:"records,omitempty"`
	SyncInfo    SyncInfo                  `json:"syncInfo,omitempty"`
	NextPageId  int64                     `json:"nextPageId,omitempty"`
	NextPageUri string                    `json:"nextPageUri,omitempty"`
}

type AddressFormCountryResource ¶ 

type AddressFormCountryResource struct {
	Uri             string              `json:"uri,omitempty"`
	Country         CountryResource     `json:"country,omitempty"`
	Attributes      []FormFieldResource `json:"attributes,omitempty"`
	EmergencyNumber string              `json:"emergencyNumber,omitempty"`
	Default         bool                `json:"default,omitempty"`
}

type AddressFormResource ¶ 

type AddressFormResource struct {
	Uri     string                       `json:"uri,omitempty"`
	Records []AddressFormCountryResource `json:"records,omitempty"`
}

type AddressInfo ¶ 

type AddressInfo struct {
	// User street address
	StreetAddress string `json:"streetAddress,omitempty"`
	// User city
	Locality string `json:"locality,omitempty"`
	// User state/region
	Region string `json:"region,omitempty"`
	// User postal code
	PostalCode string `json:"postalCode,omitempty"`
	// User country
	Country string `json:"country,omitempty"`
	// Address type
	Type string `json:"type,omitempty"`
}

type AddressInfoRequest ¶ 

type AddressInfoRequest struct {
	// User street address
	StreetAddress string `json:"streetAddress,omitempty"`
	// User city
	Locality string `json:"locality,omitempty"`
	// User state/region
	Region string `json:"region,omitempty"`
	// User postal code
	PostalCode string `json:"postalCode,omitempty"`
	// User country
	Country string `json:"country,omitempty"`
	// Address type
	Type string `json:"type,omitempty"`
}

type AdminNoticeResource ¶ 

type AdminNoticeResource struct {
	SubjectCode string `json:"subjectCode,omitempty"`
	Message     string `json:"message,omitempty"`
}

type AlertInfo ¶ 

type AlertInfo struct {
	// Title of a message
	Title string `json:"title,omitempty"`
	// Message Description
	Body string `json:"body,omitempty"`
}

type AnsweringForwardingResource ¶ 

type AnsweringForwardingResource struct {
	NotifyMySoftPhones    bool                              `json:"notifyMySoftPhones,omitempty"`
	NotifyAdminSoftPhones bool                              `json:"notifyAdminSoftPhones,omitempty"`
	SoftPhonesRingCount   int32                             `json:"softPhonesRingCount,omitempty"`
	RingingMode           string                            `json:"ringingMode,omitempty"`
	Rules                 []AnsweringForwardingRuleResource `json:"rules,omitempty"`
}

type AnsweringForwardingRuleResource ¶ 

type AnsweringForwardingRuleResource struct {
	Index             int32                      `json:"index,omitempty"`
	RingCount         int32                      `json:"ringCount,omitempty"`
	ForwardingNumbers []ForwardingNumberResource `json:"forwardingNumbers,omitempty"`
}

type AnsweringRuleInfo ¶ 

type AnsweringRuleInfo struct {
	// Canonical URI to the answering rule resource
	Uri string `json:"uri,omitempty"`
	// Internal identifier of an answering rule
	Id string `json:"id,omitempty"`
	// Type of an answering rule
	Type string `json:"type,omitempty"`
	// Name of an answering rule specified by user
	Name string `json:"name,omitempty"`
	// Specifies if an answering rule is active or inactive
	Enabled  bool         `json:"enabled,omitempty"`
	Schedule ScheduleInfo `json:"schedule,omitempty"`
	// Answering rules are applied when calling to selected number(s)
	CalledNumbers []CalledNumberInfo `json:"calledNumbers,omitempty"`
	// Answering rules are applied when calls are received from specified caller(s)
	Callers []CallersInfo `json:"callers,omitempty"`
	// Specifies how incoming calls are forwarded
	CallHandlingAction      string                      `json:"callHandlingAction,omitempty"`
	Forwarding              ForwardingInfo              `json:"forwarding,omitempty"`
	UnconditionalForwarding UnconditionalForwardingInfo `json:"unconditionalForwarding,omitempty"`
	Queue                   QueueInfo                   `json:"queue,omitempty"`
	Transfer                TransferredExtensionInfo    `json:"transfer,omitempty"`
	Voicemail               VoicemailInfo               `json:"voicemail,omitempty"`
	// Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
	Greetings []GreetingInfo `json:"greetings,omitempty"`
}

type AnsweringRuleResource ¶ 

type AnsweringRuleResource struct {
	Uri                     string                          `json:"uri,omitempty"`
	Id                      string                          `json:"id,omitempty"`
	Type                    string                          `json:"type,omitempty"`
	Name                    string                          `json:"name,omitempty"`
	Enabled                 bool                            `json:"enabled,omitempty"`
	Schedule                ScheduleResource                `json:"schedule,omitempty"`
	Callers                 []CallerResource                `json:"callers,omitempty"`
	CalledNumbers           []PhoneNumberResource           `json:"calledNumbers,omitempty"`
	CallHandlingAction      string                          `json:"callHandlingAction,omitempty"`
	Forwarding              AnsweringForwardingResource     `json:"forwarding,omitempty"`
	UnconditionalForwarding UnconditionalForwardingResource `json:"unconditionalForwarding,omitempty"`
	Voicemail               VoicemailSettingsResource       `json:"voicemail,omitempty"`
}

type AnsweringRulesResource ¶ 

type AnsweringRulesResource struct {
	Uri        string                  `json:"uri,omitempty"`
	Records    []AnsweringRuleResource `json:"records,omitempty"`
	Paging     Paging                  `json:"paging,omitempty"`
	Navigation Navigation              `json:"navigation,omitempty"`
}

type ApiVersionResource ¶ 

type ApiVersionResource struct {
	Uri           string    `json:"uri,omitempty"`
	VersionString string    `json:"versionString,omitempty"`
	ReleaseDate   time.Time `json:"releaseDate,omitempty"`
	UriString     string    `json:"uriString,omitempty"`
}

type ApnsInfo ¶ 

type ApnsInfo struct {
	Aps ApsInfo `json:"aps,omitempty"`
}

type ApplicationInfoResource ¶ 

type ApplicationInfoResource struct {
	ClientId    string              `json:"clientId,omitempty"`
	Application ApplicationResource `json:"application,omitempty"`
}

type ApplicationResource ¶ 

type ApplicationResource struct {
	Id           string               `json:"id,omitempty"`
	Name         string               `json:"name,omitempty"`
	Description  string               `json:"description,omitempty"`
	Organization OrganizationResource `json:"organization,omitempty"`
	Scope        string               `json:"scope,omitempty"`
	PlatformType string               `json:"platformType,omitempty"`
	Permissions  []PermissionResource `json:"permissions,omitempty"`
}

type ApplicationSettingsApiService ¶ 

type ApplicationSettingsApiService service

func (*ApplicationSettingsApiService) CreateSipRegistration ¶ 

func (a *ApplicationSettingsApiService) CreateSipRegistration(ctx context.Context, createSipRegistrationRequest CreateSipRegistrationRequest) (CreateSipRegistrationResponse, *http.Response, error)

ApplicationSettingsApiService Register SIP Device <p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Creates SIP registration of a device/application (WebPhone, Mobile, softphone)</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>VoipCalling</td><td>Registering as VoIP device and making VoIP calls</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createSipRegistrationRequest JSON body

@return CreateSipRegistrationResponse

func (*ApplicationSettingsApiService) DeleteCustomData ¶ 

func (a *ApplicationSettingsApiService) DeleteCustomData(ctx context.Context, key int32) (*http.Response, error)

ApplicationSettingsApiService Delete Custom Data <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Deletes custom data by its ID.<p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension

func (*ApplicationSettingsApiService) GetAttachment ¶ 

func (a *ApplicationSettingsApiService) GetAttachment(ctx context.Context, key string, localVarOptionals *GetAttachmentOpts) (*http.Response, error)

func (*ApplicationSettingsApiService) GetCustomData ¶ 

func (a *ApplicationSettingsApiService) GetCustomData(ctx context.Context, key int32) (CustomDataResource, *http.Response, error)

ApplicationSettingsApiService Get Custom Data <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Returns custom data of a logged-in extension.<p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension

@return CustomDataResource

func (*ApplicationSettingsApiService) GetInProductMessage ¶ 

func (a *ApplicationSettingsApiService) GetInProductMessage(ctx context.Context, bannerType string) (InProductMessages, *http.Response, error)

ApplicationSettingsApiService Get In Product Message List <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns list of in-product messages: learderboards, announcements, etc. Please note: Banners are set on Marketing/Messages tab in Admin Web.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadClientInfo</td><td>Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param bannerType

@return InProductMessages

func (*ApplicationSettingsApiService) GetSpecialNumberRules ¶ 

func (a *ApplicationSettingsApiService) GetSpecialNumberRules(ctx context.Context, localVarOptionals *GetSpecialNumberRulesOpts) (NavigationInfo, *http.Response, error)

func (*ApplicationSettingsApiService) LoadClientInfo ¶ 

func (a *ApplicationSettingsApiService) LoadClientInfo(ctx context.Context) (ClientApiResponse, *http.Response, error)

ApplicationSettingsApiService Get App Settings <p style='font-style:italic;'>Since 1.0.11 (Release 6.3)</p><p>Returns client application data: general info, specific provisioning parameters, hints, etc.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadClientInfo</td><td>Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.)</td></tr></tbody></table>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ClientApiResponse

func (*ApplicationSettingsApiService) LoadPhoneData ¶ 

func (a *ApplicationSettingsApiService) LoadPhoneData(ctx context.Context) (*http.Response, error)

ApplicationSettingsApiService Get Phonedata <p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns configuration settings for phone number parser in a phonedata.xml file.</p><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*ApplicationSettingsApiService) UpdateCustomData ¶ 

func (a *ApplicationSettingsApiService) UpdateCustomData(ctx context.Context, key int32, customDataRequest CustomDataRequest) (CustomDataApiResponse, *http.Response, error)

ApplicationSettingsApiService Create/Update Custom Data <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Creates or updates custom data for the extension that is currently logged in.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCustomData</td><td>Viewing and updating client custom data (key-value)</td></tr></tbody></table>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension
  • @param customDataRequest JSON body

@return CustomDataApiResponse

type ApsInfo ¶ 

type ApsInfo struct {
	// If the value is '1' then notification is turned on even if the application is in background
	ContentAvailable int32 `json:"content-available,omitempty"`
}

type AssignedRoleResource ¶ 

type AssignedRoleResource struct {
	Uri          string `json:"uri,omitempty"`
	Id           string `json:"id,omitempty"`
	AutoAssigned bool   `json:"autoAssigned,omitempty"`
	DisplayName  string `json:"displayName,omitempty"`
}

type AssignedRolesResource ¶ 

type AssignedRolesResource struct {
	Uri     string                 `json:"uri,omitempty"`
	Records []AssignedRoleResource `json:"records,omitempty"`
}

type AttachmentInfo ¶ 

type AttachmentInfo struct {
	Uri         string `json:"uri,omitempty"`
	ContentType string `json:"contentType,omitempty"`
}

type AttachmentInfoReporting ¶ 

type AttachmentInfoReporting struct {
	// Specifies whether to include CSV version of the report
	Csv bool `json:"csv,omitempty"`
	// Specifies whether to include PDF version of the report
	Pdf bool `json:"pdf,omitempty"`
}

type AudioPromptInfo ¶ 

type AudioPromptInfo struct {
	// Link to an prompt audio file
	Uri string `json:"uri,omitempty"`
	// Internal identifier of an prompt
	Id string `json:"id,omitempty"`
}

type AuthProfileCheckResource ¶ 

type AuthProfileCheckResource struct {
	Uri        string                   `json:"uri,omitempty"`
	Successful bool                     `json:"successful,omitempty"`
	Details    ActivePermissionResource `json:"details,omitempty"`
}

type AuthProfileResource ¶ 

type AuthProfileResource struct {
	Uri         string                     `json:"uri,omitempty"`
	Permissions []ActivePermissionResource `json:"permissions,omitempty"`
}

type AuthenticationScheme ¶ 

type AuthenticationScheme struct {
	Description      string `json:"description,omitempty"`
	DocumentationUrl string `json:"documentationUrl,omitempty"`
	Name             string `json:"name,omitempty"`
	SpecUrl          string `json:"specUrl,omitempty"`
}

type AuthenticationSchemes ¶ 

type AuthenticationSchemes struct {
	AuthenticationSchemes []AuthenticationScheme `json:"authenticationSchemes,omitempty"`
}

type BannerInfo ¶ 

type BannerInfo struct {
	// Type of a banner
	BannerType string `json:"bannerType,omitempty"`
	// Custom text description of a banner
	Description string `json:"description,omitempty"`
	// HTML formatted message content
	Content string `json:"content,omitempty"`
	// Datetime of message expiration in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	ExpirationDate string `json:"expirationDate,omitempty"`
}

type BasicAuth ¶ 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BillingPlanInfo ¶ 

type BillingPlanInfo struct {
	// Internal identifier of a billing plan
	Id string `json:"id,omitempty"`
	// Billing plan name
	Name string `json:"name,omitempty"`
	// Duration period
	DurationUnit string `json:"durationUnit,omitempty"`
	// Number of duration units
	Duration string `json:"duration,omitempty"`
	// Billing plan type
	Type string `json:"type,omitempty"`
}

type BillingPlanResource ¶ 

type BillingPlanResource struct {
	Uri          string `json:"uri,omitempty"`
	Id           string `json:"id,omitempty"`
	Name         string `json:"name,omitempty"`
	DurationUnit string `json:"durationUnit,omitempty"`
	Duration     int32  `json:"duration,omitempty"`
	Type         string `json:"type,omitempty"`
}

type BillingStatementResource ¶ 

type BillingStatementResource struct {
	Fees         []FeeChargeResource `json:"fees,omitempty"`
	Charges      []FeeChargeResource `json:"charges,omitempty"`
	TotalCharges float32             `json:"totalCharges,omitempty"`
	TotalFees    float32             `json:"totalFees,omitempty"`
	Subtotal     float32             `json:"subtotal,omitempty"`
	Currency     string              `json:"currency,omitempty"`
}

type Binary ¶ 

type Binary struct {
	// Required Binary Data
	Data *os.File `json:"data,omitempty"`
}

type BlacklistEntriesResource ¶ 

type BlacklistEntriesResource struct {
	Uri        string                   `json:"uri,omitempty"`
	Records    []BlacklistEntryResource `json:"records,omitempty"`
	Paging     Paging                   `json:"paging,omitempty"`
	Navigation Navigation               `json:"navigation,omitempty"`
}

type BlacklistEntryResource ¶ 

type BlacklistEntryResource struct {
	Uri         string `json:"uri,omitempty"`
	Id          string `json:"id,omitempty"`
	PhoneNumber string `json:"phoneNumber,omitempty"`
	Name        string `json:"name,omitempty"`
}

type BlockNumberOpts ¶ 

type BlockNumberOpts struct {
	BlockedNumberInfo optional.Interface
}

type BlockedNumberInfo ¶ 

type BlockedNumberInfo struct {
	// Internal identifier of a blocked number
	Id string `json:"id,omitempty"`
	// Canonical URI of a blocked number
	Uri string `json:"uri,omitempty"`
	// Name assigned by a user to a blocked phone number
	Name string `json:"name,omitempty"`
	// Phone number to be blocked
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type BlockedNumbersList ¶ 

type BlockedNumbersList struct {
	// List of blocked phone numbers
	Records    []BlockedNumberInfo `json:"records,omitempty"`
	Navigation NavigationInfo      `json:"navigation,omitempty"`
	Paging     PagingInfo          `json:"paging,omitempty"`
}

type BotExtensionCreation ¶ 

type BotExtensionCreation struct {
	// Link to a bot extension resource
	Uri string `json:"uri,omitempty"`
	// Internal identifier of a bot extension
	Id string `json:"id,omitempty"`
	// Bot extension number
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Bot name (equals to extension first name)
	Name string `json:"name,omitempty"`
	// Identifier key of a bot application
	ApplicationKey string `json:"applicationKey,omitempty"`
	// User extension identifier
	CreatorId string `json:"creatorId,omitempty"`
}

type BotExtensionCreationRequest ¶ 

type BotExtensionCreationRequest struct {
	// Bot name (equals to extension first name)
	Name string `json:"name,omitempty"`
	// Key of a bot application
	ApplicationKey string `json:"applicationKey,omitempty"`
	// User extension identifier
	CreatorId string `json:"creatorId,omitempty"`
}

type Brand ¶ 

type Brand struct {
	Id          string      `json:"id,omitempty"`
	Name        string      `json:"name,omitempty"`
	HomeCountry HomeCountry `json:"homeCountry,omitempty"`
}

type BrandInfo ¶ 

type BrandInfo struct {
	// Internal identifier of a brand
	Id string `json:"id,omitempty"`
	// Brand name, for example  RingCentral UK ,  ClearFax
	Name        string      `json:"name,omitempty"`
	HomeCountry CountryInfo `json:"homeCountry,omitempty"`
}

type BrandResource ¶ 

type BrandResource struct {
	Uri         string          `json:"uri,omitempty"`
	Id          string          `json:"id,omitempty"`
	Name        string          `json:"name,omitempty"`
	HomeCountry CountryResource `json:"homeCountry,omitempty"`
	Currency    Currency        `json:"currency,omitempty"`
}

type BulkAssignItem ¶ 

type BulkAssignItem struct {
	DepartmentId        string   `json:"departmentId,omitempty"`
	AddedExtensionIds   []string `json:"addedExtensionIds,omitempty"`
	RemovedExtensionIds []string `json:"removedExtensionIds,omitempty"`
}

type BulkAssignOpts ¶ 

type BulkAssignOpts struct {
	DepartmentBulkAssignResource optional.Interface
}

type BulkProvisionExtensionResource ¶ 

type BulkProvisionExtensionResource struct {
	Uri              string                       `json:"uri,omitempty"`
	Id               string                       `json:"id,omitempty"`
	PartnerId        string                       `json:"partnerId,omitempty"`
	ExtensionNumber  string                       `json:"extensionNumber,omitempty"`
	LoginName        string                       `json:"loginName,omitempty"`
	Contact          ContactInfo                  `json:"contact,omitempty"`
	References       []Reference                  `json:"references,omitempty"`
	Name             string                       `json:"name,omitempty"`
	Type             string                       `json:"type,omitempty"`
	Status           string                       `json:"status,omitempty"`
	StatusInfo       StatusInfo                   `json:"statusInfo,omitempty"`
	Departments      []DepartmentResource         `json:"departments,omitempty"`
	ServiceFeatures  []ServiceFeatureValue        `json:"serviceFeatures,omitempty"`
	RegionalSettings RegionalSettingsResource     `json:"regionalSettings,omitempty"`
	SetupWizardState string                       `json:"setupWizardState,omitempty"`
	Permissions      ExtensionPermissionsResource `json:"permissions,omitempty"`
	Password         string                       `json:"password,omitempty"`
	IvrPin           string                       `json:"ivrPin,omitempty"`
	ProfileImage     ProfileImageResource         `json:"profileImage,omitempty"`
}

type BulkProvisionUnassignedExtensionsRequestResource ¶ 

type BulkProvisionUnassignedExtensionsRequestResource struct {
	Items []BulkProvisionExtensionResource `json:"items,omitempty"`
}

type BulkProvisionUnassignedExtensionsResponseResource ¶ 

type BulkProvisionUnassignedExtensionsResponseResource struct {
	Items []ExtensionAssignmentResult `json:"items,omitempty"`
}

type BulkRoleAssignResource ¶ 

type BulkRoleAssignResource struct {
	Uri                 string   `json:"uri,omitempty"`
	AddedExtensionIds   []string `json:"addedExtensionIds,omitempty"`
	RemovedExtensionIds []string `json:"removedExtensionIds,omitempty"`
}

type BulkSupported ¶ 

type BulkSupported struct {
	MaxOperations  int32 `json:"maxOperations,omitempty"`
	MaxPayloadSize int32 `json:"maxPayloadSize,omitempty"`
	Supported      bool  `json:"supported,omitempty"`
}

type BusinessAddressInfo ¶ 

type BusinessAddressInfo struct {
	// Name of a country
	Country string `json:"country,omitempty"`
	// Name of a state/province
	State string `json:"state,omitempty"`
	// Name of a city
	City string `json:"city,omitempty"`
	// Street address
	Street string `json:"street,omitempty"`
	// Zip code
	Zip string `json:"zip,omitempty"`
}

type BusinessHoursResource ¶ 

type BusinessHoursResource struct {
	Uri      string           `json:"uri,omitempty"`
	Schedule ScheduleResource `json:"schedule,omitempty"`
}

type CallHandlingSettingsApiService ¶ 

type CallHandlingSettingsApiService service

func (*CallHandlingSettingsApiService) BlockNumber ¶ 

func (a *CallHandlingSettingsApiService) BlockNumber(ctx context.Context, accountId string, extensionId string, localVarOptionals *BlockNumberOpts) (BlockedNumberInfo, *http.Response, error)

func (*CallHandlingSettingsApiService) CreateAnsweringRuleInfo ¶ 

func (a *CallHandlingSettingsApiService) CreateAnsweringRuleInfo(ctx context.Context, accountId string, extensionId string, createAnsweringRuleRequest CreateAnsweringRuleRequest) (AnsweringRuleInfo, *http.Response, error)

CallHandlingSettingsApiService Create Custom Call Handling Rules <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Creates a custom answering rule for a particular caller ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param createAnsweringRuleRequest JSON body

@return AnsweringRuleInfo

func (*CallHandlingSettingsApiService) CreateCompanyAnsweringRuleInfo ¶ 

func (a *CallHandlingSettingsApiService) CreateCompanyAnsweringRuleInfo(ctx context.Context, accountId string, companyAnsweringRuleRequest CompanyAnsweringRuleRequest) (CompanyAnsweringRuleInfo, *http.Response, error)

CallHandlingSettingsApiService Create Company Call Handling Rule <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Creates a company answering rule for a particular caller ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param companyAnsweringRuleRequest JSON body

@return CompanyAnsweringRuleInfo

func (*CallHandlingSettingsApiService) CreateExtensionForwardingNumber ¶ 

func (a *CallHandlingSettingsApiService) CreateExtensionForwardingNumber(ctx context.Context, accountId string, extensionId string, createForwardingNumberRequest CreateForwardingNumberRequest) (ForwardingNumberInfo, *http.Response, error)

CallHandlingSettingsApiService Create Forwarding Numbers <p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Adds a new forwarding number to the forwarding number list.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param createForwardingNumberRequest JSON body

@return ForwardingNumberInfo

func (*CallHandlingSettingsApiService) CreateGreeting ¶ 

func (a *CallHandlingSettingsApiService) CreateGreeting(ctx context.Context, accountId string, extensionId string, localVarOptionals *CreateGreetingOpts) (CustomCompanyGreetingInfo, *http.Response, error)

func (*CallHandlingSettingsApiService) CreateIVRMenu ¶ 

func (a *CallHandlingSettingsApiService) CreateIVRMenu(ctx context.Context, accountId string, ivrMenuInfo IvrMenuInfo) (IvrMenuInfo, *http.Response, error)

CallHandlingSettingsApiService Create IVR Menu <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Creates a company IVR menu</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param ivrMenuInfo JSON body

@return IvrMenuInfo

func (*CallHandlingSettingsApiService) CreatePrompts ¶ 

func (a *CallHandlingSettingsApiService) CreatePrompts(ctx context.Context, accountId string, attachment *os.File, localVarOptionals *CreatePromptsOpts) (PromptInfo, *http.Response, error)

func (*CallHandlingSettingsApiService) DeleteAnsweringRule ¶ 

func (a *CallHandlingSettingsApiService) DeleteAnsweringRule(ctx context.Context, accountId string, extensionId string, ruleId string) (*http.Response, error)

CallHandlingSettingsApiService Delete Call Handling Rule

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param ruleId Internal identifier of an answering rule

func (*CallHandlingSettingsApiService) DeleteExtensionForwardingNumber ¶ 

func (a *CallHandlingSettingsApiService) DeleteExtensionForwardingNumber(ctx context.Context, accountId string, extensionId string, forwardingNumberId string) (*http.Response, error)

CallHandlingSettingsApiService Delete Forwarding Number <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Deletes a forwarding number from the forwarding number list by its ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param forwardingNumberId Internal identifier of a forwarding number

func (*CallHandlingSettingsApiService) DeleteIVRPrompt ¶ 

func (a *CallHandlingSettingsApiService) DeleteIVRPrompt(ctx context.Context, accountId string, promptId string) (*http.Response, error)

CallHandlingSettingsApiService Delete IVR Prompt <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Deletes an IVR prompt by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param promptId

func (*CallHandlingSettingsApiService) GetCompanyGreeting ¶ 

func (a *CallHandlingSettingsApiService) GetCompanyGreeting(ctx context.Context, accountId string, customCompanyGreetingRequest CustomCompanyGreetingRequest) (CustomCompanyGreetingInfo, *http.Response, error)

CallHandlingSettingsApiService Create Custom Company Greeting

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param customCompanyGreetingRequest JSON body

@return CustomCompanyGreetingInfo

func (*CallHandlingSettingsApiService) GetForwardingNumber ¶ 

func (a *CallHandlingSettingsApiService) GetForwardingNumber(ctx context.Context, forwardingNumberId string, extensionId string, accountId string) (ForwardingNumberResource, *http.Response, error)

CallHandlingSettingsApiService Get Forwarding Number

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param forwardingNumberId
  • @param extensionId
  • @param accountId

@return ForwardingNumberResource

func (*CallHandlingSettingsApiService) GetGreeting ¶ 

func (a *CallHandlingSettingsApiService) GetGreeting(ctx context.Context, greetingId string) (DictionaryGreetingInfo, *http.Response, error)

CallHandlingSettingsApiService Get Greeting Info <p style='font-style:italic;'>Since 8.2 (Release 1.0.26)</p><p>Returns a standard greeting by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>View Greetings</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param greetingId

@return DictionaryGreetingInfo

func (*CallHandlingSettingsApiService) GetGreetingByID ¶ 

func (a *CallHandlingSettingsApiService) GetGreetingByID(ctx context.Context, accountId string, extensionId string, greetingId int32) (CustomCompanyGreetingInfo, *http.Response, error)

CallHandlingSettingsApiService Get Custom Greeting Info

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param greetingId

@return CustomCompanyGreetingInfo

func (*CallHandlingSettingsApiService) GetGreetings ¶ 

func (a *CallHandlingSettingsApiService) GetGreetings(ctx context.Context, localVarOptionals *GetGreetingsOpts) (DictionaryGreetingList, *http.Response, error)

func (*CallHandlingSettingsApiService) GetIVRMenuById ¶ 

func (a *CallHandlingSettingsApiService) GetIVRMenuById(ctx context.Context, accountId string, ivrMenuId string) (IvrMenuInfo, *http.Response, error)

CallHandlingSettingsApiService Get IVR Menu <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a company IVR menu by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param ivrMenuId

@return IvrMenuInfo

func (*CallHandlingSettingsApiService) GetIVRPrompt ¶ 

func (a *CallHandlingSettingsApiService) GetIVRPrompt(ctx context.Context, accountId string, promptId string) (PromptInfo, *http.Response, error)

CallHandlingSettingsApiService Get IVR Prompt <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns an IVR prompt by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param promptId

@return PromptInfo

func (*CallHandlingSettingsApiService) GetIVRPromptContent ¶ 

func (a *CallHandlingSettingsApiService) GetIVRPromptContent(ctx context.Context, accountId string, promptId string) (*http.Response, error)

CallHandlingSettingsApiService Get IVR Prompt Content <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns media content of an IVR prompt by its ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param promptId

func (*CallHandlingSettingsApiService) GetIVRPrompts ¶ 

func (a *CallHandlingSettingsApiService) GetIVRPrompts(ctx context.Context, accountId string) (IvrPrompts, *http.Response, error)

CallHandlingSettingsApiService Get IVR Prompts <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a list of IVR prompts.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId

@return IvrPrompts

func (*CallHandlingSettingsApiService) ListBlockedNumbers ¶ 

func (a *CallHandlingSettingsApiService) ListBlockedNumbers(ctx context.Context, accountId string, extensionId string) (BlockedNumbersList, *http.Response, error)

CallHandlingSettingsApiService Get Blocked Numbers <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return BlockedNumbersList

func (*CallHandlingSettingsApiService) ListCompanyAnsweringRule ¶ 

func (a *CallHandlingSettingsApiService) ListCompanyAnsweringRule(ctx context.Context, accountId string) (CompanyAnsweringRuleList, *http.Response, error)

CallHandlingSettingsApiService Get Company Call Handling Rules <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a list of company answering rules.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return CompanyAnsweringRuleList

func (*CallHandlingSettingsApiService) ListExtensionForwardingNumbers ¶ 

func (a *CallHandlingSettingsApiService) ListExtensionForwardingNumbers(ctx context.Context, accountId string, extensionId string, localVarOptionals *ListExtensionForwardingNumbersOpts) (GetExtensionForwardingNumberListResponse, *http.Response, error)

func (*CallHandlingSettingsApiService) LoadAnsweringRuleInfo ¶ 

func (a *CallHandlingSettingsApiService) LoadAnsweringRuleInfo(ctx context.Context, accountId string, extensionId string, ruleId string) (AnsweringRuleInfo, *http.Response, error)

CallHandlingSettingsApiService Get Call Handling Rule <p style='font-style:italic;'>Since 1.0.15 (Release 7.0)</p><p>Returns an answering rule by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param ruleId Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule

@return AnsweringRuleInfo

func (*CallHandlingSettingsApiService) LoadAnsweringRulesList ¶ 

func (a *CallHandlingSettingsApiService) LoadAnsweringRulesList(ctx context.Context, accountId string, extensionId string, localVarOptionals *LoadAnsweringRulesListOpts) (*http.Response, error)

func (*CallHandlingSettingsApiService) LoadBlockedNumber ¶ 

func (a *CallHandlingSettingsApiService) LoadBlockedNumber(ctx context.Context, accountId string, extensionId string, blockedNumberId int32) (BlockedNumberInfo, *http.Response, error)

CallHandlingSettingsApiService Get Blocked Number <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param blockedNumberId Internal identifiers of a blocked number list entry

@return BlockedNumberInfo

func (*CallHandlingSettingsApiService) LoadBusinesshoursInfo ¶ 

func (a *CallHandlingSettingsApiService) LoadBusinesshoursInfo(ctx context.Context, accountId string) (CompanyBusinessHours, *http.Response, error)

CallHandlingSettingsApiService Get Company Business Hours <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns company hours when answering rules are to be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return CompanyBusinessHours

func (*CallHandlingSettingsApiService) LoadCompanyAnsweringRuleInfo ¶ 

func (a *CallHandlingSettingsApiService) LoadCompanyAnsweringRuleInfo(ctx context.Context, accountId string, ruleId string) (CompanyAnsweringRuleInfo, *http.Response, error)

CallHandlingSettingsApiService Get Company Call Handling Rule <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a company answering rule by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param ruleId Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule

@return CompanyAnsweringRuleInfo

func (*CallHandlingSettingsApiService) LoadUserBusinessHours ¶ 

func (a *CallHandlingSettingsApiService) LoadUserBusinessHours(ctx context.Context, accountId string, extensionId string) (GetUserBusinessHoursResponse, *http.Response, error)

CallHandlingSettingsApiService Get User Business Hours <p style='font-style:italic;'>Since 1.0.15 (Release 7.0)</p><p>Returns the extension user hours when answering rules are to be applied.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return GetUserBusinessHoursResponse

func (*CallHandlingSettingsApiService) RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut ¶ 

func (a *CallHandlingSettingsApiService) RestapiV10AccountAccountIdIvrMenusIvrMenuIdPut(ctx context.Context, accountId string, ivrMenuId string, ivrMenuInfo IvrMenuInfo) (IvrMenuInfo, *http.Response, error)

CallHandlingSettingsApiService Update IVR Menu <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns a company IVR menu by ID</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param ivrMenuId
  • @param ivrMenuInfo JSON body

@return IvrMenuInfo

func (*CallHandlingSettingsApiService) UnblockNumber ¶ 

func (a *CallHandlingSettingsApiService) UnblockNumber(ctx context.Context, accountId string, extensionId string, blockedNumberId int32) (*http.Response, error)

CallHandlingSettingsApiService Delete Blocked Number <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param blockedNumberId Internal identifiers of a blocked number list entry

func (*CallHandlingSettingsApiService) UpdateAnsweringRuleInfo ¶ 

func (a *CallHandlingSettingsApiService) UpdateAnsweringRuleInfo(ctx context.Context, accountId string, extensionId string, ruleId string, updateAnsweringRuleRequest UpdateAnsweringRuleRequest) (AnsweringRuleInfo, *http.Response, error)

CallHandlingSettingsApiService Update Custom Call Handling Rule <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates a custom answering rule for a particular caller ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param ruleId Internal identifier of an answering rule
  • @param updateAnsweringRuleRequest JSON body

@return AnsweringRuleInfo

func (*CallHandlingSettingsApiService) UpdateBlockedNumber ¶ 

func (a *CallHandlingSettingsApiService) UpdateBlockedNumber(ctx context.Context, accountId string, extensionId string, blockedNumberId int32, localVarOptionals *UpdateBlockedNumberOpts) (BlockedNumberInfo, *http.Response, error)

func (*CallHandlingSettingsApiService) UpdateCompanyAnsweringRuleInfo ¶ 

func (a *CallHandlingSettingsApiService) UpdateCompanyAnsweringRuleInfo(ctx context.Context, accountId string, ruleId string, companyAnsweringRuleUpdate CompanyAnsweringRuleUpdate) (CompanyAnsweringRuleInfo, *http.Response, error)

CallHandlingSettingsApiService Update Company Call Handling Rule <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Updates a company answering rule.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param ruleId Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule
  • @param companyAnsweringRuleUpdate JSON body

@return CompanyAnsweringRuleInfo

func (*CallHandlingSettingsApiService) UpdateCompanyBusinessHours ¶ 

func (a *CallHandlingSettingsApiService) UpdateCompanyBusinessHours(ctx context.Context, accountId string, companyBusinessHoursUpdateRequest CompanyBusinessHoursUpdateRequest) (CompanyBusinessHours, *http.Response, error)

CallHandlingSettingsApiService Update Company Business Hours <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates company hours when answering rules are to be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param companyBusinessHoursUpdateRequest JSON body

@return CompanyBusinessHours

func (*CallHandlingSettingsApiService) UpdateExtensionForwardingNumber ¶ 

func (a *CallHandlingSettingsApiService) UpdateExtensionForwardingNumber(ctx context.Context, accountId string, extensionId string, forwardingNumberId string, updateForwardingNumberRequest UpdateForwardingNumberRequest) (ForwardingNumberInfo, *http.Response, error)

CallHandlingSettingsApiService Update Forwarding Numbers <p style='font-style:italic;'>Since 1.0.24 (Release 8.0)</p><p>Updates an existent forwarding number from the forwarding number list.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param forwardingNumberId Internal identifier of a forwarding number; returned in response in the id field
  • @param updateForwardingNumberRequest JSON body

@return ForwardingNumberInfo

func (*CallHandlingSettingsApiService) UpdateUserBusinessHours ¶ 

func (a *CallHandlingSettingsApiService) UpdateUserBusinessHours(ctx context.Context, accountId string, extensionId string, userBusinessHoursUpdateRequest UserBusinessHoursUpdateRequest) (UserBusinessHoursUpdate, *http.Response, error)

CallHandlingSettingsApiService Update User Business Hours <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates the extension user hours when answering rules are to be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param userBusinessHoursUpdateRequest JSON body

@return UserBusinessHoursUpdate

type CallLogApiService ¶ 

type CallLogApiService service

func (*CallLogApiService) DeleteAccountCallLog ¶ 

func (a *CallLogApiService) DeleteAccountCallLog(ctx context.Context, accountId string, localVarOptionals *DeleteAccountCallLogOpts) (*http.Response, error)

func (*CallLogApiService) DeleteAccountCallLogRecord ¶ 

func (a *CallLogApiService) DeleteAccountCallLogRecord(ctx context.Context, accountId string, callRecordId int32) (*http.Response, error)

CallLogApiService Delete Account Call Log Record(s) by ID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param callRecordId Internal identifier of a call log record

func (*CallLogApiService) DeleteExtensionCallLog ¶ 

func (a *CallLogApiService) DeleteExtensionCallLog(ctx context.Context, accountId string, extensionId string, localVarOptionals *DeleteExtensionCallLogOpts) (*http.Response, error)

func (*CallLogApiService) GetCallRecords ¶ 

func (a *CallLogApiService) GetCallRecords(ctx context.Context, callRecordId []string, extensionId string, accountId string, localVarOptionals *GetCallRecordsOpts) (UserCallLogRecord, *http.Response, error)

func (*CallLogApiService) ListCallRecordingData ¶ 

func (a *CallLogApiService) ListCallRecordingData(ctx context.Context, accountId string, recordingId string) (Binary, *http.Response, error)

CallLogApiService Get Call Recordings Data <p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Returns call recording metadata.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallRecording</td><td>Downloading call recording content</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param recordingId Internal identifier of a recording (returned in Call Log)

@return Binary

func (*CallLogApiService) ListCallRecordings ¶ 

func (a *CallLogApiService) ListCallRecordings(ctx context.Context, accountId string, recordingId string) (GetCallRecordingResponse, *http.Response, error)

CallLogApiService Get Call Recordings <p style='font-style:italic;'>Since 1.0.18 (Release 6.5)</p><p>Returns call recording metadata.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallRecording</td><td>Downloading call recording content</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param recordingId Internal identifier of a recording (returned in Call Log)

@return GetCallRecordingResponse

func (*CallLogApiService) ListCompanyActiveCalls ¶ 

func (a *CallLogApiService) ListCompanyActiveCalls(ctx context.Context, accountId string, localVarOptionals *ListCompanyActiveCallsOpts) (ExtensionActiveCallsResponse, *http.Response, error)

func (*CallLogApiService) ListExtensionActiveCalls ¶ 

func (a *CallLogApiService) ListExtensionActiveCalls(ctx context.Context, accountId string, extensionId string, localVarOptionals *ListExtensionActiveCallsOpts) (ExtensionActiveCallsResponse, *http.Response, error)

func (*CallLogApiService) LoadAccountCallLog ¶ 

func (a *CallLogApiService) LoadAccountCallLog(ctx context.Context, accountId string, localVarOptionals *LoadAccountCallLogOpts) (AccountCallLogResponse, *http.Response, error)

func (*CallLogApiService) LoadAccountCallLogRecord ¶ 

func (a *CallLogApiService) LoadAccountCallLogRecord(ctx context.Context, accountId string, callRecordId int32) (GetAccountCallLogRecordResponse, *http.Response, error)

CallLogApiService Get Account Call Log Record(s) by ID <p style='font-style:italic;'>Since 1.0.3 (Release 5.11)</p><p>Returns individual call log record(s) by ID(s). Batch request is supported, see Batch Requests for details.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param callRecordId Internal identifier of a call log record

@return GetAccountCallLogRecordResponse

func (*CallLogApiService) LoadExtensionCallLog ¶ 

func (a *CallLogApiService) LoadExtensionCallLog(ctx context.Context, accountId string, extensionId string, localVarOptionals *LoadExtensionCallLogOpts) (ExtensionCallLogResponse, *http.Response, error)

func (*CallLogApiService) SyncAccountCallLog ¶ 

func (a *CallLogApiService) SyncAccountCallLog(ctx context.Context, accountId string, localVarOptionals *SyncAccountCallLogOpts) (*http.Response, error)

func (*CallLogApiService) SyncExtensionCallLog ¶ 

func (a *CallLogApiService) SyncExtensionCallLog(ctx context.Context, accountId string, extensionId string, localVarOptionals *SyncExtensionCallLogOpts) (CallLogSync, *http.Response, error)

type CallLogCallerInfo ¶ 

type CallLogCallerInfo struct {
	// Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)
	Location string `json:"location,omitempty"`
	// Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then
	Name   string                  `json:"name,omitempty"`
	Device CallLogRecordDeviceInfo `json:"device,omitempty"`
}

type CallLogRecord ¶ 

type CallLogRecord struct {
	// Internal identifier of a cal log record
	Id string `json:"id,omitempty"`
	// Canonical URI of a call log record
	Uri string `json:"uri,omitempty"`
	// Internal identifier of a call session
	SessionId string            `json:"sessionId,omitempty"`
	From      CallLogCallerInfo `json:"from,omitempty"`
	To        CallLogCallerInfo `json:"to,omitempty"`
	// Call type
	Type string `json:"type,omitempty"`
	// Call direction
	Direction string `json:"direction,omitempty"`
	// Action description of the call operation
	Action string `json:"action,omitempty"`
	// Status description of the call operation
	Result string `json:"result,omitempty"`
	// The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	StartTime time.Time `json:"startTime,omitempty"`
	// Call duration in seconds
	Duration  int32         `json:"duration,omitempty"`
	Recording RecordingInfo `json:"recording,omitempty"`
	// For 'Detailed' view only. The datetime when the call log record was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
	// For 'Detailed' view only. Call transport
	Transport string `json:"transport,omitempty"`
	// For 'Detailed' view only. Leg description
	Legs []CallLogRecordLegInfo `json:"legs"`
}

type CallLogRecordDeviceInfo ¶ 

type CallLogRecordDeviceInfo struct {
	// Internal identifier of a device
	Id string `json:"id,omitempty"`
	// string to a device
	Uri string `json:"uri,omitempty"`
}

type CallLogRecordLegInfo ¶ 

type CallLogRecordLegInfo struct {
	// Action description of the call operation
	Action string `json:"action,omitempty"`
	// Call direction
	Direction string `json:"direction,omitempty"`
	// Call duration in seconds
	Duration  int32                `json:"duration,omitempty"`
	Extension ExtensionInfoCallLog `json:"extension,omitempty"`
	// Leg type
	LegType string `json:"legType,omitempty"`
	// The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	StartTime time.Time `json:"startTime,omitempty"`
	// Call type
	Type string `json:"type,omitempty"`
	// Status description of the call operation
	Result string            `json:"result,omitempty"`
	From   CallLogCallerInfo `json:"from,omitempty"`
	To     CallLogCallerInfo `json:"to,omitempty"`
	// Call transport
	Transport string        `json:"transport,omitempty"`
	Recording RecordingInfo `json:"recording,omitempty"`
}

type CallLogRecordResource ¶ 

type CallLogRecordResource struct {
	Uri       string                   `json:"uri,omitempty"`
	Id        string                   `json:"id,omitempty"`
	SessionId string                   `json:"sessionId,omitempty"`
	StartTime time.Time                `json:"startTime,omitempty"`
	Duration  int64                    `json:"duration,omitempty"`
	Type      string                   `json:"type,omitempty"`
	Direction string                   `json:"direction,omitempty"`
	Action    string                   `json:"action,omitempty"`
	Result    string                   `json:"result,omitempty"`
	To        CallerInfo               `json:"to,omitempty"`
	From      CallerInfo               `json:"from,omitempty"`
	Recording CallLogRecordingResource `json:"recording,omitempty"`
}

type CallLogRecordingInfoResource ¶ 

type CallLogRecordingInfoResource struct {
	Uri         string `json:"uri,omitempty"`
	Id          string `json:"id,omitempty"`
	ContentUri  string `json:"contentUri,omitempty"`
	ContentType string `json:"contentType,omitempty"`
	Duration    int64  `json:"duration,omitempty"`
}

type CallLogRecordingResource ¶ 

type CallLogRecordingResource struct {
	Uri        string `json:"uri,omitempty"`
	Id         string `json:"id,omitempty"`
	Type       string `json:"type,omitempty"`
	ContentUri string `json:"contentUri,omitempty"`
}

type CallLogRecords ¶ 

type CallLogRecords struct {
	Uri        string                  `json:"uri,omitempty"`
	Records    []CallLogRecordResource `json:"records,omitempty"`
	Paging     Paging                  `json:"paging,omitempty"`
	Navigation Navigation              `json:"navigation,omitempty"`
}

type CallLogSync ¶ 

type CallLogSync struct {
	// List of call log records with synchronization information. For ISync the total number of returned records is limited to 250; this includes both new records and the old ones, specified by the recordCount parameter
	Records  []CallLogRecord `json:"records,omitempty"`
	SyncInfo SyncInfoCallLog `json:"syncInfo,omitempty"`
}

type CallQueueInfo ¶ 

type CallQueueInfo struct {
	// Target percentage of calls that must be answered by agents within the service level time threshold
	SlaGoal int32 `json:"slaGoal,omitempty"`
	// Period of time in seconds that is considered to be an acceptable service level
	SlaThresholdSeconds int32 `json:"slaThresholdSeconds,omitempty"`
	// If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation
	IncludeAbandonedCalls bool `json:"includeAbandonedCalls,omitempty"`
	// Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation
	AbandonedThresholdSeconds int32 `json:"abandonedThresholdSeconds,omitempty"`
}

type CallQueueInfoRequest ¶ 

type CallQueueInfoRequest struct {
	// Target percentage of calls that must be answered by agents within the service level time threshold
	SlaGoal                   int32 `json:"slaGoal,omitempty"`
	SlaThresholdSeconds       int32 `json:"slaThresholdSeconds,omitempty"`
	IncludeAbandonedCalls     bool  `json:"includeAbandonedCalls,omitempty"`
	AbandonedThresholdSeconds int32 `json:"abandonedThresholdSeconds,omitempty"`
}

type CalledNumberInfo ¶ 

type CalledNumberInfo struct {
	// Called phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type CallerIdByDevice ¶ 

type CallerIdByDevice struct {
	Device   CallerIdDeviceInfo   `json:"device,omitempty"`
	CallerId CallerIdByDeviceInfo `json:"callerId,omitempty"`
}

type CallerIdByDeviceInfo ¶ 

type CallerIdByDeviceInfo struct {
	// If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']
	Type      string            `json:"type,omitempty"`
	PhoneInfo CallerIdPhoneInfo `json:"phoneInfo,omitempty"`
}

type CallerIdByFeature ¶ 

type CallerIdByFeature struct {
	Feature  string                `json:"feature,omitempty"`
	CallerId CallerIdByFeatureInfo `json:"callerId,omitempty"`
}

type CallerIdByFeatureInfo ¶ 

type CallerIdByFeatureInfo struct {
	// If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']
	Type      string            `json:"type,omitempty"`
	PhoneInfo CallerIdPhoneInfo `json:"phoneInfo,omitempty"`
}

type CallerIdDeviceInfo ¶ 

type CallerIdDeviceInfo struct {
	// Internal identifier of a device
	Id string `json:"id,omitempty"`
	// Link to a device resource
	Uri string `json:"uri,omitempty"`
	// Name of a device
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type CallerIdPhoneInfo ¶ 

type CallerIdPhoneInfo struct {
	// Internal identifier of a phone number
	Id string `json:"id,omitempty"`
	// Link to a phone number resource
	Uri string `json:"uri,omitempty"`
	// Phone number in E.164 (with '+' sign) format
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type CallerInfo ¶ 

type CallerInfo struct {
	PhoneNumber     string                  `json:"phoneNumber,omitempty"`
	ExtensionNumber string                  `json:"extensionNumber,omitempty"`
	Name            string                  `json:"name,omitempty"`
	Location        string                  `json:"location,omitempty"`
	Contact         PersonalContactResource `json:"contact,omitempty"`
	MessageStatus   string                  `json:"messageStatus,omitempty"`
	FaxErrorCode    string                  `json:"faxErrorCode,omitempty"`
}

type CallerInfoFrom ¶ 

type CallerInfoFrom struct {
	PhoneNumber string `json:"phoneNumber,omitempty"`
	Name        string `json:"name,omitempty"`
	Location    string `json:"location,omitempty"`
}

type CallerInfoTo ¶ 

type CallerInfoTo struct {
	PhoneNumber   string `json:"phoneNumber,omitempty"`
	Name          string `json:"name,omitempty"`
	Location      string `json:"location,omitempty"`
	MessageStatus string `json:"messageStatus,omitempty"`
	FaxErrorCode  string `json:"faxErrorCode,omitempty"`
}

type CallerResource ¶ 

type CallerResource struct {
	CallerId string `json:"callerId,omitempty"`
	Name     string `json:"name,omitempty"`
}

type CallersInfo ¶ 

type CallersInfo struct {
	// Phone number of a caller
	CallerId string `json:"callerId,omitempty"`
	// Contact name of a caller
	Name string `json:"name,omitempty"`
}

type CallersInfoRequest ¶ 

type CallersInfoRequest struct {
	// Phone number of a caller
	CallerId string `json:"callerId,omitempty"`
	// Contact name of a caller
	Name string `json:"name,omitempty"`
}

type CfaAttachments ¶ 

type CfaAttachments struct {
	Csv bool `json:"csv,omitempty"`
	Pdf bool `json:"pdf,omitempty"`
}

type CfaRecurrence ¶ 

type CfaRecurrence struct {
	Pattern string `json:"pattern,omitempty"`
	Value   string `json:"value,omitempty"`
}

type CfaSchedule ¶ 

type CfaSchedule struct {
	ScheduleId  string         `json:"scheduleId,omitempty"`
	Recurrence  CfaRecurrence  `json:"recurrence,omitempty"`
	ViewType    string         `json:"viewType,omitempty"`
	Attachments CfaAttachments `json:"attachments,omitempty"`
	Recipients  []string       `json:"recipients,omitempty"`
	Pages       []string       `json:"pages,omitempty"`
}

type CfaSettingsResource ¶ 

type CfaSettingsResource struct {
	Views []CfaView `json:"views,omitempty"`
}

type CfaView ¶ 

type CfaView struct {
	Name      string        `json:"name,omitempty"`
	Schedules []CfaSchedule `json:"schedules,omitempty"`
}

type CheckPermissionOpts ¶ 

type CheckPermissionOpts struct {
	PermissionId      optional.String
	TargetExtensionId optional.String
}

type ClientApiResponse ¶ 

type ClientApiResponse struct {
	Client       ClientApplicationInfo  `json:"client"`
	Provisioning ClientProvisioningInfo `json:"provisioning"`
}

type ClientApplicationInfo ¶ 

type ClientApplicationInfo struct {
	// 'True', if the server succeeded detecting application info, sufficient to return provisioning info
	Detected bool `json:"detected"`
	// The value of 'User-Agent' header, as it was passed in request
	UserAgent string `json:"userAgent,omitempty"`
	// Application identifier (from authorization session)
	AppId string `json:"appId,omitempty"`
	// Application name (from authorization session, but must match 'User-Agent')
	AppName string `json:"appName,omitempty"`
	// Application version (parsed from 'User-Agent')
	AppVersion string `json:"appVersion,omitempty"`
	// Application platform operation system (parsed from 'User-Agent': Windows, MacOS, Android, iOS
	AppPlatform string `json:"appPlatform,omitempty"`
	// Application platform operation system version (parsed from 'User-Agent')
	AppPlatformVersion string `json:"appPlatformVersion,omitempty"`
	// Locale, parsed from 'Accept-Language'. Currently en-GB and en-US locales are supported. The default value is en-US
	Locale string `json:"locale,omitempty"`
}

type ClientInfoResource ¶ 

type ClientInfoResource struct {
	Uri          string               `json:"uri,omitempty"`
	Client       ClientResource       `json:"client,omitempty"`
	Provisioning ProvisioningResource `json:"provisioning,omitempty"`
}

type ClientInfoSpecialNumberResource ¶ 

type ClientInfoSpecialNumberResource struct {
	Uri         string   `json:"uri,omitempty"`
	PhoneNumber string   `json:"phoneNumber,omitempty"`
	Description string   `json:"description,omitempty"`
	Features    Features `json:"features,omitempty"`
}

type ClientInfoSpecialNumbersResource ¶ 

type ClientInfoSpecialNumbersResource struct {
	Uri        string                            `json:"uri,omitempty"`
	Records    []ClientInfoSpecialNumberResource `json:"records,omitempty"`
	Paging     Paging                            `json:"paging,omitempty"`
	Navigation Navigation                        `json:"navigation,omitempty"`
}

type ClientProvisioningHintInfo ¶ 

type ClientProvisioningHintInfo struct {
	// Seconds until expiration date. Returned only if applicable
	ExpiresIn int32 `json:"expiresIn,omitempty"`
	// 'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'
	ActionRequired bool `json:"actionRequired,omitempty"`
}

type ClientProvisioningHintsInfo ¶ 

type ClientProvisioningHintsInfo struct {
	TrialState          ClientProvisioningHintInfo `json:"trialState,omitempty"`
	UserCredentialState ClientProvisioningHintInfo `json:"userCredentialState,omitempty"`
	AppVersionUpgrade   ClientProvisioningHintInfo `json:"appVersionUpgrade,omitempty"`
}

type ClientProvisioningInfo ¶ 

type ClientProvisioningInfo struct {
	WebUris ClientProvisioningWebUriInfo `json:"webUris"`
	Hints   ClientProvisioningHintsInfo  `json:"hints"`
}

type ClientProvisioningWebUriInfo ¶ 

type ClientProvisioningWebUriInfo struct {
	// Link to web page with the application description. Returned if the application needs to be updated, together with the appVersionUpgrade hint
	AppDownload string `json:"appDownload,omitempty"`
	// Link to the application distributive package. Returned if the application needs to be updated, together with the appVersionUpgrade hint
	AppDownloadFile string `json:"appDownloadFile,omitempty"`
	// Link to express setup page (mobile application)
	ExpressSetupMobile string `json:"expressSetupMobile,omitempty"`
	// Link to the RC Meetings application distributive package
	MeetingsAppDownload string `json:"meetingsAppDownload,omitempty"`
	// Link to billing page (mobile application)
	MobileWebBilling string `json:"mobileWebBilling,omitempty"`
	// Link to call handling page (mobile application)
	MobileWebCallHandling string `json:"mobileWebCallHandling,omitempty"`
	// Link to international calling page (mobile application)
	MobileWebInternationalCalling string `json:"mobileWebInternationalCalling,omitempty"`
	// Link to notifications page (mobile application)
	MobileWebNotifications string `json:"mobileWebNotifications,omitempty"`
	// Link to phone system settings page (mobile application)
	MobileWebPhoneSystem string `json:"mobileWebPhoneSystem,omitempty"`
	// Link to reports page (mobile application)
	MobileWebReporting string `json:"mobileWebReporting,omitempty"`
	// Link to reset password page (mobile application)
	MobileWebResetPassword string `json:"mobileWebResetPassword,omitempty"`
	// Link to  Tell A Friend  page (mobile application)
	MobileWebTellAFriend string `json:"mobileWebTellAFriend,omitempty"`
	// Link to upgrade trial account (mobile application)
	MobileWebTrialUpgrade string `json:"mobileWebTrialUpgrade,omitempty"`
	// Link to user settings page (mobile application)
	MobileWebUserSettings string `json:"mobileWebUserSettings,omitempty"`
	// Link to billing page (web application)
	ServiceWebBilling string `json:"serviceWebBilling,omitempty"`
	// Link to home page (web application)
	ServiceWebHome string `json:"serviceWebHome,omitempty"`
	// Link to phone system settings page (web application)
	ServiceWebPhoneSystem string `json:"serviceWebPhoneSystem,omitempty"`
	// Link to reset password page (web application)
	ServiceWebResetPassword string `json:"serviceWebResetPassword,omitempty"`
	// Link to  Tell A Friend  page (web application)
	ServiceWebTellAFriend string `json:"serviceWebTellAFriend,omitempty"`
	// Link to user settings page (web application)
	ServiceWebUserSettings string `json:"serviceWebUserSettings,omitempty"`
	// Link to sign up page (web application)
	SignUp string `json:"signUp,omitempty"`
	// Link to support page (web application)
	Support string `json:"support,omitempty"`
}

type ClientResource ¶ 

type ClientResource struct {
	Detected   bool   `json:"detected,omitempty"`
	UserAgent  string `json:"userAgent,omitempty"`
	AppId      string `json:"appId,omitempty"`
	AppName    string `json:"appName,omitempty"`
	AppKey     string `json:"appKey,omitempty"`
	AppVersion string `json:"appVersion,omitempty"`
	Locale     string `json:"locale,omitempty"`
}

type CompanyAnsweringRuleCalledNumberInfo ¶ 

type CompanyAnsweringRuleCalledNumberInfo struct {
	// Internal identifier of an account phone number
	Id string `json:"id,omitempty"`
}

type CompanyAnsweringRuleCalledNumberInfoRequest ¶ 

type CompanyAnsweringRuleCalledNumberInfoRequest struct {
	// Internal identifier of an account phone number
	Id string `json:"id,omitempty"`
}

type CompanyAnsweringRuleCallersInfoRequest ¶ 

type CompanyAnsweringRuleCallersInfoRequest struct {
	// Phone number of a caller
	CallerId string `json:"callerId,omitempty"`
	// Displayed name for a caller ID
	Name string `json:"name,omitempty"`
}

type CompanyAnsweringRuleExtensionInfoRequest ¶ 

type CompanyAnsweringRuleExtensionInfoRequest struct {
	// Time in format hh:mm
	Id string `json:"id,omitempty"`
}

type CompanyAnsweringRuleInfo ¶ 

type CompanyAnsweringRuleInfo struct {
	// Internal identifier of an answering rule
	Id string `json:"id,omitempty"`
	// Canonical URI of an answering rule
	Uri string `json:"uri,omitempty"`
	// Specifies if the rule is active or inactive. The default value is 'True'
	Enabled bool `json:"enabled,omitempty"`
	// Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']
	Type string `json:"type,omitempty"`
	// Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number
	Name string `json:"name,omitempty"`
	// Answering rule will be applied when calls are received from the specified caller(s)
	Callers []CompanyAnsweringRuleCallersInfoRequest `json:"callers,omitempty"`
	// Answering rule will be applied when calling the specified number(s)
	CalledNumbers []CompanyAnsweringRuleCalledNumberInfoRequest `json:"calledNumbers,omitempty"`
	Schedule      CompanyAnsweringRuleScheduleInfo              `json:"schedule,omitempty"`
	// Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']
	CallHandlingAction string                                 `json:"callHandlingAction,omitempty"`
	Extension          CompanyAnsweringRuleCallersInfoRequest `json:"extension,omitempty"`
	// Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
	Greetings []GreetingInfo `json:"greetings,omitempty"`
}

type CompanyAnsweringRuleList ¶ 

type CompanyAnsweringRuleList struct {
	// Link to an answering rule resource
	Uri string `json:"uri,omitempty"`
	// List of company answering rules
	Records    []ListCompanyAnsweringRuleInfo `json:"records,omitempty"`
	Paging     PagingInfo                     `json:"paging,omitempty"`
	Navigation NavigationInfo                 `json:"navigation,omitempty"`
}

type CompanyAnsweringRuleRangesInfoRequest ¶ 

type CompanyAnsweringRuleRangesInfoRequest struct {
	// Date and time in format YYYY-MM-DD hh:mm
	From string `json:"from,omitempty"`
	// Date and time in format YYYY-MM-DD hh:mm
	To string `json:"to,omitempty"`
}

type CompanyAnsweringRuleRequest ¶ 

type CompanyAnsweringRuleRequest struct {
	// Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number
	Name string `json:"name,omitempty"`
	// Specifies if the rule is active or inactive. The default value is 'True'
	Enabled bool `json:"enabled,omitempty"`
	// Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']
	Type string `json:"type,omitempty"`
	// Answering rule will be applied when calls are received from the specified caller(s)
	Callers []CompanyAnsweringRuleCallersInfoRequest `json:"callers,omitempty"`
	// Answering rule will be applied when calling the specified number(s)
	CalledNumbers []CompanyAnsweringRuleCalledNumberInfo  `json:"calledNumbers,omitempty"`
	Schedule      CompanyAnsweringRuleScheduleInfoRequest `json:"schedule,omitempty"`
	// Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']
	CallHandlingAction string                                 `json:"callHandlingAction,omitempty"`
	Extension          CompanyAnsweringRuleCallersInfoRequest `json:"extension,omitempty"`
	// Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
	Greetings []GreetingInfo `json:"greetings,omitempty"`
}

type CompanyAnsweringRuleScheduleInfo ¶ 

type CompanyAnsweringRuleScheduleInfo struct {
	WeeklyRanges CompanyAnsweringRuleWeeklyScheduleInfoRequest `json:"weeklyRanges,omitempty"`
	Ranges       RangesInfo                                    `json:"ranges,omitempty"`
	// Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']
	Ref string `json:"ref,omitempty"`
}

type CompanyAnsweringRuleScheduleInfoRequest ¶ 

type CompanyAnsweringRuleScheduleInfoRequest struct {
	WeeklyRanges CompanyAnsweringRuleWeeklyScheduleInfoRequest `json:"weeklyRanges,omitempty"`
	Ranges       RangesInfo                                    `json:"ranges,omitempty"`
	// Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']
	Ref string `json:"ref,omitempty"`
}

type CompanyAnsweringRuleTimeIntervalRequest ¶ 

type CompanyAnsweringRuleTimeIntervalRequest struct {
	// Time in format hh:mm
	From string `json:"from,omitempty"`
	// Time in format hh:mm
	To string `json:"to,omitempty"`
}

type CompanyAnsweringRuleUpdate ¶ 

type CompanyAnsweringRuleUpdate struct {
	// Specifies if the rule is active or inactive. The default value is 'True'
	Enabled bool `json:"enabled,omitempty"`
	// Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number
	Name string `json:"name,omitempty"`
	// Answering rule will be applied when calls are received from the specified caller(s)
	Callers []CompanyAnsweringRuleCallersInfoRequest `json:"callers,omitempty"`
	// Answering rule will be applied when calling the specified number(s)
	CalledNumbers []CompanyAnsweringRuleCalledNumberInfo  `json:"calledNumbers,omitempty"`
	Schedule      CompanyAnsweringRuleScheduleInfoRequest `json:"schedule,omitempty"`
	// Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']
	CallHandlingAction string                                 `json:"callHandlingAction,omitempty"`
	Extension          CompanyAnsweringRuleCallersInfoRequest `json:"extension,omitempty"`
	// Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
	Greetings []GreetingInfo `json:"greetings,omitempty"`
}

type CompanyAnsweringRuleWeeklyScheduleInfoRequest ¶ 

type CompanyAnsweringRuleWeeklyScheduleInfoRequest struct {
	// Time interval for a particular day
	Monday []CompanyAnsweringRuleTimeIntervalRequest `json:"monday,omitempty"`
	// Time interval for a particular day
	Tuesday []CompanyAnsweringRuleTimeIntervalRequest `json:"tuesday,omitempty"`
	// Time interval for a particular day
	Wednesday []CompanyAnsweringRuleTimeIntervalRequest `json:"wednesday,omitempty"`
	// Time interval for a particular day
	Thursday []CompanyAnsweringRuleTimeIntervalRequest `json:"thursday,omitempty"`
	// Time interval for a particular day
	Friday []CompanyAnsweringRuleTimeIntervalRequest `json:"friday,omitempty"`
	// Time interval for a particular day
	Saturday []CompanyAnsweringRuleTimeIntervalRequest `json:"saturday,omitempty"`
	// Time interval for a particular day
	Sunday []CompanyAnsweringRuleTimeIntervalRequest `json:"sunday,omitempty"`
}

type CompanyBusinessHours ¶ 

type CompanyBusinessHours struct {
	// Canonical URI of a business-hours resource
	Uri      string                           `json:"uri,omitempty"`
	Schedule CompanyBusinessHoursScheduleInfo `json:"schedule,omitempty"`
}

type CompanyBusinessHoursScheduleInfo ¶ 

type CompanyBusinessHoursScheduleInfo struct {
	WeeklyRanges WeeklyScheduleInfo `json:"weeklyRanges,omitempty"`
}

type CompanyBusinessHoursUpdateRequest ¶ 

type CompanyBusinessHoursUpdateRequest struct {
	Schedule CompanyBusinessHoursScheduleInfo `json:"schedule,omitempty"`
}

type CompanyContactsApiService ¶ 

type CompanyContactsApiService service

func (*CompanyContactsApiService) CreateBotExtension ¶ 

func (a *CompanyContactsApiService) CreateBotExtension(ctx context.Context, accountId string, botExtensionCreationRequest BotExtensionCreationRequest) (BotExtensionCreation, *http.Response, error)

CompanyContactsApiService Create Bot Extension <p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Creates a bot extension. Please note: Bot extension is always created in Enabled status, no welcome email is sent.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param botExtensionCreationRequest JSON body

@return BotExtensionCreation

func (*CompanyContactsApiService) CreateExtension ¶ 

func (a *CompanyContactsApiService) CreateExtension(ctx context.Context, accountId string, extensionCreationRequest ExtensionCreationRequest) (ExtensionInfo, *http.Response, error)

CompanyContactsApiService Create Extension <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Creates an extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionCreationRequest JSON body

@return ExtensionInfo

func (*CompanyContactsApiService) ListCompanyDirectoryContacts ¶ 

func (a *CompanyContactsApiService) ListCompanyDirectoryContacts(ctx context.Context, accountId string, localVarOptionals *ListCompanyDirectoryContactsOpts) (CompanyDirectoryContacts, *http.Response, error)

func (*CompanyContactsApiService) ListExtensions ¶ 

func (a *CompanyContactsApiService) ListExtensions(ctx context.Context, accountId string, localVarOptionals *ListExtensionsOpts) (GetExtensionListResponse, *http.Response, error)

func (*CompanyContactsApiService) LoadCompanyDirectoryContact ¶ 

func (a *CompanyContactsApiService) LoadCompanyDirectoryContact(ctx context.Context, accountId string, contactId string) (ContactInfo, *http.Response, error)

CompanyContactsApiService Get Company Directory Contact <p style='font-style:italic;'></p><p>Returns contact information on a particular corporate user of a federated account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param contactId Internal identifier of an extension

@return ContactInfo

func (*CompanyContactsApiService) LoadCompanyDirectoryExtensionNumbers ¶ 

func (a *CompanyContactsApiService) LoadCompanyDirectoryExtensionNumbers(ctx context.Context, accountId string) (FederationExtensionNumbers, *http.Response, error)

CompanyContactsApiService Get Existing Extension Numbers <p style='font-style:italic;'></p><p>Returns the list of account federation extensions.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return FederationExtensionNumbers

func (*CompanyContactsApiService) LoadCompanyDirectoryFederation ¶ 

func (a *CompanyContactsApiService) LoadCompanyDirectoryFederation(ctx context.Context, accountId string) (FederationInfo, *http.Response, error)

CompanyContactsApiService Get Account Federation <p style='font-style:italic;'></p><p>Returns information on a federation and associated accounts.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return FederationInfo

func (*CompanyContactsApiService) LoadCompanyDirectoryFederationConflicts ¶ 

func (a *CompanyContactsApiService) LoadCompanyDirectoryFederationConflicts(ctx context.Context, accountId string) (FederationConflicts, *http.Response, error)

CompanyContactsApiService Get Account Federation Conflicts <p style='font-style:italic;'></p><p>Returns the list of federation extensions which numbers are conflicting with extension numbers of the requested account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return FederationConflicts

type CompanyDirectoryAccountInfo ¶ 

type CompanyDirectoryAccountInfo struct {
	// Internal identifier of an account
	Id string `json:"id,omitempty"`
}

type CompanyDirectoryContactInfo ¶ 

type CompanyDirectoryContactInfo struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Type of an extension
	Type string `json:"type,omitempty"`
	// Status of an extension
	Status string `json:"status,omitempty"`
	// User extension first name
	FirstName string `json:"firstName,omitempty"`
	// User extension last name
	LastName string `json:"lastName,omitempty"`
	// Name of an extension
	Name string `json:"name,omitempty"`
	// Department name of an extension
	Department string `json:"department,omitempty"`
	// Email of an extension
	Email string `json:"email,omitempty"`
	// Number of an extension
	ExtensionNumber string                      `json:"extensionNumber,omitempty"`
	Account         CompanyDirectoryAccountInfo `json:"account,omitempty"`
	// Extension phone numbers information
	PhoneNumbers []CompanyDirectoryPhoneNumberInfo `json:"phoneNumbers,omitempty"`
	ProfileImage CompanyDirectoryProfileImageInfo  `json:"profileImage,omitempty"`
}

type CompanyDirectoryContacts ¶ 

type CompanyDirectoryContacts struct {
	// List of countries which can be selected for a dialing plan
	Records []CompanyDirectoryContactInfo `json:"records"`
	Paging  PagingInfo                    `json:"paging"`
}

type CompanyDirectoryPhoneNumberInfo ¶ 

type CompanyDirectoryPhoneNumberInfo struct {
	// Extension phone number in E.164 format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Type of a phone number
	Type string `json:"type,omitempty"`
	// Specifies if a phone number should be hidden or not. Returned only if the value is 'True'
	Hidden bool `json:"hidden,omitempty"`
	// Usage type of a phone number
	UsageType string `json:"usageType,omitempty"`
}

type CompanyDirectoryProfileImageInfo ¶ 

type CompanyDirectoryProfileImageInfo struct {
	// Link to a profile image resource
	Uri string `json:"uri,omitempty"`
	// Internal identifier of an image
	Etag string `json:"etag,omitempty"`
}

type CompanySettingsApiService ¶ 

type CompanySettingsApiService service

func (*CompanySettingsApiService) DeleteAccount ¶ 

func (a *CompanySettingsApiService) DeleteAccount(ctx context.Context, accountId string) (*http.Response, error)

CompanySettingsApiService Delete Account <p style='font-style:italic;'>Since 1.0.0</p><p>Updates account information.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId

func (*CompanySettingsApiService) ListDialingPlans ¶ 

func (a *CompanySettingsApiService) ListDialingPlans(ctx context.Context, accountId string, localVarOptionals *ListDialingPlansOpts) (GetDialingPlanInfo, *http.Response, error)

func (*CompanySettingsApiService) LoadAccount ¶ 

func (a *CompanySettingsApiService) LoadAccount(ctx context.Context, accountId string) (GetAccountInfoResponse, *http.Response, error)

CompanySettingsApiService Get Company Info <p style='font-style:italic;'>Since 1.0.0</p><p>Returns basic information about a particular RingCentral customer account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return GetAccountInfoResponse

func (*CompanySettingsApiService) LoadAccountBusinessAddress ¶ 

func (a *CompanySettingsApiService) LoadAccountBusinessAddress(ctx context.Context, accountId string) (GetAccountInfoResponse, *http.Response, error)

CompanySettingsApiService Get Company Business Address <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return GetAccountInfoResponse

func (*CompanySettingsApiService) LoadServiceInfo ¶ 

func (a *CompanySettingsApiService) LoadServiceInfo(ctx context.Context, accountId string) (GetServiceInfoResponse, *http.Response, error)

CompanySettingsApiService Get Account Service Info <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return GetServiceInfoResponse

func (*CompanySettingsApiService) ModifyAccount ¶ 

func (a *CompanySettingsApiService) ModifyAccount(ctx context.Context, accountId string, updateAccountRequest UpdateAccountRequest) (GetAccountInfoResponse, *http.Response, error)

CompanySettingsApiService Update Company <p style='font-style:italic;'>Since 1.0.0</p><p>Updates account information.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param updateAccountRequest JSON body

@return GetAccountInfoResponse

func (*CompanySettingsApiService) UpdateAccountBusinessAddress ¶ 

func (a *CompanySettingsApiService) UpdateAccountBusinessAddress(ctx context.Context, accountId string, modifyAccountBusinessAddressRequest ModifyAccountBusinessAddressRequest) (AccountBusinessAddressResource, *http.Response, error)

CompanySettingsApiService Update Company Business Address <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param modifyAccountBusinessAddressRequest JSON body

@return AccountBusinessAddressResource

func (*CompanySettingsApiService) UpdateServiceInfo ¶ 

func (a *CompanySettingsApiService) UpdateServiceInfo(ctx context.Context, accountId string, serviceInfoRequest ServiceInfoRequest) (AccountServiceInfo, *http.Response, error)

CompanySettingsApiService Update Account Service Info [Beta] <p style='font-style:italic;'>Since 1.0.29 (Release 9.0)</p><p>Updates limitations for a particular RingCentral customer account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Accounts</td><td>Managing accounts: creating new accounts, viewing and updating account information, deleting existing accounts</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param serviceInfoRequest JSON body

@return AccountServiceInfo

type ConferencePhoneNumberInfo ¶ 

type ConferencePhoneNumberInfo struct {
	// Dial-in phone number to connect to a conference
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// 'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed
	Default bool `json:"default,omitempty"`
}

type ConferencingInfoResource ¶ 

type ConferencingInfoResource struct {
	Uri                 string                       `json:"uri,omitempty"`
	PhoneNumber         string                       `json:"phoneNumber,omitempty"`
	HostCode            string                       `json:"hostCode,omitempty"`
	ParticipantCode     string                       `json:"participantCode,omitempty"`
	AllowJoinBeforeHost bool                         `json:"allowJoinBeforeHost,omitempty"`
	TapToJoinUri        string                       `json:"tapToJoinUri,omitempty"`
	SupportUri          string                       `json:"supportUri,omitempty"`
	Mode                string                       `json:"mode,omitempty"`
	PhoneNumbers        []ConferencingNumberResource `json:"phoneNumbers,omitempty"`
}

type ConferencingNumberResource ¶ 

type ConferencingNumberResource struct {
	Uri         string          `json:"uri,omitempty"`
	PhoneNumber string          `json:"phoneNumber,omitempty"`
	Country     CountryResource `json:"country,omitempty"`
	Location    string          `json:"location,omitempty"`
	HasGreeting bool            `json:"hasGreeting,omitempty"`
	Default     bool            `json:"default,omitempty"`
}

type Configuration ¶ 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶ 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶ 

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConflictsInfo ¶ 

type ConflictsInfo struct {
	// Internal identifier of a conflicting extension assigned to another account of the current federation
	Id string `json:"id,omitempty"`
	// Extension user first name
	FirstName string `json:"firstName,omitempty"`
	// Extension user last name
	LastName string                         `json:"lastName,omitempty"`
	Account  FederationConflictsAccountInfo `json:"account,omitempty"`
}

type ContactAddressInfo ¶ 

type ContactAddressInfo struct {
	// Country name of extension user company. Not returned for Address Book
	Country string `json:"country,omitempty"`
	// State/province name of extension user company
	State string `json:"state,omitempty"`
	// City name of extension user company
	City string `json:"city,omitempty"`
	// Street address of extension user company
	Street string `json:"street,omitempty"`
	// Zip code of extension user company
	Zip string `json:"zip,omitempty"`
}

type ContactDirectoryEvent ¶ 

type ContactDirectoryEvent struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Type of change
	EventType string `json:"eventType,omitempty"`
	// Extension Type
	Type string `json:"type,omitempty"`
	// Status of an extension
	Status string `json:"status,omitempty"`
	// First name of an extension user
	FirstName string `json:"firstName,omitempty"`
	// Last name of an extension user
	LastName string `json:"lastName,omitempty"`
	// Department Name
	Department string `json:"department,omitempty"`
	// Email of an extension user
	Email string `json:"email,omitempty"`
	// Extension number
	ExtensionNumber string                           `json:"extensionNumber,omitempty"`
	Account         CompanyDirectoryAccountInfo      `json:"account,omitempty"`
	PhoneNumbers    CompanyDirectoryPhoneNumberInfo  `json:"phoneNumbers,omitempty"`
	Site            SiteInfo                         `json:"site,omitempty"`
	ProfileImage    CompanyDirectoryProfileImageInfo `json:"profileImage,omitempty"`
}

type ContactInfo ¶ 

type ContactInfo struct {
	// For User extension type only. Extension user first name
	FirstName string `json:"firstName,omitempty"`
	// For User extension type only. Extension user last name
	LastName string `json:"lastName,omitempty"`
	// Extension user company name
	Company string `json:"company,omitempty"`
	// Email of extension user
	Email string `json:"email,omitempty"`
	// Extension user contact phone number
	BusinessPhone   string             `json:"businessPhone,omitempty"`
	BusinessAddress ContactAddressInfo `json:"businessAddress,omitempty"`
}

type ContactInfoUpdateRequest ¶ 

type ContactInfoUpdateRequest struct {
	// For User extension type only. Extension user first name,
	FirstName string `json:"firstName,omitempty"`
	// For User extension type only. Extension user last name,
	LastName string `json:"lastName,omitempty"`
	// Extension user company name
	Company string `json:"company,omitempty"`
	// Email of extension user
	Email string `json:"email,omitempty"`
	// Extension user contact phone number in E.164 format
	BusinessPhone   string             `json:"businessPhone,omitempty"`
	BusinessAddress ContactAddressInfo `json:"businessAddress,omitempty"`
	//  If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'
	EmailAsLoginName bool               `json:"emailAsLoginName,omitempty"`
	PronouncedName   PronouncedNameInfo `json:"pronouncedName,omitempty"`
	// Extension user department, if any
	Department string `json:"department,omitempty"`
}

type ContactList ¶ 

type ContactList struct {
	// List of personal contacts from the extension address book
	Records    []PersonalContactResource `json:"records,omitempty"`
	Navigation NavigationInfo            `json:"navigation,omitempty"`
	Paging     PagingInfo                `json:"paging,omitempty"`
}

type ContactsCollection ¶ 

type ContactsCollection struct {
	Uri        string                    `json:"uri,omitempty"`
	Records    []PersonalContactResource `json:"records,omitempty"`
	Paging     Paging                    `json:"paging,omitempty"`
	Navigation Navigation                `json:"navigation,omitempty"`
	Groups     ResourceLink              `json:"groups,omitempty"`
}

type ContactsInput ¶ 

type ContactsInput struct {
	Records []PersonalContactResource `json:"records,omitempty"`
}

type ContentDisposition ¶ 

type ContentDisposition struct {
	Type             string    `json:"type,omitempty"`
	FileName         string    `json:"fileName,omitempty"`
	CreationDate     time.Time `json:"creationDate,omitempty"`
	ModificationDate time.Time `json:"modificationDate,omitempty"`
	ReadDate         time.Time `json:"readDate,omitempty"`
	Size             int64     `json:"size,omitempty"`
}

type ConversationResource ¶ 

type ConversationResource struct {
	Id                  string               `json:"id,omitempty"`
	TypingNotifications DeliveryModeResource `json:"typingNotifications,omitempty"`
	Uri                 string               `json:"uri,omitempty"`
}
type Cookie struct {
	Name    string `json:"name,omitempty"`
	Value   string `json:"value,omitempty"`
	Version int32  `json:"version,omitempty"`
	Path    string `json:"path,omitempty"`
	Domain  string `json:"domain,omitempty"`
}

type CountriesResource ¶ 

type CountriesResource struct {
	Uri        string            `json:"uri,omitempty"`
	Records    []CountryResource `json:"records,omitempty"`
	Paging     Paging            `json:"paging,omitempty"`
	Navigation Navigation        `json:"navigation,omitempty"`
}

type CountryInfo ¶ 

type CountryInfo struct {
	// Internal identifier of a home country
	Id string `json:"id,omitempty"`
	// Canonical URI of a home country
	Uri string `json:"uri,omitempty"`
	// Official name of a home country
	Name string `json:"name,omitempty"`
}

type CountryResource ¶ 

type CountryResource struct {
	Uri              string `json:"uri,omitempty"`
	Id               string `json:"id,omitempty"`
	Name             string `json:"name,omitempty"`
	IsoCode          string `json:"isoCode,omitempty"`
	CallingCode      string `json:"callingCode,omitempty"`
	EmergencyCalling bool   `json:"emergencyCalling,omitempty"`
	NumberSelling    bool   `json:"numberSelling,omitempty"`
	LoginAllowed     bool   `json:"loginAllowed,omitempty"`
}

type CreateAccountRequest ¶ 

type CreateAccountRequest struct {
	// Main account VoIP phone number, either Local or Toll-Free. Cannot be Fax Only. Obtained via lookup/reserve API
	MainNumber string                   `json:"mainNumber,omitempty"`
	Operator   GetExtensionInfoResponse `json:"operator,omitempty"`
	// Partner identifier for this account
	PartnerId string `json:"partnerId,omitempty"`
	// Promotion code to calculate a discount
	PromotionCode string `json:"promotionCode,omitempty"`
	// Internal identifier of phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time
	ReservationId string                 `json:"reservationId,omitempty"`
	ServiceInfo   GetServiceInfoResponse `json:"serviceInfo,omitempty"`
	// The status with which an account is created. The default value is 'Initial'
	Status     string                   `json:"status,omitempty"`
	SignupInfo AccountSignupInfoRequest `json:"signupInfo,omitempty"`
}

type CreateAnsweringRuleRequest ¶ 

type CreateAnsweringRuleRequest struct {
	// Specifies if the rule is active or inactive. The default value is 'True'
	Enabled bool `json:"enabled,omitempty"`
	// Type of an answering rule. The 'Custom' value should be specified
	Type string `json:"type"`
	// Name of an answering rule specified by user
	Name string `json:"name"`
	// Answering rule will be applied when calls are received from the specified caller(s)
	Callers []CallersInfoRequest `json:"callers,omitempty"`
	// Answering rules are applied when calling to selected number(s)
	CalledNumbers []CalledNumberInfo `json:"calledNumbers,omitempty"`
	Schedule      ScheduleInfo       `json:"schedule,omitempty"`
	// Specifies how incoming calls are forwarded
	CallHandlingAction      string                      `json:"callHandlingAction,omitempty"`
	Forwarding              ForwardingInfo              `json:"forwarding,omitempty"`
	UnconditionalForwarding UnconditionalForwardingInfo `json:"unconditionalForwarding,omitempty"`
	Queue                   QueueInfo                   `json:"queue,omitempty"`
	Transfer                TransferredExtensionInfo    `json:"transfer,omitempty"`
	Voicemail               VoicemailInfo               `json:"voicemail,omitempty"`
	// Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
	Greetings []GreetingInfo `json:"greetings,omitempty"`
}

type CreateContactOpts ¶ 

type CreateContactOpts struct {
	PersonalContactResource optional.Interface
}

type CreateContactsOpts ¶ 

type CreateContactsOpts struct {
	FavoriteCollection optional.Interface
}

type CreateDeviceOrderOpts ¶ 

type CreateDeviceOrderOpts struct {
	Async          optional.Bool
	DeviceResource optional.Interface
}

type CreateFaxMessageRequest ¶ 

type CreateFaxMessageRequest struct {
	// Recipient information. Phone number property is mandatory. Optional for resend fax request
	To []MessageStoreCallerInfoRequest `json:"to"`
	// Fax resolution
	Resolution string `json:"resolution,omitempty"`
	// The datetime to send fax at, in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. If time is not specified, the fax will be send immediately
	SendTime time.Time `json:"sendTime,omitempty"`
	// Optional. Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols
	CoverPageText string `json:"coverPageText,omitempty"`
	// Internal identifier of the original fax message which needs to be resent. Mandatory for resend fax request
	OriginalMessageId string `json:"originalMessageId,omitempty"`
}

type CreateForwardingNumberRequest ¶ 

type CreateForwardingNumberRequest struct {
	// Forwarding/Call flip phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Forwarding/Call flip number title
	Label string `json:"label,omitempty"`
}

type CreateGlipFileOpts ¶ 

type CreateGlipFileOpts struct {
	GroupId optional.String
	Name    optional.String
}

type CreateGreetingOpts ¶ 

type CreateGreetingOpts struct {
	CustomGreetingRequest optional.Interface
}

type CreatePagerMessageRequest ¶ 

type CreatePagerMessageRequest struct {
	From MessageStoreCallerInfoRequest `json:"from"`
	// Internal identifier of a message this message replies to
	ReplyOn int32 `json:"replyOn,omitempty"`
	// Text of a pager message. Max length is 1024 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 512 symbols
	Text string `json:"text"`
	// Optional if replyOn parameter is specified. Receiver of a pager message. The extensionNumber property must be filled
	To []MessageStoreCallerInfoRequest `json:"to,omitempty"`
}

type CreatePromptsOpts ¶ 

type CreatePromptsOpts struct {
	Name optional.String
}

type CreateSipRegistrationRequest ¶ 

type CreateSipRegistrationRequest struct {
	// Device unique description
	Device []DeviceInfoRequest `json:"device"`
	// SIP settings for device
	SipInfo []SipInfoRequest `json:"sipInfo"`
}

type CreateSipRegistrationResponse ¶ 

type CreateSipRegistrationResponse struct {
	// SIP settings for device
	SipInfo []SipInfoResponse `json:"sipInfo"`
	// SIP flags data
	SipFlags []SipFlagsRespones `json:"sipFlags"`
}

type CreateSmsMessage ¶ 

type CreateSmsMessage struct {
	From MessageStoreCallerInfoRequest `json:"from"`
	// Receiver of an SMS message. The phoneNumber property must be filled
	To []MessageStoreCallerInfoRequest `json:"to"`
	// Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols
	Text string `json:"text"`
}

type CreateSubscriptionRequest ¶ 

type CreateSubscriptionRequest struct {
	// Mandatory. Collection of URIs to API resources (see Event Types for details). For APNS transport type only message event filter is available
	EventFilters []string                        `json:"eventFilters,omitempty"`
	DeliveryMode NotificationDeliveryModeRequest `json:"deliveryMode"`
	// Subscription lifetime in seconds. Max value is 7 days (604800 sec)
	ExpiresIn int32 `json:"expiresIn,omitempty"`
}

type Currency ¶ 

type Currency struct {
	Id          string `json:"id,omitempty"`
	Code        string `json:"code,omitempty"`
	Name        string `json:"name,omitempty"`
	Symbol      string `json:"symbol,omitempty"`
	MinorSymbol string `json:"minorSymbol,omitempty"`
}

type CustomCompanyGreetingAnsweringRuleInfo ¶ 

type CustomCompanyGreetingAnsweringRuleInfo struct {
	// Internal identifier of an answering rule
	Id string `json:"id,omitempty"`
}

type CustomCompanyGreetingInfo ¶ 

type CustomCompanyGreetingInfo struct {
	// Link to an extension custom greeting
	Uri string `json:"uri,omitempty"`
	// Internal identifier of an answering rule
	Id string `json:"id,omitempty"`
	// Internal identifier of an answering rule
	Type string `json:"type,omitempty"`
	// Content media type in WAV/MP3 format
	ContentType string `json:"contentType,omitempty"`
	// Link to a greeting content (audio file)
	ContentUri    string                          `json:"contentUri,omitempty"`
	AnsweringRule CustomGreetingAnsweringRuleInfo `json:"answeringRule,omitempty"`
}

type CustomCompanyGreetingRequest ¶ 

type CustomCompanyGreetingRequest struct {
	// Type of a greeting, specifying the case when the greeting is played. See Greeting Types = ['Introductory', 'Announcement', 'ConnectingMessage', 'ConnectingAudio', 'Voicemail', 'Unavailable', 'HoldMusic']
	Type          string                                 `json:"type,omitempty"`
	AnsweringRule CustomCompanyGreetingAnsweringRuleInfo `json:"answeringRule,omitempty"`
}

type CustomDataApiResponse ¶ 

type CustomDataApiResponse struct {
	// Custom data access key
	Id string `json:"id"`
	// Link to the custom data
	Uri string `json:"uri"`
	// Description of custom data
	Value string `json:"value,omitempty"`
	// Time of the last change in custom data
	LastModifiedTime string                   `json:"lastModifiedTime"`
	Attachment       CustomDataAttachmentInfo `json:"attachment,omitempty"`
}

type CustomDataAttachmentInfo ¶ 

type CustomDataAttachmentInfo struct {
	// Link to custom data attachment
	Uri string `json:"uri"`
	// Type of custom data attachment, see also MIME Types
	ContentType string `json:"contentType"`
}

type CustomDataRequest ¶ 

type CustomDataRequest struct {
	// Custom data access key. Optional. If specified, must match the custom key in the URL
	Id string `json:"id,omitempty"`
	// Description of custom data. Mandatory for create, if there is no attachment specified. Maximum length is limited to 256 symbols
	Value string `json:"value,omitempty"`
}

type CustomDataResource ¶ 

type CustomDataResource struct {
	Uri              string         `json:"uri,omitempty"`
	Id               string         `json:"id,omitempty"`
	Value            string         `json:"value,omitempty"`
	LastModifiedTime time.Time      `json:"lastModifiedTime,omitempty"`
	Attachment       AttachmentInfo `json:"attachment,omitempty"`
}

type CustomGreetingAnsweringRuleInfo ¶ 

type CustomGreetingAnsweringRuleInfo struct {
	// Canonical URI of an answering rule
	Uri string `json:"uri,omitempty"`
	// Internal identifier of an answering rule
	Id string `json:"id,omitempty"`
}

type CustomGreetingAnsweringRuleInfoRequest ¶ 

type CustomGreetingAnsweringRuleInfoRequest struct {
	// Internal identifier of an answering rule
	Id string `json:"id,omitempty"`
}

type CustomGreetingRequest ¶ 

type CustomGreetingRequest struct {
	// Type of a greeting, specifying the case when the greeting is played. See Greeting Types = ['Introductory', 'Announcement', 'ConnectingMessage', 'ConnectingAudio', 'Voicemail', 'Unavailable', 'HoldMusic']
	Type          string                                 `json:"type,omitempty"`
	AnsweringRule CustomGreetingAnsweringRuleInfoRequest `json:"answeringRule,omitempty"`
}

type DateTimeIntervalResource ¶ 

type DateTimeIntervalResource struct {
	From string `json:"from,omitempty"`
	To   string `json:"to,omitempty"`
}

type DefaultUserRoleRequest ¶ 

type DefaultUserRoleRequest struct {
	// Internal identifier of a user role to be set as default, see User Role List
	Id string `json:"id,omitempty"`
}

type DeleteAccountCallLogOpts ¶ 

type DeleteAccountCallLogOpts struct {
	DateTo optional.String
}

type DeleteExtensionCallLogOpts ¶ 

type DeleteExtensionCallLogOpts struct {
	DateTo          optional.String
	PhoneNumber     optional.String
	ExtensionNumber optional.String
	Type_           optional.Interface
	Direction       optional.Interface
	DateFrom        optional.Time
}

type DeleteMessageOpts ¶ 

type DeleteMessageOpts struct {
	Purge          optional.Bool
	ConversationId optional.Int32
}

type DeleteMessagesByFilterOpts ¶ 

type DeleteMessagesByFilterOpts struct {
	ConversationId optional.Interface
}

type DeliveryModeResource ¶ 

type DeliveryModeResource struct {
	TransportType       string `json:"transportType,omitempty"`
	Encryption          bool   `json:"encryption,omitempty"`
	Address             string `json:"address,omitempty"`
	SubscriberKey       string `json:"subscriberKey,omitempty"`
	PublisherKey        string `json:"publisherKey,omitempty"`
	EncryptionAlgorithm string `json:"encryptionAlgorithm,omitempty"`
	EncryptionKey       string `json:"encryptionKey,omitempty"`
	AuthKey             string `json:"authKey,omitempty"`
	CipherKey           string `json:"cipherKey,omitempty"`
	RegistrationId      string `json:"registrationId,omitempty"`
	CertificateName     string `json:"certificateName,omitempty"`
}

type DepartmentBulkAssignResource ¶ 

type DepartmentBulkAssignResource struct {
	Items []BulkAssignItem `json:"items,omitempty"`
}

type DepartmentInfo ¶ 

type DepartmentInfo struct {
	// Internal identifier of a department extension
	Id string `json:"id,omitempty"`
	// Canonical URI of a department extension
	Uri string `json:"uri,omitempty"`
	// Number of a department extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
}

type DepartmentMemberList ¶ 

type DepartmentMemberList struct {
	// List of department members extensions
	Records    []ExtensionInfo `json:"records,omitempty"`
	Navigation NavigationInfo  `json:"navigation,omitempty"`
	Paging     PagingInfo      `json:"paging,omitempty"`
}

type DepartmentResource ¶ 

type DepartmentResource struct {
	Uri             string `json:"uri,omitempty"`
	Id              string `json:"id,omitempty"`
	ExtensionNumber string `json:"extensionNumber,omitempty"`
}

type DetailedCallInfo ¶ 

type DetailedCallInfo struct {
	CallId      string `json:"callId,omitempty"`
	ToTag       string `json:"toTag,omitempty"`
	FromTag     string `json:"fromTag,omitempty"`
	RemoteUri   string `json:"remoteUri,omitempty"`
	LocalUri    string `json:"localUri,omitempty"`
	RcSessionId string `json:"rcSessionId,omitempty"`
}

type DetailedExtensionPresenceEvent ¶ 

type DetailedExtensionPresenceEvent struct {
	// Internal identifier of an extension. Optional parameter
	ExtensionId string `json:"extensionId,omitempty"`
	// Telephony presence status. Returned if telephony status is changed.
	TelephonyStatus string `json:"telephonyStatus,omitempty"`
	// Collection of Active Call Info
	ActiveCalls []ActiveCallInfoWithoutSip `json:"activeCalls,omitempty"`
	// Order number of a notification to state the chronology
	Sequence int32 `json:"sequence,omitempty"`
	// Aggregated presence status, calculated from a number of sources
	PresenceStatus string `json:"presenceStatus,omitempty"`
	// User-defined presence status (as previously published by the user)
	UserStatus string `json:"userStatus,omitempty"`
	// Extended DnD (Do not Disturb) status
	DndStatus string `json:"dndStatus,omitempty"`
	// If 'True' enables other extensions to see the extension presence status
	AllowSeeMyPresence bool `json:"allowSeeMyPresence,omitempty"`
	// If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
	RingOnMonitoredCall bool `json:"ringOnMonitoredCall,omitempty"`
	// If 'True' enables the extension user to pick up a monitored line on hold
	PickUpCallsOnHold bool `json:"pickUpCallsOnHold,omitempty"`
}

type DetailedExtensionPresenceWithSipEvent ¶ 

type DetailedExtensionPresenceWithSipEvent struct {
	// Internal identifier of an extension. Optional parameter
	ExtensionId string `json:"extensionId,omitempty"`
	// Telephony presence status. Returned if telephony status is changed.
	TelephonyStatus string `json:"telephonyStatus,omitempty"`
	// Collection of Active Call Info
	ActiveCalls []ActiveCallInfo `json:"activeCalls,omitempty"`
	// Order number of a notification to state the chronology
	Sequence int32 `json:"sequence,omitempty"`
	// Aggregated presence status, calculated from a number of sources
	PresenceStatus string `json:"presenceStatus,omitempty"`
	// User-defined presence status (as previously published by the user)
	UserStatus string `json:"userStatus,omitempty"`
	// Extended DnD (Do not Disturb) status
	DndStatus string `json:"dndStatus,omitempty"`
	// If 'True' enables other extensions to see the extension presence status
	AllowSeeMyPresence bool `json:"allowSeeMyPresence,omitempty"`
	// If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
	RingOnMonitoredCall bool `json:"ringOnMonitoredCall,omitempty"`
	// If 'True' enables the extension user to pick up a monitored line on hold
	PickUpCallsOnHold bool `json:"pickUpCallsOnHold,omitempty"`
}

type DeviceInfoRequest ¶ 

type DeviceInfoRequest struct {
	// Device unique identifier, retrieved on previous session (if any)
	Id string `json:"id,omitempty"`
	// For iOS devices only Certificate name (used by iOS applications for APNS subscription)
	AppExternalId string `json:"appExternalId,omitempty"`
	// For SoftPhone only Computer name
	ComputerName string `json:"computerName,omitempty"`
}

type DeviceInstance ¶ 

type DeviceInstance struct {
	Id              string `json:"id,omitempty"`
	Serial          string `json:"serial,omitempty"`
	TrackingNumber  string `json:"trackingNumber,omitempty"`
	ShippingCarrier string `json:"shippingCarrier,omitempty"`
	RmaNumber       string `json:"rmaNumber,omitempty"`
}

type DeviceModelExtResource ¶ 

type DeviceModelExtResource struct {
	// Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'
	Sku string `json:"sku,omitempty"`
	// Device type. The default value is 'HardPhone'
	Type  string              `json:"type,omitempty"`
	Model DeviceModelResource `json:"model,omitempty"`
}

type DeviceModelExtsResource ¶ 

type DeviceModelExtsResource struct {
	// Canonical URI of a device
	Uri string `json:"uri,omitempty"`
	// Devices data
	Records []DeviceModelExtResource `json:"records,omitempty"`
}

type DeviceModelResource ¶ 

type DeviceModelResource struct {
	Id     string  `json:"id,omitempty"`
	Name   string  `json:"name,omitempty"`
	Addons []Addon `json:"addons,omitempty"`
}

type DeviceOrder ¶ 

type DeviceOrder struct {
	// Identifier of a device
	Id string `json:"id,omitempty"`
	// Canonical URI of an order resource
	Uri string `json:"uri,omitempty"`
	// List of devices ordered
	Devices []DeviceResource `json:"devices,omitempty"`
}

type DeviceOrderCreation ¶ 

type DeviceOrderCreation struct {
	// List of devices ordered
	Devices []DeviceResource `json:"devices,omitempty"`
	Task    TaskInfo         `json:"task,omitempty"`
}

type DeviceOrderResource ¶ 

type DeviceOrderResource struct {
	AccountId       string           `json:"accountId,omitempty"`
	RequestNumber   string           `json:"requestNumber,omitempty"`
	DistributorName string           `json:"distributorName,omitempty"`
	TrackingNumber  string           `json:"trackingNumber,omitempty"`
	ShippingCarrier string           `json:"shippingCarrier,omitempty"`
	Devices         []DeviceInstance `json:"devices,omitempty"`
}

type DeviceResource ¶ 

type DeviceResource struct {
	// Internal identifier of a device
	Id string `json:"id,omitempty"`
	// Canonical URI of a device
	Uri string `json:"uri,omitempty"`
	// Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'
	Sku string `json:"sku,omitempty"`
	// Device type. The default value is 'HardPhone'
	Type string `json:"type,omitempty"`
	// Status of a device = ['Online', 'Offline']
	Status string `json:"status,omitempty"`
	// Device name. Mandatory if ordering SoftPhone or OtherPhone . Optional for HardPhone . If not specified for HardPhone, then device model name is used as device name
	Name string `json:"name,omitempty"`
	// Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications
	Serial string `json:"serial,omitempty"`
	// PC name for softphone
	ComputerName string                 `json:"computerName,omitempty"`
	Model        DeviceModelResource    `json:"model,omitempty"`
	Extension    ExtensionResourceIntId `json:"extension,omitempty"`
	// Phone lines information
	PhoneLines              []PhoneLineResource             `json:"phoneLines,omitempty"`
	EmergencyServiceAddress EmergencyServiceAddressResource `json:"emergencyServiceAddress,omitempty"`
	Shipping                ShippingResource                `json:"shipping,omitempty"`
	// Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. Either model structure, or boxBillingId must be specified for HardPhone
	BoxBillingId int32 `json:"boxBillingId,omitempty"`
	// Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']
	LinePooling string `json:"linePooling,omitempty"`
}

type DeviceToRegister ¶ 

type DeviceToRegister struct {
	Id            string `json:"id,omitempty"`
	ComputerName  string `json:"computerName,omitempty"`
	AppExternalId string `json:"appExternalId,omitempty"`
}

type DevicesResource ¶ 

type DevicesResource struct {
	Uri        string           `json:"uri,omitempty"`
	Records    []DeviceResource `json:"records,omitempty"`
	Paging     Paging           `json:"paging,omitempty"`
	Navigation Navigation       `json:"navigation,omitempty"`
}

type DialInNumberResource ¶ 

type DialInNumberResource struct {
	PhoneNumber     string          `json:"phoneNumber,omitempty"`
	FormattedNumber string          `json:"formattedNumber,omitempty"`
	Location        string          `json:"location,omitempty"`
	Country         CountryResource `json:"country,omitempty"`
}

type DictionaryGreetingInfo ¶ 

type DictionaryGreetingInfo struct {
	// Internal identifier of a greeting
	Id string `json:"id,omitempty"`
	// Link to a greeting
	Uri string `json:"uri,omitempty"`
	// Name of a greeting
	Name string `json:"name,omitempty"`
	// Usage type of a greeting, specifying if the greeting is applied for user extension or department extension = ['UserExtensionAnsweringRule', 'ExtensionAnsweringRule', 'DepartmentExtensionAnsweringRule', 'CompanyAnsweringRule', 'CompanyAfterHoursAnsweringRule']
	UsageType string `json:"usageType,omitempty"`
	// Text of a greeting, if any
	Text string `json:"text,omitempty"`
	// Link to a greeting content (audio file), if any
	ContentUri string `json:"contentUri,omitempty"`
	// Type of a greeting, specifying the case when the greeting is played. See Greeting Types = ['Introductory', 'Announcement', 'ConnectingMessage', 'ConnectingAudio', 'Voicemail', 'Unavailable', 'InterruptPrompt', 'HoldMusic', 'Company']
	Type string `json:"type,omitempty"`
	// Category of a greeting, specifying data form. The category value 'None' specifies that greetings of a certain type ('Introductory', 'ConnectingAudio', etc.) are switched off for an extension = ['Music', 'Message', 'Ring Tones', 'None']
	Category   string         `json:"category,omitempty"`
	Navigation NavigationInfo `json:"navigation,omitempty"`
	Paging     PagingInfo     `json:"paging,omitempty"`
}

type DictionaryGreetingList ¶ 

type DictionaryGreetingList struct {
	// Canonical URI of greetings list resource
	Uri string `json:"uri,omitempty"`
	// List of greetings
	Records []DictionaryGreetingInfo `json:"records,omitempty"`
}

type DictionaryShippingOptions ¶ 

type DictionaryShippingOptions struct {
	// Quantity of devices to ship
	Quantity int32 `json:"quantity,omitempty"`
	// Price for shipping with the specified method (depending on the quantity value)
	Price  int32          `json:"price,omitempty"`
	Method ShippingMethod `json:"method,omitempty"`
}

type EditGroupRequest ¶ 

type EditGroupRequest struct {
	// List of users to be added to the team
	AddedPersonIds []string `json:"addedPersonIds,omitempty"`
	// List of user email addresses to be added to the team (i.e. as guests)
	AddedPersonEmails []string `json:"addedPersonEmails,omitempty"`
	// List of users to be removed from the team
	RemovedPersonIds []string `json:"removedPersonIds,omitempty"`
}

type EditPagingGroupRequest ¶ 

type EditPagingGroupRequest struct {
	// List of users that will be allowed to page a group specified
	AddedUserIds []string `json:"addedUserIds,omitempty"`
	// List of users that will be unallowed to page a group specified
	RemovedUserIds []string `json:"removedUserIds,omitempty"`
	// List of account devices that will be assigned to a paging group specified
	AddedDeviceIds []string `json:"addedDeviceIds,omitempty"`
	// List of account devices that will be unassigned from a paging group specified
	RemovedDeviceIds []string `json:"removedDeviceIds,omitempty"`
}

type EditParkLocationRequest ¶ 

type EditParkLocationRequest struct {
	// List of users that will be allowed to park/unpark calls using the specified park location
	AddedUserIds []string `json:"addedUserIds,omitempty"`
	// List of users that will be unallowed to park/unpark calls using the specified park location
	RemovedUserIds []string `json:"removedUserIds,omitempty"`
}

type EmailInfo ¶ 

type EmailInfo struct {
	// Email address
	Value string `json:"value,omitempty"`
	// Email address type
	Type string `json:"type,omitempty"`
}

type EmailInfoRequest ¶ 

type EmailInfoRequest struct {
	// Email address
	Value string `json:"value,omitempty"`
	// Email address type
	Type string `json:"type,omitempty"`
}

type EmailResource ¶ 

type EmailResource struct {
	AccountId   string   `json:"accountId,omitempty"`
	ExtensionId string   `json:"extensionId,omitempty"`
	TemplateId  string   `json:"templateId,omitempty"`
	Recipients  []string `json:"recipients,omitempty"`
	Files       []string `json:"files,omitempty"`
}

type EmergencyAddress ¶ 

type EmergencyAddress struct {
	//  'True' if specifying of emergency address is required
	Required bool `json:"required,omitempty"`
	//  'True' if only local emergency address can be specified
	LocalOnly bool `json:"localOnly,omitempty"`
}

type EmergencyAddressInfo ¶ 

type EmergencyAddressInfo struct {
	// Name of a customer
	CustomerName string `json:"customerName,omitempty"`
	// Street address, line 1 - street address, P.O. box, company name, c/o
	Street string `json:"street,omitempty"`
	// Street address, line 2 - apartment, suite, unit, building, floor, etc.
	Street2 string `json:"street2,omitempty"`
	// City name
	City string `json:"city,omitempty"`
	// State/province name
	State string `json:"state,omitempty"`
	// Zip code
	Zip string `json:"zip,omitempty"`
	// Country name
	Country string `json:"country,omitempty"`
}

type EmergencyAddressInfoRequest ¶ 

type EmergencyAddressInfoRequest struct {
	// Name of a customer
	CustomerName string `json:"customerName,omitempty"`
	// Street address, line 1 - street address, P.O. box, company name, c/o
	Street string `json:"street,omitempty"`
	// Street address, line 2 - apartment, suite, unit, building, floor, etc
	Street2 string `json:"street2,omitempty"`
	// City name
	City string `json:"city,omitempty"`
	// State/province name
	State string `json:"state,omitempty"`
	// Zip code
	Zip string `json:"zip,omitempty"`
	// Country name
	Country string `json:"country,omitempty"`
}

type EmergencyServiceAddressResource ¶ 

type EmergencyServiceAddressResource struct {
	Street       string `json:"street,omitempty"`
	Street2      string `json:"street2,omitempty"`
	City         string `json:"city,omitempty"`
	State        string `json:"state,omitempty"`
	Country      string `json:"country,omitempty"`
	Zip          string `json:"zip,omitempty"`
	CustomerName string `json:"customerName,omitempty"`
}

type EnterpriseUser ¶ 

type EnterpriseUser struct {
	Department string `json:"department,omitempty"`
}

type EntityTag ¶ 

type EntityTag struct {
	Value string `json:"value,omitempty"`
	Weak  bool   `json:"weak,omitempty"`
}

type ErrorEntity ¶ 

type ErrorEntity struct {
	ErrorCode string `json:"errorCode,omitempty"`
	Message   string `json:"message,omitempty"`
}

type ExtensionActiveCallsResponse ¶ 

type ExtensionActiveCallsResponse struct {
	// List of call log records
	Records    []CallLogRecord `json:"records"`
	Navigation NavigationInfo  `json:"navigation"`
	Paging     PagingInfo      `json:"paging"`
}

type ExtensionAssignmentResult ¶ 

type ExtensionAssignmentResult struct {
	Successful bool              `json:"successful,omitempty"`
	Extension  ExtensionResource `json:"extension,omitempty"`
	Error      ErrorEntity       `json:"error,omitempty"`
}

type ExtensionCallLogResponse ¶ 

type ExtensionCallLogResponse struct {
	// List of call log records
	Records    []CallLogRecord `json:"records"`
	Navigation NavigationInfo  `json:"navigation"`
	Paging     PagingInfo      `json:"paging"`
}

type ExtensionCallerIdInfo ¶ 

type ExtensionCallerIdInfo struct {
	// Canonical URL of a caller ID resource
	Uri       string              `json:"uri,omitempty"`
	ByDevice  []CallerIdByDevice  `json:"byDevice,omitempty"`
	ByFeature []CallerIdByFeature `json:"byFeature,omitempty"`
}

type ExtensionCountryInfoRequest ¶ 

type ExtensionCountryInfoRequest struct {
	// internal Identifier for country
	Id string `json:"id,omitempty"`
}

type ExtensionCreationRequest ¶ 

type ExtensionCreationRequest struct {
	Contact ContactInfoUpdateRequest `json:"contact,omitempty"`
	// Number of extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Password for extension. If not specified, the password is auto-generated
	Password string `json:"password,omitempty"`
	// List of non-RC internal identifiers assigned to an extension
	References       []ReferenceInfo  `json:"references,omitempty"`
	RegionalSettings RegionalSettings `json:"regionalSettings,omitempty"`
	// Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted' = ['NotStarted', 'Incomplete', 'Completed']
	SetupWizardState string `json:"setupWizardState,omitempty"`
	// Extension current state = ['Enabled', 'Disabled', 'NotActivated', 'Unassigned']
	Status     string              `json:"status,omitempty"`
	StatusInfo ExtensionStatusInfo `json:"statusInfo,omitempty"`
	// Extension type = ['User', 'VirtualUser', 'DigitalUser', 'Department']
	Type string `json:"type,omitempty"`
}

type ExtensionFavoritesEvent ¶ 

type ExtensionFavoritesEvent struct {
	// Internal identifier of an extension
	ExtensionId string `json:"extensionId,omitempty"`
}

type ExtensionFavoritesPresenceEvent ¶ 

type ExtensionFavoritesPresenceEvent struct {
	// Internal identifier of an extension. Optional parameter
	ExtensionId string `json:"extensionId,omitempty"`
	// Telephony presence status. Returned if telephony status is changed.
	TelephonyStatus string `json:"telephonyStatus,omitempty"`
	// Order number of a notification to state the chronology
	Sequence int32 `json:"sequence,omitempty"`
	// Aggregated presence status, calculated from a number of sources
	PresenceStatus string `json:"presenceStatus,omitempty"`
	// User-defined presence status (as previously published by the user)
	UserStatus string `json:"userStatus,omitempty"`
	// Extended DnD (Do not Disturb) status
	DndStatus string `json:"dndStatus,omitempty"`
	// If 'True' enables other extensions to see the extension presence status
	AllowSeeMyPresence bool `json:"allowSeeMyPresence,omitempty"`
	// If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
	RingOnMonitoredCall bool `json:"ringOnMonitoredCall,omitempty"`
	// If 'True' enables the extension user to pick up a monitored line on hold
	PickUpCallsOnHold bool `json:"pickUpCallsOnHold,omitempty"`
}

type ExtensionFormattingLocaleInfoRequest ¶ 

type ExtensionFormattingLocaleInfoRequest struct {
	// Internal Identifier of a formatting language
	Id string `json:"id,omitempty"`
}

type ExtensionGrantListEvent ¶ 

type ExtensionGrantListEvent struct {
	// Internal identifier of an extension
	ExtensionId string `json:"extensionId,omitempty"`
}

type ExtensionGrantResource ¶ 

type ExtensionGrantResource struct {
	Uri            string                   `json:"uri,omitempty"`
	Extension      InlinedExtensionResource `json:"extension,omitempty"`
	CallPickup     bool                     `json:"callPickup,omitempty"`
	CallMonitoring bool                     `json:"callMonitoring,omitempty"`
}

type ExtensionGrantsResource ¶ 

type ExtensionGrantsResource struct {
	Uri        string                   `json:"uri,omitempty"`
	Records    []ExtensionGrantResource `json:"records,omitempty"`
	Paging     Paging                   `json:"paging,omitempty"`
	Navigation Navigation               `json:"navigation,omitempty"`
}

type ExtensionGreetingLanguageInfoRequest ¶ 

type ExtensionGreetingLanguageInfoRequest struct {
	// internal Identifier of a greeting language
	Id string `json:"id,omitempty"`
}

type ExtensionIdResource ¶ 

type ExtensionIdResource struct {
	Uri             string `json:"uri,omitempty"`
	Id              string `json:"id,omitempty"`
	ExtensionNumber string `json:"extensionNumber,omitempty"`
}

type ExtensionInfo ¶ 

type ExtensionInfo struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Canonical URI of an extension
	Uri string `json:"uri,omitempty"`
	// Number of department extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension
	PartnerId string `json:"partnerId,omitempty"`
}

type ExtensionInfoCallLog ¶ 

type ExtensionInfoCallLog struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Canonical URI of an extension
	Uri string `json:"uri,omitempty"`
}

type ExtensionInfoEvent ¶ 

type ExtensionInfoEvent struct {
	// Internal identifier of an extension
	ExtensionId string `json:"extensionId,omitempty"`
	// Type of extension info change
	EventType string `json:"eventType,omitempty"`
	// Returned for 'Update' event type only. The possible values are: /nAccountInfo - change of account parameters/nExtensionInfo - change of contact info, service features, departments, status/nPhoneNumber - change of phone numbers/nRole - change of permissions/nProfileImage - change of profile image
	Hints []string `json:"hints,omitempty"`
}

type ExtensionInfoGrants ¶ 

type ExtensionInfoGrants struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Canonical URI of an extension
	Uri string `json:"uri,omitempty"`
	// Extension short number (usually 3 or 4 digits)
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Extension type
	Type string `json:"type,omitempty"`
}

type ExtensionInfoIntId ¶ 

type ExtensionInfoIntId struct {
	// Internal identifier of an extension
	Id int64 `json:"id,omitempty"`
	// Canonical URI of an extension
	Uri string `json:"uri,omitempty"`
	// Number of department extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension
	PartnerId string `json:"partnerId,omitempty"`
}

type ExtensionInfoMonitoredLines ¶ 

type ExtensionInfoMonitoredLines struct {
	// Internal identifier of a monitored extension
	Id string `json:"id,omitempty"`
	// Canonical URI of a monitored extension
	Uri string `json:"uri,omitempty"`
	// Brief information on a monitored extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Type of a monitored extension
	Type string `json:"type,omitempty"`
}

type ExtensionInfoProvisionPhoneNumbers ¶ 

type ExtensionInfoProvisionPhoneNumbers struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension
	PartnerId string `json:"partnerId,omitempty"`
}

type ExtensionInfoSip ¶ 

type ExtensionInfoSip struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Canonical URI of an extension
	Uri string `json:"uri,omitempty"`
	// Extension number
	ExtensionNumber string `json:"extensionNumber,omitempty"`
}

type ExtensionLanguageInfoRequest ¶ 

type ExtensionLanguageInfoRequest struct {
	// internal Identifier of a language
	Id string `json:"id,omitempty"`
}

type ExtensionListEvent ¶ 

type ExtensionListEvent struct {
	// Internal identifier of an extension
	ExtensionId string `json:"extensionId,omitempty"`
	// Type of extension info change
	EventType string `json:"eventType,omitempty"`
}

type ExtensionNotificationInfo ¶ 

type ExtensionNotificationInfo struct {
	// Internal identifier of the extension
	Id string `json:"id,omitempty"`
}

type ExtensionPermissions ¶ 

type ExtensionPermissions struct {
	Admin                PermissionInfo `json:"admin,omitempty"`
	InternationalCalling PermissionInfo `json:"internationalCalling,omitempty"`
}

type ExtensionPermissionsResource ¶ 

type ExtensionPermissionsResource struct {
	Uri                      string     `json:"uri,omitempty"`
	Admin                    Permission `json:"admin,omitempty"`
	InternationalCalling     Permission `json:"internationalCalling,omitempty"`
	FreeSoftPhoneDigitalLine Permission `json:"freeSoftPhoneDigitalLine,omitempty"`
}

type ExtensionPresenceEvent ¶ 

type ExtensionPresenceEvent struct {
	// Internal identifier of an extension. Optional parameter
	ExtensionId string `json:"extensionId,omitempty"`
	// Telephony presence status. Returned if telephony status is changed.
	TelephonyStatus string `json:"telephonyStatus,omitempty"`
	// Order number of a notification to state the chronology
	Sequence int32 `json:"sequence,omitempty"`
	// Aggregated presence status, calculated from a number of sources
	PresenceStatus string `json:"presenceStatus,omitempty"`
	// User-defined presence status (as previously published by the user)
	UserStatus string `json:"userStatus,omitempty"`
	// Extended DnD (Do not Disturb) status
	DndStatus string `json:"dndStatus,omitempty"`
	// If 'True' enables other extensions to see the extension presence status
	AllowSeeMyPresence bool `json:"allowSeeMyPresence,omitempty"`
	// If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
	RingOnMonitoredCall bool `json:"ringOnMonitoredCall,omitempty"`
	// If 'True' enables the extension user to pick up a monitored line on hold
	PickUpCallsOnHold bool `json:"pickUpCallsOnHold,omitempty"`
}

type ExtensionPresenceLineEvent ¶ 

type ExtensionPresenceLineEvent struct {
	Extension ExtensionNotificationInfo `json:"extension,omitempty"`
	// Order number of a notification to state the chronology
	Sequence int32 `json:"sequence,omitempty"`
}

type ExtensionReferenceResource ¶ 

type ExtensionReferenceResource struct {
	Id        string `json:"id,omitempty"`
	PartnerId string `json:"partnerId,omitempty"`
}

type ExtensionRegionalSettingRequest ¶ 

type ExtensionRegionalSettingRequest struct {
	HomeCountry      ExtensionCountryInfoRequest          `json:"homeCountry,omitempty"`
	Timezone         ExtensionTimezoneInfoRequest         `json:"timezone,omitempty"`
	Language         ExtensionLanguageInfoRequest         `json:"language,omitempty"`
	GreetingLanguage ExtensionGreetingLanguageInfoRequest `json:"greetingLanguage,omitempty"`
	FormattingLocale ExtensionFormattingLocaleInfoRequest `json:"formattingLocale,omitempty"`
	// Time format setting. The default value is '12h' = ['12h', '24h']
	TimeFormat string `json:"timeFormat,omitempty"`
}

type ExtensionResource ¶ 

type ExtensionResource struct {
	Uri              string                       `json:"uri,omitempty"`
	Id               string                       `json:"id,omitempty"`
	PartnerId        string                       `json:"partnerId,omitempty"`
	ExtensionNumber  string                       `json:"extensionNumber,omitempty"`
	LoginName        string                       `json:"loginName,omitempty"`
	Contact          ContactInfo                  `json:"contact,omitempty"`
	References       []Reference                  `json:"references,omitempty"`
	Name             string                       `json:"name,omitempty"`
	Type             string                       `json:"type,omitempty"`
	Status           string                       `json:"status,omitempty"`
	StatusInfo       StatusInfo                   `json:"statusInfo,omitempty"`
	Departments      []DepartmentResource         `json:"departments,omitempty"`
	ServiceFeatures  []ServiceFeatureValue        `json:"serviceFeatures,omitempty"`
	RegionalSettings RegionalSettingsResource     `json:"regionalSettings,omitempty"`
	SetupWizardState string                       `json:"setupWizardState,omitempty"`
	Permissions      ExtensionPermissionsResource `json:"permissions,omitempty"`
	Password         string                       `json:"password,omitempty"`
	IvrPin           string                       `json:"ivrPin,omitempty"`
	ProfileImage     ProfileImageResource         `json:"profileImage,omitempty"`
}

type ExtensionResourceIntId ¶ 

type ExtensionResourceIntId struct {
	Uri              string                       `json:"uri,omitempty"`
	Id               int64                        `json:"id,omitempty"`
	PartnerId        string                       `json:"partnerId,omitempty"`
	ExtensionNumber  string                       `json:"extensionNumber,omitempty"`
	LoginName        string                       `json:"loginName,omitempty"`
	Contact          ContactInfo                  `json:"contact,omitempty"`
	References       []Reference                  `json:"references,omitempty"`
	Name             string                       `json:"name,omitempty"`
	Type             string                       `json:"type,omitempty"`
	Status           string                       `json:"status,omitempty"`
	StatusInfo       StatusInfo                   `json:"statusInfo,omitempty"`
	Departments      []DepartmentResource         `json:"departments,omitempty"`
	ServiceFeatures  []ServiceFeatureValue        `json:"serviceFeatures,omitempty"`
	RegionalSettings RegionalSettingsResource     `json:"regionalSettings,omitempty"`
	SetupWizardState string                       `json:"setupWizardState,omitempty"`
	Permissions      ExtensionPermissionsResource `json:"permissions,omitempty"`
	Password         string                       `json:"password,omitempty"`
	IvrPin           string                       `json:"ivrPin,omitempty"`
	ProfileImage     ProfileImageResource         `json:"profileImage,omitempty"`
}

type ExtensionSecretQuestionInfo ¶ 

type ExtensionSecretQuestionInfo struct {
	// Internal identifier of a secret question
	Id string `json:"id,omitempty"`
	// Link to a secret question resource
	Uri string `json:"uri,omitempty"`
	// Answer to a secret question
	Answer string `json:"answer,omitempty"`
}

type ExtensionServiceFeatureInfo ¶ 

type ExtensionServiceFeatureInfo struct {
	// Feature status; shows feature availability for an extension
	Enabled bool `json:"enabled,omitempty"`
	// Feature name, see all available values in Service Feature List
	FeatureName string `json:"featureName,omitempty"`
	// Reason of limitation for a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response
	Reason string `json:"reason,omitempty"`
}

type ExtensionStatusInfo ¶ 

type ExtensionStatusInfo struct {
	// A free-form user comment, describing the status change reason
	Comment string `json:"comment,omitempty"`
	// Type of suspension
	Reason string `json:"reason,omitempty"`
}

type ExtensionTimezoneInfoRequest ¶ 

type ExtensionTimezoneInfoRequest struct {
	// internal Identifier for timezone
	Id string `json:"id,omitempty"`
}

type ExtensionUpdateRequest ¶ 

type ExtensionUpdateRequest struct {
	Status     string              `json:"status,omitempty"`
	StatusInfo ExtensionStatusInfo `json:"statusInfo,omitempty"`
	// Type of suspension
	Reason string `json:"reason,omitempty"`
	// Free Form user comment
	Comment string `json:"comment,omitempty"`
	// Extension number available
	ExtensionNumber  string                          `json:"extensionNumber,omitempty"`
	Contact          ContactInfoUpdateRequest        `json:"contact,omitempty"`
	RegionalSettings ExtensionRegionalSettingRequest `json:"regionalSettings,omitempty"`
	SetupWizardState string                          `json:"setupWizardState,omitempty"`
	//  Extension partner identifier
	PartnerId string `json:"partnerId,omitempty"`
	// IVR PIN
	IvrPin string `json:"ivrPin,omitempty"`
	// Password for extension
	Password      string               `json:"password,omitempty"`
	CallQueueInfo CallQueueInfoRequest `json:"callQueueInfo,omitempty"`
	// For NotActivated extensions only. Welcome email setting
	Transition string `json:"transition,omitempty"`
}

type ExtensionUserCredentailsRequest ¶ 

type ExtensionUserCredentailsRequest struct {
	// User password of an extension
	Password string `json:"password,omitempty"`
	// User pin of an extension
	IvrPin         string                      `json:"ivrPin,omitempty"`
	SecretQuestion ExtensionSecretQuestionInfo `json:"secretQuestion,omitempty"`
}

type ExtensionUserCredentials ¶ 

type ExtensionUserCredentials struct {
	SecretQuestion SecretQuestionInfo `json:"secretQuestion,omitempty"`
}

type ExtensionUserGroupsResource ¶ 

type ExtensionUserGroupsResource struct {
	Uri    string                `json:"uri,omitempty"`
	Groups []UserGroupIdResource `json:"groups,omitempty"`
}

type ExtensionWithRolesCollectionResource ¶ 

type ExtensionWithRolesCollectionResource struct {
	Uri     string                       `json:"uri,omitempty"`
	Records []ExtensionWithRolesResource `json:"records,omitempty"`
}

type ExtensionWithRolesResource ¶ 

type ExtensionWithRolesResource struct {
	Uri         string                 `json:"uri,omitempty"`
	ExtensionId string                 `json:"extensionId,omitempty"`
	Roles       []AssignedRoleResource `json:"roles,omitempty"`
}

type Extensions ¶ 

type Extensions struct {
	Uri        string              `json:"uri,omitempty"`
	Records    []ExtensionResource `json:"records,omitempty"`
	Paging     Paging              `json:"paging,omitempty"`
	Navigation Navigation          `json:"navigation,omitempty"`
}

type FavoriteCollection ¶ 

type FavoriteCollection struct {
	Uri     string                    `json:"uri,omitempty"`
	Records []FavoriteContactResource `json:"records,omitempty"`
}

type FavoriteContactResource ¶ 

type FavoriteContactResource struct {
	Uri         string `json:"uri,omitempty"`
	Id          string `json:"id,omitempty"`
	ExtensionId string `json:"extensionId,omitempty"`
	ContactId   string `json:"contactId,omitempty"`
}

type FaxCallerInfo ¶ 

type FaxCallerInfo struct {
	// Recipient information. Phone number property is mandatory. Optional for resend fax request
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type FaxCountryInfo ¶ 

type FaxCountryInfo struct {
	// Internal identifier of a home country
	Id string `json:"id,omitempty"`
	// Country code in ISO 3166-1 alpha-2. If specified then country ID cannot be specified
	IsoCode string `json:"isoCode,omitempty"`
}

type FaxResendInfo ¶ 

type FaxResendInfo struct {
	OriginalMessageId int64        `json:"originalMessageId"`
	SendTime          time.Time    `json:"sendTime,omitempty"`
	To                []CallerInfo `json:"to,omitempty"`
}

type FaxResponse ¶ 

type FaxResponse struct {
	// Internal identifier of a message
	Id int64 `json:"id,omitempty"`
	// Canonical URI of a message
	Uri string `json:"uri,omitempty"`
	// Message type - 'Fax'
	Type string         `json:"type,omitempty"`
	From CallerInfoFrom `json:"from,omitempty"`
	// Recipient information
	To []CallerInfoTo `json:"to,omitempty"`
	// Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Message read status
	ReadStatus string `json:"readStatus,omitempty"`
	// Message priority
	Priority string `json:"priority,omitempty"`
	// The list of message attachments
	Attachments []MessageAttachmentInfoIntId `json:"attachments,omitempty"`
	// Message direction
	Direction string `json:"direction,omitempty"`
	// Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly
	Availability string `json:"availability,omitempty"`
	// Message status. 'Queued' - the message is queued for sending; 'Sent' - a message is successfully sent; 'SendingFailed' - a message sending attempt has failed; 'Received' - a message is received (inbound messages have this status by default)
	MessageStatus string `json:"messageStatus,omitempty"`
	// Resolution of a fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)
	FaxResolution string `json:"faxResolution,omitempty"`
	// Page count in a fax message
	FaxPageCount int32 `json:"faxPageCount,omitempty"`
	// Datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
	// Cover page identifier. For the list of available cover page identifiers please call the method Fax Cover Pages
	CoverIndex int32 `json:"coverIndex,omitempty"`
	// Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols
	CoverPageText string `json:"coverPageText,omitempty"`
}

type Feature ¶ 

type Feature struct {
	Enabled bool   `json:"enabled,omitempty"`
	Reason  Reason `json:"reason,omitempty"`
}

type Features ¶ 

type Features struct {
	Voip    Feature `json:"voip,omitempty"`
	RingOut Feature `json:"ringOut,omitempty"`
	Sms     Feature `json:"sms,omitempty"`
	FaxOut  Feature `json:"faxOut,omitempty"`
}

type FederationAccountInfo ¶ 

type FederationAccountInfo struct {
	// Internal identifier of an account
	Id string `json:"id,omitempty"`
	// Company name of an account
	CompanyName string `json:"companyName,omitempty"`
	// Federation name of an account
	FederatedName string `json:"federatedName,omitempty"`
	// Datetime when this account was linked to a federation, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
	LinkCreationTime string                   `json:"linkCreationTime,omitempty"`
	MainNumber       FederationMainNumberInfo `json:"mainNumber,omitempty"`
	// Count of federation extension numbers conflicting with extension numbers of the requested account. For extension numbers of the requested account the value of this parameter is '0'
	ConflictCount int32 `json:"conflictCount,omitempty"`
}

type FederationConflicts ¶ 

type FederationConflicts struct {
	// List of conflicting federation extensions
	Records []FederationExtensionInfo `json:"records"`
}

type FederationConflictsAccountInfo ¶ 

type FederationConflictsAccountInfo struct {
	// Internal identifier of an account
	Id string `json:"id,omitempty"`
	// Federated name of an account
	FederatedName string `json:"federatedName,omitempty"`
}

type FederationExtensionInfo ¶ 

type FederationExtensionInfo struct {
	// Internal identifier of an extension of current account
	Id string `json:"id,omitempty"`
	// Number of an extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Extension user first name
	FirstName string `json:"firstName,omitempty"`
	// Extension user last name
	LastName string `json:"lastName,omitempty"`
	// Conflicting extensions information
	Conflicts []ConflictsInfo `json:"conflicts,omitempty"`
}

type FederationExtensionNumbers ¶ 

type FederationExtensionNumbers struct {
	// List of extension numbers of the current federation
	Records []FederationExtensionNumbersExtensionInfo `json:"records"`
}

type FederationExtensionNumbersExtensionInfo ¶ 

type FederationExtensionNumbersExtensionInfo struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Number of an extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
}

type FederationInfo ¶ 

type FederationInfo struct {
	// Internal identifier of a federation
	Id string `json:"id,omitempty"`
	// Name of a federation
	DisplayName string `json:"displayName,omitempty"`
	// Datetime of federation creation, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Datetime of the last change of federation composition, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
	// List of countries which can be selected for a dialing plan
	Accounts []FederationAccountInfo `json:"accounts,omitempty"`
}

type FederationMainNumberInfo ¶ 

type FederationMainNumberInfo struct {
	// Main company number of an account in E.164 format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Main company number of an account formatted as consistent with the home country of the current extension
	FormattedPhoneNumber string `json:"formattedPhoneNumber,omitempty"`
}

type FeeChargeResource ¶ 

type FeeChargeResource struct {
	Description string  `json:"description,omitempty"`
	Amount      float32 `json:"amount,omitempty"`
	Feature     string  `json:"feature,omitempty"`
}

type File ¶ 

type File struct {
	SourceFile       string `json:"sourceFile,omitempty"`
	OriginalFileName string `json:"originalFileName,omitempty"`
}

type FilterSupported ¶ 

type FilterSupported struct {
	MaxResults int32 `json:"maxResults,omitempty"`
	Supported  bool  `json:"supported,omitempty"`
}

type FixedOrderAgents ¶ 

type FixedOrderAgents struct {
	Extension ExtensionInfo `json:"extension,omitempty"`
	// Ordinal of an agent (call queue member)
	Index int32 `json:"index,omitempty"`
}

type FormDataContentDisposition ¶ 

type FormDataContentDisposition struct {
	Type             string    `json:"type,omitempty"`
	FileName         string    `json:"fileName,omitempty"`
	CreationDate     time.Time `json:"creationDate,omitempty"`
	ModificationDate time.Time `json:"modificationDate,omitempty"`
	ReadDate         time.Time `json:"readDate,omitempty"`
	Size             int64     `json:"size,omitempty"`
	Name             string    `json:"name,omitempty"`
}

type FormFieldResource ¶ 

type FormFieldResource struct {
	Name        string `json:"name,omitempty"`
	FieldType   string `json:"fieldType,omitempty"`
	Description string `json:"description,omitempty"`
	MaxLength   int32  `json:"maxLength,omitempty"`
}

type FormattingLocaleInfo ¶ 

type FormattingLocaleInfo struct {
	// Internal identifier of a formatting language
	Id string `json:"id,omitempty"`
	// Localization code of a formatting language
	LocaleCode string `json:"localeCode,omitempty"`
	Name       string `json:"name,omitempty"`
}

Official name of a formatting language

type ForwardingInfo ¶ 

type ForwardingInfo struct {
	// Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers
	NotifyMySoftPhones bool `json:"notifyMySoftPhones,omitempty"`
	// Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'
	NotifyAdminSoftPhones bool `json:"notifyAdminSoftPhones,omitempty"`
	// Number of rings before forwarding starts
	SoftPhonesRingCount int32 `json:"softPhonesRingCount,omitempty"`
	// Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time
	RingingMode string `json:"ringingMode,omitempty"`
	// Information on a call forwarding rule
	Rules []RuleInfo `json:"rules,omitempty"`
}

type ForwardingInfoCreateRuleRequest ¶ 

type ForwardingInfoCreateRuleRequest struct {
	// Specifies if the first ring on desktop/mobile apps is enabled. The default value is 'True'
	NotifyMySoftPhones bool `json:"notifyMySoftPhones,omitempty"`
	// Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'True'
	NotifyAdminSoftPhones bool `json:"notifyAdminSoftPhones,omitempty"`
	// Specifies delay between ring on apps and starting of a call forwarding. The default value is 1
	SoftPhonesRingCount int32 `json:"softPhonesRingCount,omitempty"`
	// Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially'
	RingingMode string `json:"ringingMode,omitempty"`
	// Information on a call forwarding rule
	Rules []RuleInfoCreateRuleRequest `json:"rules,omitempty"`
}

type ForwardingNumberInfo ¶ 

type ForwardingNumberInfo struct {
	// Internal identifier of a forwarding/call flip phone number
	Id string `json:"id,omitempty"`
	// Canonical URI of a forwarding/call flip phone number
	Uri string `json:"uri,omitempty"`
	// Forwarding/Call flip phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Forwarding/Call flip number title
	Label string `json:"label,omitempty"`
	// Type of option this phone number is used for. Multiple values are accepted
	Features []string `json:"features,omitempty"`
	// Number assigned to the call flip phone number, corresponds to the shortcut dial number
	FlipNumber string `json:"flipNumber,omitempty"`
}

type ForwardingNumberInfoRules ¶ 

type ForwardingNumberInfoRules struct {
	// Link to a forwarding number resource
	Uri string `json:"uri,omitempty"`
	// Internal identifier of a forwarding number
	Id string `json:"id,omitempty"`
	// Phone number to which the call is forwarded
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Title of a forwarding number
	Label string `json:"label,omitempty"`
}

type ForwardingNumberInfoRulesCreateRuleRequest ¶ 

type ForwardingNumberInfoRulesCreateRuleRequest struct {
	// Internal identifier of a forwarding number
	Id string `json:"id,omitempty"`
}

type ForwardingNumberResource ¶ 

type ForwardingNumberResource struct {
	Uri         string   `json:"uri,omitempty"`
	Id          string   `json:"id,omitempty"`
	PhoneNumber string   `json:"phoneNumber,omitempty"`
	Label       string   `json:"label,omitempty"`
	Features    []string `json:"features,omitempty"`
	FlipNumber  string   `json:"flipNumber,omitempty"`
}

type ForwardingNumbersResource ¶ 

type ForwardingNumbersResource struct {
	Uri        string                     `json:"uri,omitempty"`
	Records    []ForwardingNumberResource `json:"records,omitempty"`
	Paging     Paging                     `json:"paging,omitempty"`
	Navigation Navigation                 `json:"navigation,omitempty"`
}

type GcmData ¶ 

type GcmData struct {
	// Event filter URI
	Event string `json:"event,omitempty"`
	// Internal identifier of a subscription
	SubscriptionId string `json:"subscriptionId,omitempty"`
	// The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	Timestamp time.Time `json:"timestamp,omitempty"`
	// Internal identifier of an extension
	ExtensionId string `json:"extensionId,omitempty"`
	// Calling action, for example 'StartRing'
	Action string `json:"action,omitempty"`
	// Identifier of a call session
	SessionId string `json:"sessionId,omitempty"`
	// Identifier of a server
	ServerId string `json:"serverId,omitempty"`
	// Phone number of a caller
	From string `json:"_from,omitempty"`
	// Caller name
	FromName string `json:"fromName,omitempty"`
	// Phone number of a callee
	To string `json:"to,omitempty"`
	// Callee name
	ToName string `json:"toName,omitempty"`
	// Unique identifier of a session
	Sid string `json:"sid,omitempty"`
	// SIP proxy registration name
	ToUrl string `json:"toUrl,omitempty"`
	// User data
	SrvLvl string `json:"srvLvl,omitempty"`
	// User data
	SrvLvlExt string `json:"srvLvlExt,omitempty"`
}

type GcmInfo ¶ 

type GcmInfo struct {
	// Notification priority, if the value is 'high' then notification is turned on even if the application is in background
	Priority string `json:"priority,omitempty"`
	// Notification lifetime value in seconds, the default value is 30 seconds
	TimeToLive int32   `json:"time_to_live,omitempty"`
	Data       GcmData `json:"data,omitempty"`
}

type GenericOpenAPIError ¶ 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body ¶ 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error ¶ 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model ¶ 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetAccountCallLogRecordResponse ¶ 

type GetAccountCallLogRecordResponse struct {
	// Internal identifier of a cal log record
	Id string `json:"id,omitempty"`
	// Canonical URI of a call log record
	Uri string `json:"uri,omitempty"`
	// Internal identifier of a call session
	SessionId string            `json:"sessionId,omitempty"`
	From      CallLogCallerInfo `json:"from,omitempty"`
	To        CallLogCallerInfo `json:"to,omitempty"`
	// Call type
	Type string `json:"type,omitempty"`
	// Call direction
	Direction string `json:"direction,omitempty"`
	// Action description of the call operation
	Action string `json:"action,omitempty"`
	// Status description of the call operation
	Result string `json:"result,omitempty"`
	// The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	StartTime time.Time `json:"startTime,omitempty"`
	// Call duration in seconds
	Duration  int32         `json:"duration,omitempty"`
	Recording RecordingInfo `json:"recording,omitempty"`
}

type GetAccountDevicesResponse ¶ 

type GetAccountDevicesResponse struct {
	// List of extension records
	Records    []GetDeviceInfoResponse `json:"records"`
	Navigation NavigationInfo          `json:"navigation"`
	Paging     PagingInfo              `json:"paging"`
}

type GetAccountInfoResponse ¶ 

type GetAccountInfoResponse struct {
	// Internal identifier of an account
	Id string `json:"id,omitempty"`
	// Canonical URI of an account
	Uri string `json:"uri,omitempty"`
	// Main phone number of the current account
	MainNumber string                   `json:"mainNumber,omitempty"`
	Operator   GetExtensionInfoResponse `json:"operator,omitempty"`
	// Additional account identifier, developed and applied by the client
	PartnerId   string      `json:"partnerId,omitempty"`
	ServiceInfo ServiceInfo `json:"serviceInfo,omitempty"`
	// Specifies account configuration wizard state (web service setup). The default value is 'NotStarted'
	SetupWizardState string `json:"setupWizardState,omitempty"`
	// Status of the current account
	Status           string            `json:"status,omitempty"`
	StatusInfo       AccountStatusInfo `json:"statusInfo,omitempty"`
	RegionalSettings RegionalSettings  `json:"regionalSettings,omitempty"`
	// Specifies whether an account is included into any federation of accounts or not
	Federated bool `json:"federated,omitempty"`
}

type GetAttachmentOpts ¶ 

type GetAttachmentOpts struct {
	Range_ optional.String
}

type GetCallRecordingResponse ¶ 

type GetCallRecordingResponse struct {
	// Internal identifier of the call recording
	Id string `json:"id,omitempty"`
	// Link to the call recording binary content
	ContentUri string `json:"contentUri,omitempty"`
	// Call recording file format. Supported format is audio/x-wav
	ContentType string `json:"contentType,omitempty"`
	// Recorded call duration
	Duration int32 `json:"duration,omitempty"`
}

type GetCallRecordsOpts ¶ 

type GetCallRecordsOpts struct {
	View optional.String
}

type GetConferencingInfoResponse ¶ 

type GetConferencingInfoResponse struct {
	// Canonical URI of a conferencing
	Uri string `json:"uri,omitempty"`
	// Determines if host user allows conference participants to join before the host
	AllowJoinBeforeHost bool `json:"allowJoinBeforeHost,omitempty"`
	// Access code for a host user
	HostCode string `json:"hostCode,omitempty"`
	// Internal parameter specifying conferencing engine
	Mode string `json:"mode,omitempty"`
	// Access code for any participant
	ParticipantCode string `json:"participantCode,omitempty"`
	// Primary conference phone number for user's home country returned in E.164 (11-digits) format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Short URL leading to the service web page Tap to Join for audio conference bridge
	TapToJoinUri string `json:"tapToJoinUri,omitempty"`
	// List of multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic
	PhoneNumbers []PhoneNumberInfoConferencing `json:"phoneNumbers,omitempty"`
}

type GetCountryInfoConferencing ¶ 

type GetCountryInfoConferencing struct {
	// Internal identifier of a country
	Id string `json:"id,omitempty"`
	// Canonical URI of a country
	Uri string `json:"uri,omitempty"`
	// Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes
	CallingCode string `json:"callingCode,omitempty"`
	// Emergency calling feature availability/emergency address requirement indicator
	EmergencyCalling bool `json:"emergencyCalling,omitempty"`
	// Country code according to the ISO standard, see ISO 3166
	IsoCode string `json:"isoCode,omitempty"`
	// Official name of a country
	Name string `json:"name,omitempty"`
}

type GetCountryInfoDictionaryResponse ¶ 

type GetCountryInfoDictionaryResponse struct {
	// Internal identifier of a country
	Id string `json:"id,omitempty"`
	// Canonical URI of a country
	Uri string `json:"uri,omitempty"`
	// Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes
	CallingCode string `json:"callingCode,omitempty"`
	// Emergency calling feature availability/emergency address requirement indicator
	EmergencyCalling bool `json:"emergencyCalling,omitempty"`
	// Country code according to the ISO standard, see ISO 3166
	IsoCode string `json:"isoCode,omitempty"`
	// Official name of a country
	Name string `json:"name,omitempty"`
	// Determines whether phone numbers are available for a country
	NumberSelling bool `json:"numberSelling,omitempty"`
	// Specifies whether login with the phone numbers of this country is enabled or not
	LoginAllowed bool `json:"loginAllowed,omitempty"`
	// Indicates whether signup/billing is allowed for a country
	SignupAllowed bool `json:"signupAllowed,omitempty"`
	// Specifies if free phone line for softphone is available for a country or not
	FreeSoftphoneLine bool `json:"freeSoftphoneLine,omitempty"`
}

type GetCountryInfoNumberParser ¶ 

type GetCountryInfoNumberParser struct {
	// Internal identifier of a country
	Id string `json:"id,omitempty"`
	// Canonical URI of a country
	Uri string `json:"uri,omitempty"`
	// Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes
	CallingCode string `json:"callingCode,omitempty"`
	// Emergency calling feature availability/emergency address requirement indicator
	EmergencyCalling bool `json:"emergencyCalling,omitempty"`
	// Country code according to the ISO standard, see ISO 3166
	IsoCode string `json:"isoCode,omitempty"`
	// Official name of a country
	Name string `json:"name,omitempty"`
}

type GetCountryInfoState ¶ 

type GetCountryInfoState struct {
	// Internal identifier of a state
	Id string `json:"id,omitempty"`
	// Canonical URI of a state
	Uri string `json:"uri,omitempty"`
}

type GetCountryListResponse ¶ 

type GetCountryListResponse struct {
	// List of countries with the country data
	Records    []GetCountryInfoDictionaryResponse `json:"records"`
	Navigation NavigationInfo                     `json:"navigation"`
	Paging     PagingInfo                         `json:"paging"`
}

type GetDeviceInfoResponse ¶ 

type GetDeviceInfoResponse struct {
	// Internal identifier of a device
	Id string `json:"id,omitempty"`
	// Canonical URI of a device
	Uri string `json:"uri,omitempty"`
	// Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'
	Sku string `json:"sku,omitempty"`
	// Device type. The default value is 'HardPhone'
	Type string `json:"type,omitempty"`
	// Device name. Mandatory if ordering  SoftPhone  or  OtherPhone . Optional for  HardPhone . If not specified for HardPhone, then device model  name is used as device  name
	Name string `json:"name,omitempty"`
	// Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications
	Serial string `json:"serial,omitempty"`
	// PC name for softphone
	ComputerName            string               `json:"computerName,omitempty"`
	Model                   ModelInfo            `json:"model,omitempty"`
	Extension               ExtensionInfoIntId   `json:"extension,omitempty"`
	EmergencyServiceAddress EmergencyAddressInfo `json:"emergencyServiceAddress,omitempty"`
	// Phone lines information
	PhoneLines []PhoneLinesInfo `json:"phoneLines,omitempty"`
	Shipping   ShippingInfo     `json:"shipping,omitempty"`
	// Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model  structure, or  boxBillingId  must be specified forT?HardPhone
	BoxBillingId int32 `json:"boxBillingId,omitempty"`
}

type GetDialingPlanCountryInfo ¶ 

type GetDialingPlanCountryInfo struct {
	// Internal identifier of a country
	Id string `json:"id,omitempty"`
	// Canonical URI of a country
	Uri string `json:"uri,omitempty"`
	// Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes
	CallingCode string `json:"callingCode,omitempty"`
	// Country code according to the ISO standard, see ISO 3166
	IsoCode string `json:"isoCode,omitempty"`
	// Official name of a country
	Name string `json:"name,omitempty"`
}

type GetDialingPlanInfo ¶ 

type GetDialingPlanInfo struct {
	// List of countries which can be selected for a dialing plan
	Records    []GetDialingPlanCountryInfo `json:"records"`
	Paging     PagingInfo                  `json:"paging"`
	Navigation NavigationInfo              `json:"navigation"`
}

type GetExtensionCallLogRecordResponse ¶ 

type GetExtensionCallLogRecordResponse struct {
	// Internal identifier of a cal log record
	Id string `json:"id,omitempty"`
	// Canonical URI of a call log record
	Uri string `json:"uri,omitempty"`
	// Internal identifier of a call session
	SessionId string            `json:"sessionId,omitempty"`
	From      CallLogCallerInfo `json:"from,omitempty"`
	To        CallLogCallerInfo `json:"to,omitempty"`
	// Call type
	Type string `json:"type,omitempty"`
	// Call direction
	Direction string `json:"direction,omitempty"`
	// Action description of the call operation
	Action string `json:"action,omitempty"`
	// Status description of the call operation
	Result string `json:"result,omitempty"`
	// The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	StartTime time.Time `json:"startTime,omitempty"`
	// Call duration in seconds
	Duration  int32         `json:"duration,omitempty"`
	Recording RecordingInfo `json:"recording,omitempty"`
}

type GetExtensionDevicesResponse ¶ 

type GetExtensionDevicesResponse struct {
	// List of extension devices
	Records    []GetDeviceInfoResponse `json:"records"`
	Navigation NavigationInfo          `json:"navigation"`
	Paging     PagingInfo              `json:"paging"`
}

type GetExtensionForwardingNumberListResponse ¶ 

type GetExtensionForwardingNumberListResponse struct {
	// List of forwarding phone numbers
	Records    []ForwardingNumberInfo `json:"records,omitempty"`
	Navigation NavigationInfo         `json:"navigation,omitempty"`
	Paging     PagingInfo             `json:"paging,omitempty"`
}

type GetExtensionGrantListResponse ¶ 

type GetExtensionGrantListResponse struct {
	// List of extension grants with the data
	Records    []GrantInfo    `json:"records"`
	Navigation NavigationInfo `json:"navigation"`
	Paging     PagingInfo     `json:"paging"`
}

type GetExtensionInfoResponse ¶ 

type GetExtensionInfoResponse struct {
	// Internal identifier of an extension
	Id int64 `json:"id"`
	// Canonical URI of an extension
	Uri     string      `json:"uri"`
	Contact ContactInfo `json:"contact,omitempty"`
	// Information on department extension(s), to which the requested extension belongs. Returned only for user extensions, members of department, requested by single extensionId
	Departments []DepartmentInfo `json:"departments,omitempty"`
	// Number of department extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Extension user name
	Name string `json:"name,omitempty"`
	// For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension
	PartnerId    string               `json:"partnerId,omitempty"`
	Permissions  ExtensionPermissions `json:"permissions,omitempty"`
	ProfileImage ProfileImageInfo     `json:"profileImage"`
	// List of non-RC internal identifiers assigned to an extension
	References       []ReferenceInfo  `json:"references,omitempty"`
	RegionalSettings RegionalSettings `json:"regionalSettings,omitempty"`
	// Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features
	ServiceFeatures []ExtensionServiceFeatureInfo `json:"serviceFeatures,omitempty"`
	// Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted'
	SetupWizardState string `json:"setupWizardState,omitempty"`
	// Extension current state. If the status is 'Unassigned'. Returned for all extensions
	Status     string              `json:"status"`
	StatusInfo ExtensionStatusInfo `json:"statusInfo,omitempty"`
	// Extension type
	Type          string        `json:"type"`
	CallQueueInfo CallQueueInfo `json:"callQueueInfo,omitempty"`
}

type GetExtensionListResponse ¶ 

type GetExtensionListResponse struct {
	// List of extensions with extension information
	Records    []GetExtensionInfoResponse `json:"records"`
	Navigation NavigationInfo             `json:"navigation"`
	Paging     PagingInfo                 `json:"paging"`
}

type GetExtensionPhoneNumbersResponse ¶ 

type GetExtensionPhoneNumbersResponse struct {
	// List of phone numbers
	Records    []PhoneNumberInfo `json:"records"`
	Navigation NavigationInfo    `json:"navigation"`
	Paging     PagingInfo        `json:"paging"`
}

type GetFaxCoverPagesOpts ¶ 

type GetFaxCoverPagesOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type GetGreetingsOpts ¶ 

type GetGreetingsOpts struct {
	Page      optional.Int32
	PerPage   optional.Int32
	Type_     optional.String
	UsageType optional.String
}

type GetLocationListResponse ¶ 

type GetLocationListResponse struct {
	// List of locations
	Records    []LocationInfo `json:"records,omitempty"`
	Navigation NavigationInfo `json:"navigation"`
	Paging     PagingInfo     `json:"paging"`
}

type GetMessageInfoResponse ¶ 

type GetMessageInfoResponse struct {
	// Internal identifier of a message
	Id string `json:"id,omitempty"`
	// Canonical URI of a message
	Uri string `json:"uri,omitempty"`
	// The list of message attachments
	Attachments []MessageAttachmentInfo `json:"attachments,omitempty"`
	// Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly
	Availability string `json:"availability,omitempty"`
	// SMS and Pager only. Identifier of the conversation the message belongs to
	ConversationId int32 `json:"conversationId,omitempty"`
	// Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	CreationTime time.Time `json:"creationTime,omitempty"`
	// SMS only. Delivery error code returned by gateway
	DeliveryErrorCode string `json:"deliveryErrorCode,omitempty"`
	// Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound
	Direction string `json:"direction,omitempty"`
	// Fax only. Page count in fax message
	FaxPageCount int32 `json:"faxPageCount,omitempty"`
	// Fax only. Resolution of fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)
	FaxResolution string                         `json:"faxResolution,omitempty"`
	From          MessageStoreCallerInfoResponse `json:"from,omitempty"`
	// The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
	// Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned
	MessageStatus string `json:"messageStatus,omitempty"`
	// Pager only True if at least one of the message recipients is Department extension
	PgToDepartment bool `json:"pgToDepartment,omitempty"`
	// Message priority
	Priority string `json:"priority,omitempty"`
	// Message read status
	ReadStatus string `json:"readStatus,omitempty"`
	// SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral
	SmsDeliveryTime time.Time `json:"smsDeliveryTime,omitempty"`
	// SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)
	SmsSendingAttemptsCount int32 `json:"smsSendingAttemptsCount,omitempty"`
	// Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment
	Subject string `json:"subject,omitempty"`
	// Recipient information
	To []MessageStoreCallerInfoResponse `json:"to,omitempty"`
	// Message type
	Type string `json:"type,omitempty"`
	// Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned
	VmTranscriptionStatus string `json:"vmTranscriptionStatus,omitempty"`
}

type GetMessageInfoResponseIntId ¶ 

type GetMessageInfoResponseIntId struct {
	// Internal identifier of a message
	Id int64 `json:"id,omitempty"`
	// Canonical URI of a message
	Uri string `json:"uri,omitempty"`
	// The list of message attachments
	Attachments []MessageAttachmentInfoIntId `json:"attachments,omitempty"`
	// Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly
	Availability string `json:"availability,omitempty"`
	// SMS and Pager only. Identifier of the conversation the message belongs to
	ConversationId int64 `json:"conversationId,omitempty"`
	// Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	CreationTime time.Time `json:"creationTime,omitempty"`
	// SMS only. Delivery error code returned by gateway
	DeliveryErrorCode string `json:"deliveryErrorCode,omitempty"`
	// Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound
	Direction string `json:"direction,omitempty"`
	// Fax only. Page count in fax message
	FaxPageCount int32 `json:"faxPageCount,omitempty"`
	// Fax only. Resolution of fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)
	FaxResolution string                         `json:"faxResolution,omitempty"`
	From          MessageStoreCallerInfoResponse `json:"from,omitempty"`
	// The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
	// Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned
	MessageStatus string `json:"messageStatus,omitempty"`
	// Pager only True if at least one of the message recipients is Department extension
	PgToDepartment bool `json:"pgToDepartment,omitempty"`
	// Message priority
	Priority string `json:"priority,omitempty"`
	// Message read status
	ReadStatus string `json:"readStatus,omitempty"`
	// SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral
	SmsDeliveryTime time.Time `json:"smsDeliveryTime,omitempty"`
	// SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)
	SmsSendingAttemptsCount int32 `json:"smsSendingAttemptsCount,omitempty"`
	// Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment
	Subject string `json:"subject,omitempty"`
	// Recipient information
	To []MessageStoreCallerInfoResponse `json:"to,omitempty"`
	// Message type
	Type string `json:"type,omitempty"`
	// Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned
	VmTranscriptionStatus string `json:"vmTranscriptionStatus,omitempty"`
}

type GetMessageList ¶ 

type GetMessageList struct {
	// List of records with message information
	Records    []GetMessageInfoResponseIntId `json:"records"`
	Navigation NavigationInfo                `json:"navigation"`
	Paging     PagingInfo                    `json:"paging"`
}

type GetMessageSyncResponse ¶ 

type GetMessageSyncResponse struct {
	// List of message records with synchronization information
	Records  []GetMessageInfoResponse `json:"records"`
	SyncInfo SyncInfoMessages         `json:"syncInfo"`
}

type GetMonitoredExtensionsResponse ¶ 

type GetMonitoredExtensionsResponse struct {
	// Canonical URI of the monitored lines (extensions) resource
	Uri string `json:"uri,omitempty"`
	// List of lines (extensions) the presence of which is monitored by the user. The first two lines always indicate the user's extension presence, they cannot be changed
	Records    []LineInfo     `json:"records"`
	Navigation NavigationInfo `json:"navigation"`
	Paging     PagingInfo     `json:"paging"`
}

type GetPagingOnlyGroupDevicesOpts ¶ 

type GetPagingOnlyGroupDevicesOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type GetPagingOnlyGroupUsersOpts ¶ 

type GetPagingOnlyGroupUsersOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type GetParkLocationUsersOpts ¶ 

type GetParkLocationUsersOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type GetPresenceExtensionInfo ¶ 

type GetPresenceExtensionInfo struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Canonical URI of an extension
	Uri string `json:"uri,omitempty"`
	// Extension number (usually 3 or 4 digits)
	ExtensionNumber string `json:"extensionNumber,omitempty"`
}

type GetPresenceInfo ¶ 

type GetPresenceInfo struct {
	// Canonical URI of a presence info resource
	Uri string `json:"uri,omitempty"`
	// If 'True' enables other extensions to see the extension presence status
	AllowSeeMyPresence bool `json:"allowSeeMyPresence,omitempty"`
	// Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only.
	DndStatus string                   `json:"dndStatus,omitempty"`
	Extension GetPresenceExtensionInfo `json:"extension,omitempty"`
	// Custom status message (as previously published by user)
	Message string `json:"message,omitempty"`
	// If 'True' enables the extension user to pick up a monitored line on hold
	PickUpCallsOnHold bool `json:"pickUpCallsOnHold,omitempty"`
	// Aggregated presence status, calculated from a number of sources
	PresenceStatus string `json:"presenceStatus,omitempty"`
	// If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
	RingOnMonitoredCall bool `json:"ringOnMonitoredCall,omitempty"`
	// Telephony presence status
	TelephonyStatus string `json:"telephonyStatus,omitempty"`
	// User-defined presence status (as previously published by the user)
	UserStatus string `json:"userStatus,omitempty"`
	// Information on active calls
	ActiveCalls []ActiveCallInfo `json:"activeCalls,omitempty"`
}

type GetReportingSettingsResponse ¶ 

type GetReportingSettingsResponse struct {
	// List of 'View' structures with a tuple of filter values, pages and schedules
	Views []ViewInfoReporting `json:"views"`
}

type GetRingOutStatusResponse ¶ 

type GetRingOutStatusResponse struct {
	// Internal identifier of a RingOut call
	Id     string            `json:"id,omitempty"`
	Uri    string            `json:"uri,omitempty"`
	Status RingOutStatusInfo `json:"status,omitempty"`
}

type GetRingOutStatusResponseIntId ¶ 

type GetRingOutStatusResponseIntId struct {
	// Internal identifier of a RingOut call
	Id     int64             `json:"id,omitempty"`
	Uri    string            `json:"uri,omitempty"`
	Status RingOutStatusInfo `json:"status,omitempty"`
}

type GetSecretQuestionListResponse ¶ 

type GetSecretQuestionListResponse struct {
	// Canonical URI of a question list resource
	Uri string `json:"uri,omitempty"`
	// List of secret questions with their descriptions
	Records    []SecretQuestionInfo `json:"records,omitempty"`
	Navigation NavigationInfo       `json:"navigation,omitempty"`
	Paging     PagingInfo           `json:"paging,omitempty"`
}

type GetServiceInfoResponse ¶ 

type GetServiceInfoResponse struct {
	// Canonical URI of the account Service Info resource
	Uri string `json:"uri,omitempty"`
	// Account Service Plan name
	ServicePlanName string `json:"servicePlanName,omitempty"`
	// Service features information, see Service Feature List
	ServiceFeatures []ServiceFeatureInfo `json:"serviceFeatures,omitempty"`
	Limits          AccountLimits        `json:"limits,omitempty"`
}

type GetSpecialNumberRulesOpts ¶ 

type GetSpecialNumberRulesOpts struct {
	CountryId optional.Int32
}

type GetStateInfoResponse ¶ 

type GetStateInfoResponse struct {
	// Internal identifier of a state
	Id string `json:"id,omitempty"`
	// Canonical URI of a state
	Uri     string              `json:"uri,omitempty"`
	Country GetCountryInfoState `json:"country,omitempty"`
	// Short code for a state (2-letter usually)
	IsoCode string `json:"isoCode,omitempty"`
	// Official name of a state
	Name string `json:"name,omitempty"`
}

type GetStateListResponse ¶ 

type GetStateListResponse struct {
	// List of states
	Records    []GetStateInfoResponse `json:"records"`
	Navigation NavigationInfo         `json:"navigation"`
	Paging     PagingInfo             `json:"paging"`
}

type GetTimezoneInfoResponse ¶ 

type GetTimezoneInfoResponse struct {
	// Internal identifier of a timezone
	Id string `json:"id,omitempty"`
	// Canonical URI of the timezone
	Uri string `json:"uri,omitempty"`
	// Short name of the timezone
	Name string `json:"name,omitempty"`
	// Description of the timezone
	Description string `json:"description,omitempty"`
}

type GetTimezoneListResponse ¶ 

type GetTimezoneListResponse struct {
	// List of timezones
	Records    []GetTimezoneInfoResponse `json:"records"`
	Navigation NavigationInfo            `json:"navigation"`
	Paging     PagingInfo                `json:"paging"`
}

type GetUserBusinessHoursResponse ¶ 

type GetUserBusinessHoursResponse struct {
	// Canonical URI of a business-hours resource
	Uri      string                        `json:"uri,omitempty"`
	Schedule ScheduleInfoUserBusinessHours `json:"schedule,omitempty"`
}

type GetUserListResponse ¶ 

type GetUserListResponse struct {
	// Specification links
	Schemas []string `json:"schemas,omitempty"`
	// 1-based index of query result
	StartIndex int32 `json:"startIndex,omitempty"`
	// Results count
	TotalResults int32 `json:"totalResults,omitempty"`
	// List of users with detailed info
	Resources []UserInfo `json:"Resources,omitempty"`
	// Number of users displayed per page
	ItemsPerPage int32 `json:"itemsPerPage,omitempty"`
}

type GetVersionResponse ¶ 

type GetVersionResponse struct {
	// Canonical URI of the version info resource
	Uri string `json:"uri,omitempty"`
	// Version of the RingCentral REST API
	VersionString string `json:"versionString,omitempty"`
	// Release date of this version
	ReleaseDate string `json:"releaseDate,omitempty"`
	// URI part determining the current version
	UriString string `json:"uriString,omitempty"`
}

type GetVersionsResponse ¶ 

type GetVersionsResponse struct {
	// Canonical URI of the API version
	Uri string `json:"uri,omitempty"`
	// Full API version information: uri, number, release date
	ApiVersions []VersionInfo `json:"apiVersions,omitempty"`
	// Server version
	ServerVersion string `json:"serverVersion,omitempty"`
	// Server revision
	ServerRevision string `json:"serverRevision,omitempty"`
}

type GlipApiService ¶ 

type GlipApiService service

func (*GlipApiService) CreateGlipFile ¶ 

func (a *GlipApiService) CreateGlipFile(ctx context.Context, body *os.File, localVarOptionals *CreateGlipFileOpts) (PostGlipFile, *http.Response, error)

func (*GlipApiService) CreateGroup ¶ 

func (a *GlipApiService) CreateGroup(ctx context.Context, glipCreateGroup GlipCreateGroup) (GlipGroupInfo, *http.Response, error)

GlipApiService Create Group <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Creates a group.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param glipCreateGroup JSON body

@return GlipGroupInfo

func (*GlipApiService) CreatePost ¶ 

func (a *GlipApiService) CreatePost(ctx context.Context, groupId string, glipCreatePost GlipCreatePost) (GlipPostInfo, *http.Response, error)

GlipApiService Create Post <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Creates a post.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Id of a group to send post
  • @param glipCreatePost JSON body

@return GlipPostInfo

func (*GlipApiService) LoadCompany ¶ 

func (a *GlipApiService) LoadCompany(ctx context.Context, companyId string) (GlipCompany, *http.Response, error)

GlipApiService Get Company Info <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a company by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param companyId Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to

@return GlipCompany

func (*GlipApiService) LoadGlipFile ¶ 

func (a *GlipApiService) LoadGlipFile(ctx context.Context, fileId string) (PostGlipFile, *http.Response, error)

GlipApiService Get File Info <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a file.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileId Internal identifier of file.

@return PostGlipFile

func (*GlipApiService) LoadGroup ¶ 

func (a *GlipApiService) LoadGroup(ctx context.Context, groupId string) (GlipGroupInfo, *http.Response, error)

GlipApiService Get Group <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a group or few groups by ID(s). Batch request is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Internal identifier of a group to be returned, the maximum number of IDs is 30

@return GlipGroupInfo

func (*GlipApiService) LoadGroupList ¶ 

func (a *GlipApiService) LoadGroupList(ctx context.Context, localVarOptionals *LoadGroupListOpts) (GlipGroupList, *http.Response, error)

func (*GlipApiService) LoadPerson ¶ 

func (a *GlipApiService) LoadPerson(ctx context.Context, personId string) (GlipPersonInfo, *http.Response, error)

GlipApiService Get Person <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a user or few users by ID(s). Batch request is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param personId Internal identifier of a user to be returned, the maximum number of IDs is 30

@return GlipPersonInfo

func (*GlipApiService) LoadPosts ¶ 

func (a *GlipApiService) LoadPosts(ctx context.Context, groupId string, localVarOptionals *LoadPostsOpts) (GlipPosts, *http.Response, error)

func (*GlipApiService) LoadUnreadMessageCount ¶ 

func (a *GlipApiService) LoadUnreadMessageCount(ctx context.Context, localVarOptionals *LoadUnreadMessageCountOpts) (GlipUnreadMessageCount, *http.Response, error)

func (*GlipApiService) UpdateGroup ¶ 

func (a *GlipApiService) UpdateGroup(ctx context.Context, groupId string, editGroupRequest EditGroupRequest) (GlipGroupInfo, *http.Response, error)

GlipApiService Edit Group Members <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates group members. Please note: Only groups of 'Team' type can be updated. Currently only one operation at a time (either adding or removal) is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId Internal identifier of a group to be edited
  • @param editGroupRequest JSON body

@return GlipGroupInfo

type GlipApnsInfo ¶ 

type GlipApnsInfo struct {
	Aps ApsInfo `json:"aps,omitempty"`
	// Datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	Timestamp time.Time `json:"timestamp,omitempty"`
	// Universally unique identifier of a notification
	Uuid string `json:"uuid,omitempty"`
	// Event filter URI
	Event string `json:"event,omitempty"`
	// Internal identifier of a subscription
	SubscriptionId string                     `json:"subscriptionId,omitempty"`
	Body           GlipUnreadMessageCountInfo `json:"body,omitempty"`
}

type GlipCompany ¶ 

type GlipCompany struct {
	// Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to
	Id string `json:"id"`
	// Name of a company
	Name string `json:"name,omitempty"`
	// Domain name of a company
	Domain string `json:"domain,omitempty"`
	// Datetime of creation in ISO 8601 format
	CreationTime string `json:"creationTime"`
	// Datetime of last modification in ISO 8601 format
	LastModifiedTime string `json:"lastModifiedTime"`
}

type GlipCreateGroup ¶ 

type GlipCreateGroup struct {
	// Type of a group to be created. 'PrivateChat' is a group of 2 members. 'Team' is a chat of 1 and more participants, the membership can be modified in future
	Type string `json:"type"`
	// For 'Team' group type only. Team access level
	IsPublic bool `json:"isPublic,omitempty"`
	// For 'Team' group type only. Team name
	Name string `json:"name,omitempty"`
	// For 'Team' group type only. Team description
	Description string `json:"description,omitempty"`
	// Identifier(s) of group members. For 'PrivateChat' group type 2 members only are supported
	Members []string `json:"members,omitempty"`
}

type GlipCreatePost ¶ 

type GlipCreatePost struct {
	// Text of a post, the maximum is 10000 unicode characters
	Text string `json:"text,omitempty"`
	// List of attachments to be posted
	Attachments []GlipMessageAttachmentInfoRequest `json:"attachments,omitempty"`
}

type GlipGroupInfo ¶ 

type GlipGroupInfo struct {
	// Internal identifier of a group
	Id string `json:"id,omitempty"`
	// Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future
	Type string `json:"type,omitempty"`
	// For 'Team' group type only. Team access level
	IsPublic bool `json:"isPublic,omitempty"`
	// For 'Team' group type only. Team name
	Name string `json:"name,omitempty"`
	// For 'Team' group type only. Team description
	Description string `json:"description,omitempty"`
	// Identifier(s) of group members
	Members []string `json:"members,omitempty"`
	// Group creation datetime in ISO 8601 format
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Group last change datetime in ISO 8601 format
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
}

type GlipGroupList ¶ 

type GlipGroupList struct {
	// List of groups/teams/private chats
	Records    []GlipGroupInfo    `json:"records"`
	Navigation GlipNavigationInfo `json:"navigation,omitempty"`
}

type GlipGroupsEvent ¶ 

type GlipGroupsEvent struct {
	// Internal identifier of a group
	Id string `json:"id,omitempty"`
	// Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user
	Type string `json:"type,omitempty"`
	// For 'Team' group type only. Team access level
	IsPublic bool `json:"isPublic,omitempty"`
	// For 'Team' group type only. Team name
	Name string `json:"name,omitempty"`
	// For 'Team' group type only. Team description
	Description string `json:"description,omitempty"`
	// Identifier(s) of group members
	Members []string `json:"members,omitempty"`
	// Group creation datetime in ISO 8601 format
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Group last change datetime in ISO 8601 format
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
	// Type of a group event. Only the person who joined/was added to a group will receive 'GroupJoined' notification. Only the person who left/was removed from a group will receive 'GroupLeft' notification
	EventType string `json:"eventType,omitempty"`
}

type GlipMentionsInfo ¶ 

type GlipMentionsInfo struct {
	// Id of the user
	Id string `json:"id,omitempty"`
	// Type of mentions
	Type string `json:"type,omitempty"`
	// Name of the user
	Name string `json:"name,omitempty"`
}

type GlipMessageAttachmentAuthorInfo ¶ 

type GlipMessageAttachmentAuthorInfo struct {
	// The author name
	Name string `json:"name,omitempty"`
	// Used to link the authors name
	Uri string `json:"uri,omitempty"`
	// A url to an image up to 82x82px that will display to the left of the author’s name
	IconUri string `json:"iconUri,omitempty"`
}

type GlipMessageAttachmentFieldsInfo ¶ 

type GlipMessageAttachmentFieldsInfo struct {
	// Title for an individual field
	Title string `json:"title,omitempty"`
	// Field Value (Supports Markdown)
	Value string `json:"value,omitempty"`
	// A style used to flag fields that should span the width of the message, Defaults to 'Short' (Not full width)
	Style string `json:"style,omitempty"`
}

type GlipMessageAttachmentFootnoteInfo ¶ 

type GlipMessageAttachmentFootnoteInfo struct {
	// A string used to be displayed as the body of the footer.
	Text string `json:"text,omitempty"`
	// A URL used to display a 32x32px icon to the left of the footer
	IconUri string `json:"iconUri,omitempty"`
	// A Unix timestamp to be displayed to the right of the footer (prettified)
	Time time.Time `json:"time,omitempty"`
}

type GlipMessageAttachmentInfo ¶ 

type GlipMessageAttachmentInfo struct {
	// Internal identifier of an attachment
	Id string `json:"id,omitempty"`
	// Type of an attachment
	Type string `json:"type,omitempty"`
	// A string of default text that will be rendered in the case that the client does not support Interactive Messages
	Fallback string `json:"fallback,omitempty"`
	// A Hex color code that determines the color of the side border of the Interactive Message
	Color string `json:"color,omitempty"`
	// A pretext to the message
	Intro  string                          `json:"intro,omitempty"`
	Author GlipMessageAttachmentAuthorInfo `json:"author,omitempty"`
	// Message title
	Title string `json:"title,omitempty"`
	// A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)
	Text string `json:"text,omitempty"`
	// url used to display a single image at the bottom of a message
	ImageUri string `json:"imageUri,omitempty"`
	// url used to display a thumbnail to the right of a message (82x82)
	ThumbnailUri string `json:"thumbnailUri,omitempty"`
	// Information on navigation
	Fields   []GlipMessageAttachmentFieldsInfo `json:"fields,omitempty"`
	Footnote GlipMessageAttachmentFootnoteInfo `json:"footnote,omitempty"`
}

type GlipMessageAttachmentInfoRequest ¶ 

type GlipMessageAttachmentInfoRequest struct {
	// Type of an attachment
	Type string `json:"type,omitempty"`
	// A string of default text that will be rendered in the case that the client does not support Interactive Messages
	Fallback string `json:"fallback,omitempty"`
	// A Hex color code that determines the color of the side border of the Interactive Message
	Color string `json:"color,omitempty"`
	// A pretext to the message
	Intro  string                          `json:"intro,omitempty"`
	Author GlipMessageAttachmentAuthorInfo `json:"author,omitempty"`
	// Message title
	Title string `json:"title,omitempty"`
	// A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)
	Text string `json:"text,omitempty"`
	// url used to display a single image at the bottom of a message
	ImageUri string `json:"imageUri,omitempty"`
	// url used to display a thumbnail to the right of a message (82x82)
	ThumbnailUri string `json:"thumbnailUri,omitempty"`
	// Information on navigation
	Fields   []GlipMessageAttachmentFieldsInfo `json:"fields,omitempty"`
	Footnote GlipMessageAttachmentFootnoteInfo `json:"footnote,omitempty"`
}

type GlipNavigationInfo ¶ 

type GlipNavigationInfo struct {
	// Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens
	PrevPageToken string `json:"prevPageToken,omitempty"`
	// Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens
	NextPageToken string `json:"nextPageToken,omitempty"`
}

type GlipPersonInfo ¶ 

type GlipPersonInfo struct {
	// Internal identifier of a user
	Id string `json:"id"`
	// First name of a user
	FirstName string `json:"firstName,omitempty"`
	// Last name of a user
	LastName string `json:"lastName,omitempty"`
	// Email of a user
	Email string `json:"email,omitempty"`
	// Job title of a user
	JobTitle string `json:"jobTitle,omitempty"`
	// Location of a user
	Location string `json:"location,omitempty"`
	// Photo of a user
	Avatar string `json:"avatar,omitempty"`
	// Internal identifier of a company
	CompanyId string `json:"companyId,omitempty"`
	// Time of creation in ISO 8601 format
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Time of last modification in ISO 8601 format
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
}

type GlipPostEvent ¶ 

type GlipPostEvent struct {
	// Internal identifier of a post
	Id string `json:"id,omitempty"`
	// Type of a post event
	EventType string `json:"eventType,omitempty"`
	// Internal identifier of a group a post belongs to
	GroupId string `json:"groupId,omitempty"`
	// Type of a post. 'TextMessage' - an incoming text message; 'PersonJoined' - a message notifying that person has joined a conversation; 'PersonsAdded' - a message notifying that a person(s) were added to a conversation
	Type string `json:"type,omitempty"`
	// For 'TextMessage' post type only. Message text
	Text string `json:"text,omitempty"`
	// Internal identifier of a user - author of a post
	CreatorId string `json:"creatorId,omitempty"`
	// For PersonsAdded post type only. Identifiers of persons added to a group
	AddedPersonIds []string `json:"addedPersonIds,omitempty"`
	// For PersonsRemoved post type only. Identifiers of persons removed from a group
	RemovedPersonIds []string `json:"removedPersonIds,omitempty"`
	// List of at mentions in post text with names.
	Mentions []GlipMentionsInfo `json:"mentions,omitempty"`
	// Post creation datetime in ISO 8601 format
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Post last change datetime in ISO 8601 format
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
}

type GlipPostInfo ¶ 

type GlipPostInfo struct {
	// Internal identifier of a post
	Id string `json:"id,omitempty"`
	// Internal identifier of a group a post belongs to
	GroupId string `json:"groupId,omitempty"`
	// Type of a post
	Type string `json:"type,omitempty"`
	// For 'TextMessage' post type only. Message text
	Text string `json:"text,omitempty"`
	// Internal identifier of a user - author of a post
	CreatorId string `json:"creatorId,omitempty"`
	// For PersonsAdded post type only. Identifiers of persons added to a group
	AddedPersonIds []string `json:"addedPersonIds,omitempty"`
	// Post creation datetime in ISO 8601 format
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Post last modification datetime in ISO 8601 format
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
	// List of posted attachments
	Attachments []GlipMessageAttachmentInfo `json:"attachments,omitempty"`
	// List of posted attachments
	Mentions []GlipMentionsInfo `json:"mentions,omitempty"`
	// activity type
	Activity string `json:"activity,omitempty"`
	// Title of the message. Can be set for bot messages only
	Title string `json:"title,omitempty"`
	// URI to an image to use as the icon for this message.
	IconUri string `json:"iconUri,omitempty"`
	// Emoji to use as the icon for a message
	IconEmoji string `json:"iconEmoji,omitempty"`
}

type GlipPosts ¶ 

type GlipPosts struct {
	// List of posts
	Records    []GlipPostInfo     `json:"records"`
	Navigation GlipNavigationInfo `json:"navigation,omitempty"`
}

type GlipUnreadMessageCount ¶ 

type GlipUnreadMessageCount struct {
	// Total count of unread posts
	UnreadPostsCount int32 `json:"unreadPostsCount,omitempty"`
	// 'True' if message quantity exceeds the threshold (100 by default)
	TooManyUnreadPosts bool `json:"tooManyUnreadPosts,omitempty"`
}

type GlipUnreadMessageCountEvent ¶ 

type GlipUnreadMessageCountEvent struct {
	// Universally unique identifier of a notification
	Uuid   string       `json:"uuid,omitempty"`
	PnApns GlipApnsInfo `json:"pn_apns,omitempty"`
	PnGcm  GcmInfo      `json:"pn_gcm,omitempty"`
}

type GlipUnreadMessageCountInfo ¶ 

type GlipUnreadMessageCountInfo struct {
	// Count of glip unread messages
	Unread int32 `json:"unread,omitempty"`
}

type GrantInfo ¶ 

type GrantInfo struct {
	// Canonical URI of a grant
	Uri       string              `json:"uri,omitempty"`
	Extension ExtensionInfoGrants `json:"extension,omitempty"`
	// Specifies if picking up of other extensions' calls is allowed for the extension. If 'Presence' feature is disabled for the given extension, the flag is not returned
	CallPickup bool `json:"callPickup,omitempty"`
	// Specifies if monitoring of other extensions' calls is allowed for the extension. If 'CallMonitoring' feature is disabled for the given extension, the flag is not returned
	CallMonitoring bool `json:"callMonitoring,omitempty"`
}

type GreetingInfo ¶ 

type GreetingInfo struct {
	// Type of a greeting, specifying the case when the greeting is played. See Greeting Types = ['Introductory', 'Announcement', 'ConnectingMessage', 'ConnectingAudio', 'Voicemail', 'Unavailable', 'InterruptPrompt', 'HoldMusic']
	Type string `json:"type,omitempty"`
	// Usage type of a greeting, specifying if the greeting is applied to user extension or department extension = ['UserExtensionAnsweringRule', 'ExtensionAnsweringRule DepartmentExtensionAnsweringRule']
	UsageType string     `json:"usageType,omitempty"`
	Preset    PresetInfo `json:"preset,omitempty"`
}

type GreetingLanguageInfo ¶ 

type GreetingLanguageInfo struct {
	// Internal identifier of a greeting language
	Id string `json:"id,omitempty"`
	// Localization code of a greeting language
	LocaleCode string `json:"localeCode,omitempty"`
	// Official name of a greeting language
	Name string `json:"name,omitempty"`
}

type GroupContactsCollection ¶ 

type GroupContactsCollection struct {
	Uri        string                    `json:"uri,omitempty"`
	Records    []PersonalContactResource `json:"records,omitempty"`
	Paging     Paging                    `json:"paging,omitempty"`
	Navigation Navigation                `json:"navigation,omitempty"`
}

type GroupResource ¶ 

type GroupResource struct {
	Uri           string       `json:"uri,omitempty"`
	Contacts      ResourceLink `json:"contacts,omitempty"`
	Id            string       `json:"id,omitempty"`
	Notes         string       `json:"notes,omitempty"`
	GroupName     string       `json:"groupName,omitempty"`
	ContactsCount int32        `json:"contactsCount,omitempty"`
}

type GroupsCollection ¶ 

type GroupsCollection struct {
	Uri        string          `json:"uri,omitempty"`
	Records    []GroupResource `json:"records,omitempty"`
	Paging     Paging          `json:"paging,omitempty"`
	Navigation Navigation      `json:"navigation,omitempty"`
}

type HintResource ¶ 

type HintResource struct {
	ExpiresIn      int64  `json:"expiresIn,omitempty"`
	ActionRequired bool   `json:"actionRequired,omitempty"`
	MessageUri     string `json:"messageUri,omitempty"`
}

type HintsResource ¶ 

type HintsResource struct {
	UserCredentialState HintResource `json:"userCredentialState,omitempty"`
	TrialState          HintResource `json:"trialState,omitempty"`
	AppVersionUpgrade   HintResource `json:"appVersionUpgrade,omitempty"`
}

type HomeCountry ¶ 

type HomeCountry struct {
	Id          string `json:"id,omitempty"`
	Uri         string `json:"uri,omitempty"`
	Name        string `json:"name,omitempty"`
	IsoCode     string `json:"isoCode,omitempty"`
	CallingCode string `json:"callingCode,omitempty"`
}

type HomeCountryResource ¶ 

type HomeCountryResource struct {
	Uri         string `json:"uri,omitempty"`
	Id          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	IsoCode     string `json:"isoCode,omitempty"`
	CallingCode string `json:"callingCode,omitempty"`
}

type HostInfoRequest ¶ 

type HostInfoRequest struct {
	// Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier
	Id string `json:"id,omitempty"`
}

type InProductMessages ¶ 

type InProductMessages struct {
	// Link to the in-product messages resource
	Uri string `json:"uri,omitempty"`
	// The list of in-product messages
	Records    []BannerInfo   `json:"records,omitempty"`
	Navigation NavigationInfo `json:"navigation,omitempty"`
	Paging     PagingInfo     `json:"paging,omitempty"`
}

type InboundFaxesInfo ¶ 

type InboundFaxesInfo struct {
	// Email notification flag
	NotifyByEmail bool `json:"notifyByEmail,omitempty"`
	// SMS notification flag
	NotifyBySms bool `json:"notifyBySms,omitempty"`
	// List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedEmailAddresses []string `json:"advancedEmailAddresses,omitempty"`
	// List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedSmsEmailAddresses []string `json:"advancedSmsEmailAddresses,omitempty"`
	// Indicates whether fax should be attached to email
	IncludeAttachment bool `json:"includeAttachment,omitempty"`
	// Indicates whether email should be automatically marked as read
	MarkAsRead bool `json:"markAsRead,omitempty"`
}

type InboundMessageEvent ¶ 

type InboundMessageEvent struct {
	Aps NotificationInfo `json:"aps,omitempty"`
	// Internal identifier of an message
	MessageId string `json:"messageId,omitempty"`
	// Internal identifier of an conversation
	ConversationId string `json:"conversationId,omitempty"`
	// Sender phone number
	From string `json:"from,omitempty"`
	// Receiver phone number
	To string `json:"to,omitempty"`
}

type InboundTextsInfo ¶ 

type InboundTextsInfo struct {
	// Email notification flag
	NotifyByEmail bool `json:"notifyByEmail,omitempty"`
	// SMS notification flag
	NotifyBySms bool `json:"notifyBySms,omitempty"`
	// List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedEmailAddresses []string `json:"advancedEmailAddresses,omitempty"`
	// List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedSmsEmailAddresses []string `json:"advancedSmsEmailAddresses,omitempty"`
}

type IncomingCallEvent ¶ 

type IncomingCallEvent struct {
	Aps ApsInfo `json:"aps,omitempty"`
	// Event filter URI
	Event string `json:"event,omitempty"`
	// Universally unique identifier of a notification
	Uuid string `json:"uuid,omitempty"`
	// Internal identifier of a subscription
	SubscriptionId string `json:"subscriptionId,omitempty"`
	// The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	Timestamp time.Time `json:"timestamp,omitempty"`
	// Internal identifier of an extension
	ExtensionId string `json:"extensionId,omitempty"`
	// Calling action, for example 'StartRing'
	Action string `json:"action,omitempty"`
	// Identifier of a call session
	SessionId string `json:"sessionId,omitempty"`
	// Identifier of a server
	ServerId string `json:"serverId,omitempty"`
	// Phone number of a caller
	From string `json:"from,omitempty"`
	// Caller name
	FromName string `json:"fromName,omitempty"`
	// Phone number of a callee
	To string `json:"to,omitempty"`
	// Callee name
	ToName string `json:"toName,omitempty"`
	// Unique identifier of a session
	Sid string `json:"sid,omitempty"`
	// SIP proxy registration name
	ToUrl string `json:"toUrl,omitempty"`
	// User data
	SrvLvl string `json:"srvLvl,omitempty"`
	// User data
	SrvLvlExt string `json:"srvLvlExt,omitempty"`
	// File containing recorded caller name
	RecUrl string `json:"recUrl,omitempty"`
	// Notification lifetime value in seconds, the default value is 30 seconds
	PnTtl int32 `json:"pn_ttl,omitempty"`
}

type IncomingCallInformationResource ¶ 

type IncomingCallInformationResource struct {
	Uri                             string `json:"uri,omitempty"`
	AnnouncementWhenDirectCalls     string `json:"announcementWhenDirectCalls,omitempty"`
	AnnouncementWhenDepartmentCalls string `json:"announcementWhenDepartmentCalls,omitempty"`
}

type InlinedExtensionResource ¶ 

type InlinedExtensionResource struct {
	Uri             string `json:"uri,omitempty"`
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	Id              string `json:"id,omitempty"`
	Type            string `json:"type,omitempty"`
}

type InstantMessageEvent ¶ 

type InstantMessageEvent struct {
	// Internal identifier of an message
	Id string `json:"id,omitempty"`
	// Message receiver(s) information
	To   []NotificationRecipientInfo `json:"to,omitempty"`
	From SenderInfo                  `json:"from,omitempty"`
	// Type of a message. The default value is 'SMS'
	Type string `json:"type,omitempty"`
	// Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Datetime when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
	// Status of a message. The default value is 'Unread'
	ReadStatus string `json:"readStatus,omitempty"`
	// The default value is 'Normal'
	Priority string `json:"priority,omitempty"`
	// Message attachment data
	Attachments []MessageAttachmentInfo `json:"attachments,omitempty"`
	// Message direction. The default value is 'Inbound'
	Direction string `json:"direction,omitempty"`
	// Message availability status. The default value is 'Alive'
	Availability string `json:"availability,omitempty"`
	// Message subject. It replicates message text which is also returned as an attachment
	Subject string `json:"subject,omitempty"`
	// Status of a message. The default value is 'Received'
	MessageStatus string `json:"messageStatus,omitempty"`
	// Identifier of the conversation the message belongs to
	ConversationId string `json:"conversationId,omitempty"`
}

type InternalMessageResource ¶ 

type InternalMessageResource struct {
	To      []CallerInfo `json:"to,omitempty"`
	From    CallerInfo   `json:"from,omitempty"`
	Text    string       `json:"text,omitempty"`
	ReplyOn int64        `json:"replyOn,omitempty"`
}

type IntervalResource ¶ 

type IntervalResource struct {
	From string `json:"from,omitempty"`
	To   string `json:"to,omitempty"`
}

type InvoiceSettingsResource ¶ 

type InvoiceSettingsResource struct {
	MaxAmountPerFirstMonth int64   `json:"maxAmountPerFirstMonth,omitempty"`
	MaxAmountPerMonth      int64   `json:"maxAmountPerMonth,omitempty"`
	PaymentTerm            int64   `json:"paymentTerm,omitempty"`
	Period                 int64   `json:"period,omitempty"`
	Address                Address `json:"address,omitempty"`
}

type IvrMenuActionsInfo ¶ 

type IvrMenuActionsInfo struct {
	// Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput
	Input string `json:"input,omitempty"`
	// Internal identifier of an answering rule
	Action    string               `json:"action,omitempty"`
	Extension IvrMenuExtensionInfo `json:"extension,omitempty"`
	// For 'Transfer' action only. PSTN number in E.164 format
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type IvrMenuExtensionInfo ¶ 

type IvrMenuExtensionInfo struct {
	// Link to an extension resource
	Uri string `json:"uri,omitempty"`
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
}

type IvrMenuInfo ¶ 

type IvrMenuInfo struct {
	// Internal identifier of an IVR Menu extension
	Id string `json:"id,omitempty"`
	// Link to an IVR Menu extension resource
	Uri string `json:"uri,omitempty"`
	// First name of an IVR Menu user
	Name string `json:"name,omitempty"`
	// Number of an IVR Menu extension
	ExtensionNumber string            `json:"extensionNumber,omitempty"`
	Prompt          IvrMenuPromptInfo `json:"prompt,omitempty"`
	// Keys handling settings
	Actions []IvrMenuActionsInfo `json:"actions,omitempty"`
}

type IvrMenuPromptInfo ¶ 

type IvrMenuPromptInfo struct {
	// Prompt mode: custom media or text = ['Audio', 'TextToSpeech']
	Mode  string             `json:"mode,omitempty"`
	Audio PromptLanguageInfo `json:"audio,omitempty"`
	// For 'TextToSpeech' mode only. Prompt text
	Text     string          `json:"text,omitempty"`
	Language AudioPromptInfo `json:"language,omitempty"`
}

type IvrPrompts ¶ 

type IvrPrompts struct {
	// Link to prompts library resource
	Uri string `json:"uri,omitempty"`
	// List of Prompts
	Records    []PromptInfo   `json:"records,omitempty"`
	Navigation NavigationInfo `json:"navigation,omitempty"`
	Paging     PagingInfo     `json:"paging,omitempty"`
}

type LanguageInfo ¶ 

type LanguageInfo struct {
	// Internal identifier of a language
	Id string `json:"id,omitempty"`
	// Canonical URI of a language
	Uri string `json:"uri,omitempty"`
	// Indicates whether a language is available as greeting language
	Greeting bool `json:"greeting,omitempty"`
	// Indicates whether a language is available as formatting locale
	FormattingLocale bool `json:"formattingLocale,omitempty"`
	// Localization code of a language
	LocaleCode string `json:"localeCode,omitempty"`
	// Official name of a language
	Name string `json:"name,omitempty"`
	// Indicates whether a language is available as UI language
	Ui bool `json:"ui,omitempty"`
}

type LanguageInfoResource ¶ 

type LanguageInfoResource struct {
	Uri              string `json:"uri,omitempty"`
	Id               string `json:"id,omitempty"`
	Name             string `json:"name,omitempty"`
	IsoCode          string `json:"isoCode,omitempty"`
	LocaleCode       string `json:"localeCode,omitempty"`
	Ui               bool   `json:"ui,omitempty"`
	Greeting         bool   `json:"greeting,omitempty"`
	FormattingLocale bool   `json:"formattingLocale,omitempty"`
}

type LanguageInfoResources ¶ 

type LanguageInfoResources struct {
	Uri        string                 `json:"uri,omitempty"`
	Records    []LanguageInfoResource `json:"records,omitempty"`
	Paging     Paging                 `json:"paging,omitempty"`
	Navigation Navigation             `json:"navigation,omitempty"`
}

type LanguageList ¶ 

type LanguageList struct {
	// Canonical URI of the language list resource
	Uri string `json:"uri,omitempty"`
	// Language data
	Records    []LanguageInfo `json:"records,omitempty"`
	Navigation NavigationInfo `json:"navigation,omitempty"`
	Paging     PagingInfo     `json:"paging,omitempty"`
}

type LanguageResource ¶ 

type LanguageResource struct {
	Id         string `json:"id,omitempty"`
	Name       string `json:"name,omitempty"`
	LocaleCode string `json:"localeCode,omitempty"`
}

type LicenseExtensionInfo ¶ 

type LicenseExtensionInfo struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
	// Canonical URI of an extension
	Uri string `json:"uri,omitempty"`
	// Number of an extension
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// User name of an extension
	Name string `json:"name,omitempty"`
}

type LicenseFeatureInfo ¶ 

type LicenseFeatureInfo struct {
	// Internal identifier of an feature
	Id string `json:"id,omitempty"`
	// Full name of a feature
	Name string `json:"name,omitempty"`
	// Maximum count of licenses of specific type per account
	Limit int32 `json:"limit,omitempty"`
}

type LicenseInfo ¶ 

type LicenseInfo struct {
	// Canonical URI of a license
	Uri string `json:"uri,omitempty"`
	// Internal identifier of a license
	Id   string             `json:"id,omitempty"`
	Type LicenseFeatureInfo `json:"type,omitempty"`
	// Datetime when license was purchased in ISO 8601 format including timezone, for example 2017-03-10T18:07:52.534Z
	CreationTime string               `json:"creationTime,omitempty"`
	Extension    LicenseExtensionInfo `json:"extension,omitempty"`
}

type LicenseInfoRequest ¶ 

type LicenseInfoRequest struct {
	Type LicenseTypeInfoRequest `json:"type,omitempty"`
	// Quantity of licenses to be purchased
	Quantity int32 `json:"quantity,omitempty"`
}

type LicenseList ¶ 

type LicenseList struct {
	// List of licenses
	Records    []LicenseInfo  `json:"records,omitempty"`
	Paging     PagingInfo     `json:"paging,omitempty"`
	Navigation NavigationInfo `json:"navigation,omitempty"`
}

type LicenseTypeInfo ¶ 

type LicenseTypeInfo struct {
	// Internal identifier of a type
	Id string `json:"id,omitempty"`
	// Canonical URI of a license type resource
	Uri string `json:"uri,omitempty"`
	// Short name of a license type
	Sku string `json:"sku,omitempty"`
	// Full name of a license type
	Name string `json:"name,omitempty"`
	// State of a license. Webinars and Large Meetings are assignable
	Assignable string             `json:"assignable,omitempty"`
	Feature    LicenseFeatureInfo `json:"feature,omitempty"`
}

type LicenseTypeInfoRequest ¶ 

type LicenseTypeInfoRequest struct {
	// Name of a license type = ['RMS', 'RCN', 'WBR-100', 'WBR-500', 'WBR-1000', 'WBR-3000', 'LRM-50', 'LRM-100', 'LRM-200']
	Sku string `json:"sku,omitempty"`
}

type LicenseTypes ¶ 

type LicenseTypes struct {
	// Canonical URI of a license types resource
	Uri string `json:"uri,omitempty"`
	// List of supported licenses
	Records    []LicenseInfo  `json:"records,omitempty"`
	Paging     PagingInfo     `json:"paging,omitempty"`
	Navigation NavigationInfo `json:"navigation,omitempty"`
}

type LineInfo ¶ 

type LineInfo struct {
	// Internal identifier of a monitored extension
	Id string `json:"id,omitempty"`
	// Canonical URI of a monitored extension
	Uri       string                      `json:"uri,omitempty"`
	Extension ExtensionInfoMonitoredLines `json:"extension,omitempty"`
}

type ListAccountPhoneNumbersOpts ¶ 

type ListAccountPhoneNumbersOpts struct {
	Page      optional.Int32
	PerPage   optional.Int32
	UsageType optional.Interface
}

type ListCompanyActiveCallsOpts ¶ 

type ListCompanyActiveCallsOpts struct {
	Direction optional.Interface
	Type_     optional.Interface
	Transport optional.Interface
	Page      optional.Int32
	PerPage   optional.Int32
}

type ListCompanyAnsweringRuleInfo ¶ 

type ListCompanyAnsweringRuleInfo struct {
	// Internal identifier of an answering rule
	Id string `json:"id,omitempty"`
	// Canonical URI of an answering rule
	Uri string `json:"uri,omitempty"`
	// Specifies if the rule is active or inactive. The default value is 'True'
	Enabled bool `json:"enabled,omitempty"`
	// Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']
	Type string `json:"type,omitempty"`
	// Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number
	Name string `json:"name,omitempty"`
}

type ListCompanyDirectoryContactsOpts ¶ 

type ListCompanyDirectoryContactsOpts struct {
	Page                     optional.Int64
	PerPage                  optional.Int64
	ExcludeFederatedContacts optional.Bool
}

type ListContactsOpts ¶ 

type ListContactsOpts struct {
	StartsWith  optional.String
	SortBy      optional.Interface
	Page        optional.Int32
	PerPage     optional.Int32
	PhoneNumber optional.Interface
}

type ListCountriesOpts ¶ 

type ListCountriesOpts struct {
	LoginAllowed      optional.Bool
	SignupAllowed     optional.Bool
	NumberSelling     optional.Bool
	Page              optional.Int32
	PerPage           optional.Int32
	FreeSoftphoneLine optional.Bool
}

type ListDepartmentMembersOpts ¶ 

type ListDepartmentMembersOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type ListDialingPlansOpts ¶ 

type ListDialingPlansOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type ListExtensionActiveCallsOpts ¶ 

type ListExtensionActiveCallsOpts struct {
	Direction optional.Interface
	Type_     optional.Interface
	Page      optional.Int32
	PerPage   optional.Int32
}

type ListExtensionDevicesOpts ¶ 

type ListExtensionDevicesOpts struct {
	LinePooling optional.String
}

type ListExtensionForwardingNumbersOpts ¶ 

type ListExtensionForwardingNumbersOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type ListExtensionGrantsOpts ¶ 

type ListExtensionGrantsOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type ListExtensionPhoneNumbersOpts ¶ 

type ListExtensionPhoneNumbersOpts struct {
	UsageType optional.Interface
	Page      optional.Int32
	PerPage   optional.Int32
}

type ListExtensionsOpts ¶ 

type ListExtensionsOpts struct {
	Page    optional.Int64
	PerPage optional.Int64
	Status  optional.Interface
	Type_   optional.Interface
}

type ListLicensesOpts ¶ 

type ListLicensesOpts struct {
	Page    optional.Int64
	PerPage optional.Int64
	TypeId  optional.Int64
}

type ListLocationsOpts ¶ 

type ListLocationsOpts struct {
	OrderBy optional.Interface
	Page    optional.Int32
	PerPage optional.Int32
	StateId optional.String
	WithNxx optional.Bool
}

type ListMessagesOpts ¶ 

type ListMessagesOpts struct {
	Availability          optional.Interface
	ConversationId        optional.Int32
	DateFrom              optional.Time
	DateTo                optional.Time
	Direction             optional.Interface
	DistinctConversations optional.Bool
	MessageType           optional.Interface
	ReadStatus            optional.Interface
	Page                  optional.Int32
	PerPage               optional.Int32
	PhoneNumber           optional.String
}

type ListPermissionCategoriesOpts ¶ 

type ListPermissionCategoriesOpts struct {
	Page          optional.String
	PerPage       optional.String
	ServicePlanId optional.String
}

type ListPermissionsOpts ¶ 

type ListPermissionsOpts struct {
	Page          optional.String
	PerPage       optional.String
	Assignable    optional.Bool
	ServicePlanId optional.String
}

type ListSecretQuestionsOpts ¶ 

type ListSecretQuestionsOpts struct {
	SignupOnly optional.Bool
	Page       optional.String
	PerPage    optional.String
}

type ListShippingOptionsOpts ¶ 

type ListShippingOptionsOpts struct {
	ServicePlanId optional.Int32
	BrandId       optional.Int32
	Quantity      optional.Int32
}

type ListSystemRolesOpts ¶ 

type ListSystemRolesOpts struct {
	Page          optional.String
	PerPage       optional.String
	ServicePlanId optional.String
}

type ListTimezonesOpts ¶ 

type ListTimezonesOpts struct {
	Page    optional.String
	PerPage optional.String
}

type ListUsersOpts ¶ 

type ListUsersOpts struct {
	Filter     optional.String
	Count      optional.Int32
	StartIndex optional.Int32
}

type LoadAccountCallLogOpts ¶ 

type LoadAccountCallLogOpts struct {
	ExtensionNumber optional.String
	PhoneNumber     optional.String
	Direction       optional.Interface
	Type_           optional.Interface
	View            optional.Interface
	WithRecording   optional.Bool
	DateFrom        optional.Time
	DateTo          optional.Time
	Page            optional.Int32
	PerPage         optional.Int32
	SessionId       optional.String
}

type LoadAnsweringRulesListOpts ¶ 

type LoadAnsweringRulesListOpts struct {
	Page    optional.String
	PerPage optional.String
}

type LoadConferencingInfoOpts ¶ 

type LoadConferencingInfoOpts struct {
	CountryId optional.String
}

type LoadExtensionCallLogOpts ¶ 

type LoadExtensionCallLogOpts struct {
	ExtensionNumber optional.String
	ShowBlocked     optional.Bool
	PhoneNumber     optional.String
	Direction       optional.Interface
	SessionId       optional.String
	Type_           optional.Interface
	Transport       optional.Interface
	View            optional.Interface
	WithRecording   optional.Bool
	DateTo          optional.Time
	DateFrom        optional.Time
	Page            optional.Int32
	PerPage         optional.Int32
}

type LoadGroupListOpts ¶ 

type LoadGroupListOpts struct {
	Type_       optional.Interface
	PageToken   optional.String
	RecordCount optional.Int64
}

type LoadMessageAttachmentOpts ¶ 

type LoadMessageAttachmentOpts struct {
	Range_ optional.String
}

type LoadPostsOpts ¶ 

type LoadPostsOpts struct {
	PageToken   optional.String
	RecordCount optional.Int64
}

type LoadTimezoneOpts ¶ 

type LoadTimezoneOpts struct {
	Page    optional.Int32
	PerPage optional.Int32
}

type LoadUnreadMessageCountOpts ¶ 

type LoadUnreadMessageCountOpts struct {
	Fields optional.String
}

type LoadlistStatesOpts ¶ 

type LoadlistStatesOpts struct {
	CountryId        optional.Int32
	Page             optional.Int32
	PerPage          optional.Int32
	WithPhoneNumbers optional.Bool
}

type Locale ¶ 

type Locale struct {
	Language                string   `json:"language,omitempty"`
	Country                 string   `json:"country,omitempty"`
	DisplayCountry          string   `json:"displayCountry,omitempty"`
	DisplayLanguage         string   `json:"displayLanguage,omitempty"`
	DisplayName             string   `json:"displayName,omitempty"`
	DisplayScript           string   `json:"displayScript,omitempty"`
	DisplayVariant          string   `json:"displayVariant,omitempty"`
	ExtensionKeys           []string `json:"extensionKeys,omitempty"`
	Iso3Country             string   `json:"iso3Country,omitempty"`
	Iso3Language            string   `json:"iso3Language,omitempty"`
	Script                  string   `json:"script,omitempty"`
	UnicodeLocaleAttributes []string `json:"unicodeLocaleAttributes,omitempty"`
	UnicodeLocaleKeys       []string `json:"unicodeLocaleKeys,omitempty"`
	Variant                 string   `json:"variant,omitempty"`
}

type LocationInfo ¶ 

type LocationInfo struct {
	// Canonical URI of a location
	Uri string `json:"uri,omitempty"`
	// Area code of the location
	AreaCode string `json:"areaCode,omitempty"`
	// Official name of the city, belonging to the certain state
	City string `json:"city,omitempty"`
	// Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan
	Npa string `json:"npa,omitempty"`
	// Central office code of the location, according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan
	Nxx string `json:"nxx,omitempty"`
	// ID and URI of the state this location belongs to, see State Info
	State string `json:"state,omitempty"`
}

type LocationResource ¶ 

type LocationResource struct {
	Uri      string            `json:"uri,omitempty"`
	City     string            `json:"city,omitempty"`
	AreaCode string            `json:"areaCode,omitempty"`
	Npa      string            `json:"npa,omitempty"`
	Nxx      string            `json:"nxx,omitempty"`
	State    VersionedResource `json:"state,omitempty"`
}

type LocationsResource ¶ 

type LocationsResource struct {
	Uri        string             `json:"uri,omitempty"`
	Records    []LocationResource `json:"records,omitempty"`
	Paging     Paging             `json:"paging,omitempty"`
	Navigation Navigation         `json:"navigation,omitempty"`
}

type LookupPhoneNumberInfo ¶ 

type LookupPhoneNumberInfo struct {
	// Phone number in E.164 format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Phone number formatted according to current brand's default country
	FormattedNumber string `json:"formattedNumber,omitempty"`
	// Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern
	VanityPattern string `json:"vanityPattern,omitempty"`
	// The value is returned if the extendedSearch parameter is true. The values are 10, 9, 8, etc.; '10' is the closest match
	Rank int32 `json:"rank,omitempty"`
}

type LookupPhoneNumbersOpts ¶ 

type LookupPhoneNumbersOpts struct {
	AreaCode       optional.Int32
	CountryCode    optional.String
	CountryId      optional.String
	Exclude        optional.String
	ExtendedSearch optional.Bool
	Line           optional.String
	NumberPattern  optional.String
	Nxx            optional.String
	Npa            optional.String
	PaymentType    optional.Interface
	PerPage        optional.Int32
	ProviderId     optional.Int32
	SmsEnabled     optional.Bool
}

type MakeRingOutCallerInfoRequestFrom ¶ 

type MakeRingOutCallerInfoRequestFrom struct {
	// Phone number in E.164 format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Internal identifier of a forwarding number; returned in response in the id field. Can be specified instead of the phoneNumber attribute
	ForwardingNumberId string `json:"forwardingNumberId,omitempty"`
}

type MakeRingOutCallerInfoRequestTo ¶ 

type MakeRingOutCallerInfoRequestTo struct {
	// Phone number in E.164 format
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type MakeRingOutCountryInfo ¶ 

type MakeRingOutCountryInfo struct {
	// Dialing plan country identifier
	Id string `json:"id,omitempty"`
}

type MakeRingOutRequest ¶ 

type MakeRingOutRequest struct {
	From     MakeRingOutCallerInfoRequestFrom `json:"from"`
	To       MakeRingOutCallerInfoRequestTo   `json:"to"`
	CallerId MakeRingOutCallerInfoRequestTo   `json:"callerId,omitempty"`
	// The audio prompt that the calling party hears when the call is connected
	PlayPrompt bool                   `json:"playPrompt,omitempty"`
	Country    MakeRingOutCountryInfo `json:"country,omitempty"`
}

type MatchingEntityTag ¶ 

type MatchingEntityTag struct {
	Value string `json:"value,omitempty"`
	Weak  bool   `json:"weak,omitempty"`
}

type MediaType ¶ 

type MediaType struct {
	Type            string `json:"type,omitempty"`
	Subtype         string `json:"subtype,omitempty"`
	WildcardType    bool   `json:"wildcardType,omitempty"`
	WildcardSubtype bool   `json:"wildcardSubtype,omitempty"`
}

type MeetingExternalUserInfoResource ¶ 

type MeetingExternalUserInfoResource struct {
	Uri       string `json:"uri,omitempty"`
	UserId    string `json:"userId,omitempty"`
	AccountId string `json:"accountId,omitempty"`
	UserType  int64  `json:"userType,omitempty"`
	UserToken string `json:"userToken,omitempty"`
}
type MeetingLinks struct {
	StartUri string `json:"startUri,omitempty"`
	JoinUri  string `json:"joinUri,omitempty"`
}

type MeetingRequestResource ¶ 

type MeetingRequestResource struct {
	Topic                  string                  `json:"topic,omitempty"`
	MeetingType            string                  `json:"meetingType,omitempty"`
	Schedule               MeetingScheduleResource `json:"schedule,omitempty"`
	Password               string                  `json:"password,omitempty"`
	Host                   HostInfoRequest         `json:"host,omitempty"`
	AllowJoinBeforeHost    bool                    `json:"allowJoinBeforeHost,omitempty"`
	StartHostVideo         bool                    `json:"startHostVideo,omitempty"`
	StartParticipantsVideo bool                    `json:"startParticipantsVideo,omitempty"`
	AudioOptions           []string                `json:"audioOptions,omitempty"`
}

type MeetingResponseResource ¶ 

type MeetingResponseResource struct {
	Uri                    string                  `json:"uri,omitempty"`
	Uuid                   string                  `json:"uuid,omitempty"`
	Id                     string                  `json:"id,omitempty"`
	Topic                  string                  `json:"topic,omitempty"`
	MeetingType            string                  `json:"meetingType,omitempty"`
	Password               string                  `json:"password,omitempty"`
	Status                 string                  `json:"status,omitempty"`
	Links                  MeetingLinks            `json:"links,omitempty"`
	Schedule               MeetingScheduleResource `json:"schedule,omitempty"`
	AllowJoinBeforeHost    bool                    `json:"allowJoinBeforeHost,omitempty"`
	StartHostVideo         bool                    `json:"startHostVideo,omitempty"`
	StartParticipantsVideo bool                    `json:"startParticipantsVideo,omitempty"`
	AudioOptions           []string                `json:"audioOptions,omitempty"`
}

type MeetingScheduleResource ¶ 

type MeetingScheduleResource struct {
	StartTime         string           `json:"startTime,omitempty"`
	DurationInMinutes int32            `json:"durationInMinutes,omitempty"`
	TimeZone          TimezoneResource `json:"timeZone,omitempty"`
}

type MeetingServiceInfoResource ¶ 

type MeetingServiceInfoResource struct {
	Uri                  string                          `json:"uri,omitempty"`
	SupportUri           string                          `json:"supportUri,omitempty"`
	IntlDialInNumbersUri string                          `json:"intlDialInNumbersUri,omitempty"`
	ExternalUserInfo     MeetingExternalUserInfoResource `json:"externalUserInfo,omitempty"`
	DialInNumbers        []DialInNumberResource          `json:"dialInNumbers,omitempty"`
}

type MeetingsApiService ¶ 

type MeetingsApiService service

func (*MeetingsApiService) CreateMeeting ¶ 

func (a *MeetingsApiService) CreateMeeting(ctx context.Context, accountId string, extensionId string, meetingRequestResource MeetingRequestResource) (MeetingResponseResource, *http.Response, error)

MeetingsApiService Create Meetings

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param extensionId
  • @param meetingRequestResource

@return MeetingResponseResource

func (*MeetingsApiService) DeleteMeeting ¶ 

func (a *MeetingsApiService) DeleteMeeting(ctx context.Context, meetingId string, extensionId string, accountId string) (*http.Response, error)

MeetingsApiService Delete Meeting

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param meetingId
  • @param extensionId
  • @param accountId

func (*MeetingsApiService) EndMeeting ¶ 

func (a *MeetingsApiService) EndMeeting(ctx context.Context, meetingId string, extensionId string, accountId string) (*http.Response, error)

MeetingsApiService End Meeting

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param meetingId
  • @param extensionId
  • @param accountId

func (*MeetingsApiService) GetLiveMeetings ¶ 

func (a *MeetingsApiService) GetLiveMeetings(ctx context.Context, accountId string, extensionId string) (MeetingsResource, *http.Response, error)

MeetingsApiService Get Scheduled Meetings

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param extensionId

@return MeetingsResource

func (*MeetingsApiService) GetMeetingDetails ¶ 

func (a *MeetingsApiService) GetMeetingDetails(ctx context.Context, accountId string, extensionId string, meetingId string) (MeetingResponseResource, *http.Response, error)

MeetingsApiService Get Meeting Info

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param extensionId
  • @param meetingId

@return MeetingResponseResource

func (*MeetingsApiService) GetMeetingServiceInfo ¶ 

func (a *MeetingsApiService) GetMeetingServiceInfo(ctx context.Context, extensionId string, accountId string) (MeetingServiceInfoResource, *http.Response, error)

MeetingsApiService Get Meeting Service Info

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param extensionId
  • @param accountId

@return MeetingServiceInfoResource

func (*MeetingsApiService) UpdateMeeting ¶ 

func (a *MeetingsApiService) UpdateMeeting(ctx context.Context, accountId string, extensionId string, meetingId string, meetingRequestResource MeetingRequestResource) (MeetingResponseResource, *http.Response, error)

MeetingsApiService Update Meeting

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param extensionId
  • @param meetingId
  • @param meetingRequestResource

@return MeetingResponseResource

type MeetingsResource ¶ 

type MeetingsResource struct {
	Uri        string                    `json:"uri,omitempty"`
	Records    []MeetingResponseResource `json:"records,omitempty"`
	Paging     Paging                    `json:"paging,omitempty"`
	Navigation Navigation                `json:"navigation,omitempty"`
}

type MessageAttachmentInfo ¶ 

type MessageAttachmentInfo struct {
	// Internal identifier of a message attachment
	Id string `json:"id,omitempty"`
	// Canonical URI of a message attachment
	Uri string `json:"uri,omitempty"`
	// Type of message attachment
	Type string `json:"type,omitempty"`
	// MIME type for a given attachment, for instance 'audio/wav'
	ContentType string `json:"contentType,omitempty"`
	// Voicemail only Duration of the voicemail in seconds
	VmDuration int32 `json:"vmDuration,omitempty"`
	// Name of a file attached
	Filename string `json:"filename,omitempty"`
	// Size of attachment in bytes
	Size int32 `json:"size,omitempty"`
}

type MessageAttachmentInfoIntId ¶ 

type MessageAttachmentInfoIntId struct {
	// Internal identifier of a message attachment
	Id int64 `json:"id,omitempty"`
	// Canonical URI of a message attachment
	Uri string `json:"uri,omitempty"`
	// Type of message attachment
	Type string `json:"type,omitempty"`
	// MIME type for a given attachment, for instance 'audio/wav'
	ContentType string `json:"contentType,omitempty"`
	// Voicemail only Duration of the voicemail in seconds
	VmDuration int32 `json:"vmDuration,omitempty"`
	// Name of a file attached
	Filename string `json:"filename,omitempty"`
	// Size of attachment in bytes
	Size int32 `json:"size,omitempty"`
}

type MessageChanges ¶ 

type MessageChanges struct {
	// Message type
	Type string `json:"type,omitempty"`
	// The number of new messages. Can be omitted if the value is zero
	NewCount int32 `json:"newCount,omitempty"`
	// The number of updated messages. Can be omitted if the value is zero
	UpdatedCount int32 `json:"updatedCount,omitempty"`
}

type MessageEvent ¶ 

type MessageEvent struct {
	// Internal identifier of an extension
	ExtensionId string `json:"extensionId,omitempty"`
	// Datetime when the message was last modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	LastUpdated time.Time `json:"lastUpdated,omitempty"`
	// Message Changes
	Changes []MessageChanges `json:"changes,omitempty"`
}

type MessageInfoResource ¶ 

type MessageInfoResource struct {
	Uri                     string                  `json:"uri,omitempty"`
	Id                      string                  `json:"id,omitempty"`
	To                      []CallerInfo            `json:"to,omitempty"`
	From                    CallerInfo              `json:"from,omitempty"`
	Type                    string                  `json:"type,omitempty"`
	CreationTime            time.Time               `json:"creationTime,omitempty"`
	ReadStatus              string                  `json:"readStatus,omitempty"`
	Priority                string                  `json:"priority,omitempty"`
	Attachments             []MessageAttachmentInfo `json:"attachments,omitempty"`
	Direction               string                  `json:"direction,omitempty"`
	Availability            string                  `json:"availability,omitempty"`
	Subject                 string                  `json:"subject,omitempty"`
	MessageStatus           string                  `json:"messageStatus,omitempty"`
	FaxResolution           string                  `json:"faxResolution,omitempty"`
	FaxPageCount            int32                   `json:"faxPageCount,omitempty"`
	DeliveryErrorCode       string                  `json:"deliveryErrorCode,omitempty"`
	SmsDeliveryTime         time.Time               `json:"smsDeliveryTime,omitempty"`
	SmsSendingAttemptsCount int64                   `json:"smsSendingAttemptsCount,omitempty"`
	ConversationId          int64                   `json:"conversationId,omitempty"`
	Conversation            ConversationResource    `json:"conversation,omitempty"`
	LastModifiedTime        time.Time               `json:"lastModifiedTime,omitempty"`
	PgToDepartment          bool                    `json:"pgToDepartment,omitempty"`
	VmTranscriptionStatus   string                  `json:"vmTranscriptionStatus,omitempty"`
	SourceFilePath          string                  `json:"sourceFilePath,omitempty"`
	CoverIndex              int32                   `json:"coverIndex,omitempty"`
	CoverPageText           string                  `json:"coverPageText,omitempty"`
}

type MessageStoreCallerInfoRequest ¶ 

type MessageStoreCallerInfoRequest struct {
	// Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)
	Location string `json:"location,omitempty"`
	// Symbolic name associated with a party. If the phone does not belong to the known extension,only the location is returned, the name is not determined then
	Name string `json:"name,omitempty"`
	// Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type MessageStoreCallerInfoResponse ¶ 

type MessageStoreCallerInfoResponse struct {
	// Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message
	ExtensionNumber string `json:"extensionNumber"`
	// Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)
	Location string `json:"location,omitempty"`
	// Status of a message. Returned for outbound fax messages only
	MessageStatus string `json:"messageStatus,omitempty"`
	// Fax only. Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'
	FaxErrorCode string `json:"faxErrorCode,omitempty"`
	// Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then
	Name string `json:"name,omitempty"`
	// Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type Messages ¶ 

type Messages struct {
	Uri        string                `json:"uri,omitempty"`
	Records    []MessageInfoResource `json:"records,omitempty"`
	Paging     Paging                `json:"paging,omitempty"`
	Navigation Navigation            `json:"navigation,omitempty"`
}

type MessagesApiService ¶ 

type MessagesApiService service

func (*MessagesApiService) DeleteMessage ¶ 

func (a *MessagesApiService) DeleteMessage(ctx context.Context, accountId string, extensionId string, messageId int32, localVarOptionals *DeleteMessageOpts) (*http.Response, error)

func (*MessagesApiService) DeleteMessagesByFilter ¶ 

func (a *MessagesApiService) DeleteMessagesByFilter(ctx context.Context, extensionId string, accountId string, localVarOptionals *DeleteMessagesByFilterOpts) (*http.Response, error)

func (*MessagesApiService) GetFaxCoverPages ¶ 

func (a *MessagesApiService) GetFaxCoverPages(ctx context.Context, localVarOptionals *GetFaxCoverPagesOpts) (*http.Response, error)

func (*MessagesApiService) ListMessages ¶ 

func (a *MessagesApiService) ListMessages(ctx context.Context, accountId string, extensionId string, localVarOptionals *ListMessagesOpts) (GetMessageList, *http.Response, error)

func (*MessagesApiService) LoadMessage ¶ 

func (a *MessagesApiService) LoadMessage(ctx context.Context, accountId string, extensionId string, messageId int32) (GetMessageInfoResponse, *http.Response, error)

MessagesApiService Get Message(s) by ID <p style='font-style:italic;'>Since 1.0.2</p><p>Returns individual message record(s) by the given message ID(s). The length of inbound messages is unlimited. Batch request is supported, see Batch Requests for details.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param messageId Internal identifier of a message

@return GetMessageInfoResponse

func (*MessagesApiService) LoadMessageAttachment ¶ 

func (a *MessagesApiService) LoadMessageAttachment(ctx context.Context, accountId string, extensionId string, attachmentId int32, messageId int32, localVarOptionals *LoadMessageAttachmentOpts) (*http.Response, error)

func (*MessagesApiService) SendFaxMessage ¶ 

func (a *MessagesApiService) SendFaxMessage(ctx context.Context, accountId string, extensionId string, to []string, localVarOptionals *SendFaxMessageOpts) (FaxResponse, *http.Response, error)

func (*MessagesApiService) SendInternalMessage ¶ 

func (a *MessagesApiService) SendInternalMessage(ctx context.Context, accountId string, extensionId string, createPagerMessageRequest CreatePagerMessageRequest) (GetMessageInfoResponse, *http.Response, error)

MessagesApiService Create Pager Message <p style='font-style:italic;'>Since 1.0.2</p><p>Creates and sends a pager message.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>InternalMessages</td><td>Sending and receiving intra-company text messages</td></tr><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param createPagerMessageRequest JSON body

@return GetMessageInfoResponse

func (*MessagesApiService) SendSMS ¶ 

func (a *MessagesApiService) SendSMS(ctx context.Context, accountId string, extensionId string, createSmsMessage CreateSmsMessage) (GetMessageInfoResponseIntId, *http.Response, error)

MessagesApiService Create SMS Message <p style='font-style:italic;'>Since 1.0.2</p><p>Creates and sends new SMS message. Sending SMS messages simultaneously to different recipients is limited up to 50 requests per minute; relevant for all client applications.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>SMS</td><td>Sending and receiving SMS (text) messages</td></tr><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param createSmsMessage JSON body

@return GetMessageInfoResponseIntId

func (*MessagesApiService) SyncMessages ¶ 

func (a *MessagesApiService) SyncMessages(ctx context.Context, accountId string, extensionId string, localVarOptionals *SyncMessagesOpts) (GetMessageSyncResponse, *http.Response, error)

func (*MessagesApiService) UpdateMessage ¶ 

func (a *MessagesApiService) UpdateMessage(ctx context.Context, accountId string, extensionId string, messageId int32, updateMessageRequest UpdateMessageRequest) (GetMessageInfoResponse, *http.Response, error)

MessagesApiService Update Message(s) by ID <p style='font-style:italic;'>Since 1.0.2</p><p>Updates message(s) by ID(s). Batch request is supported, see Batch Requests for details. Currently, only the message read status updating is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditMessages</td><td>Viewing and updating user messages</td></tr><tr><td class='code'>ReadMessages</td><td>Viewing user messages</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param messageId Internal identifier of a message
  • @param updateMessageRequest JSON body

@return GetMessageInfoResponse

type MetaInfo ¶ 

type MetaInfo struct {
	// User type
	ResourceType string `json:"resourceType,omitempty"`
	// Datetime of user creation in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
	Created time.Time `json:"created,omitempty"`
	// Datetime of the last change of user information in ISO 8601 format,for example 2016-03-10T18:07:52.534Z
	LastModified time.Time `json:"lastModified,omitempty"`
	// resource location URI
	Location string `json:"location,omitempty"`
}

type MethodInfo ¶ 

type MethodInfo struct {
	// Method identifier. The default value is  1  (Ground)
	Id string `json:"id,omitempty"`
	// Method name, corresponding to the identifier
	Name string `json:"name,omitempty"`
}

type MethodResource ¶ 

type MethodResource struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type MissedCallEvent ¶ 

type MissedCallEvent struct {
	// Universally unique identifier of a notification
	Uuid   string   `json:"uuid,omitempty"`
	PnApns ApnsInfo `json:"pn_apns,omitempty"`
	// Event filter URI
	Event string `json:"event,omitempty"`
	// Internal identifier of a subscription
	SubscriptionId string `json:"subscriptionId,omitempty"`
	// The datetime of a call action in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	Timestamp time.Time `json:"timestamp,omitempty"`
	// Internal identifier of an extension
	ExtensionId string `json:"extensionId,omitempty"`
	// Calling action, for example 'StartRing'
	Action string `json:"action,omitempty"`
	// Identifier of a call session
	SessionId string `json:"sessionId,omitempty"`
	// Identifier of a server
	ServerId string `json:"serverId,omitempty"`
	// Phone number of a caller
	From string `json:"from,omitempty"`
	// Caller name
	FromName string `json:"fromName,omitempty"`
	// Phone number of a callee
	To string `json:"to,omitempty"`
	// Callee name
	ToName string `json:"toName,omitempty"`
	// Unique identifier of a session
	Sid string `json:"sid,omitempty"`
	// SIP proxy registration name
	ToUrl string `json:"toUrl,omitempty"`
	// User data
	SrvLvl string `json:"srvLvl,omitempty"`
	// User data
	SrvLvlExt string `json:"srvLvlExt,omitempty"`
	// File containing recorded caller name
	RecUrl string `json:"recUrl,omitempty"`
	// Notification lifetime value in seconds, the default value is 30 seconds
	PnTtl int32 `json:"pn_ttl,omitempty"`
}

type MissedCallsInfo ¶ 

type MissedCallsInfo struct {
	// Email notification flag
	NotifyByEmail bool `json:"notifyByEmail,omitempty"`
	// SMS notification flag
	NotifyBySms bool `json:"notifyBySms,omitempty"`
	// List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedEmailAddresses []string `json:"advancedEmailAddresses,omitempty"`
	// List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedSmsEmailAddresses []string `json:"advancedSmsEmailAddresses,omitempty"`
}

type ModelInfo ¶ 

type ModelInfo struct {
	// Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier
	Id string `json:"id,omitempty"`
	// Device name
	Name string `json:"name,omitempty"`
	// Addons description
	Addons []AddonInfo `json:"addons"`
}

type ModifyAccountBusinessAddressRequest ¶ 

type ModifyAccountBusinessAddressRequest struct {
	// Company business name
	Company string `json:"company,omitempty"`
	// Company business email address
	Email           string              `json:"email,omitempty"`
	BusinessAddress BusinessAddressInfo `json:"businessAddress"`
}

type ModifySubscriptionRequest ¶ 

type ModifySubscriptionRequest struct {
	// Collection of URIs to API resources (see Event Types). Mandatory field
	EventFilters []string `json:"eventFilters,omitempty"`
}

type MonitoringExtensionResource ¶ 

type MonitoringExtensionResource struct {
	Uri             string `json:"uri,omitempty"`
	Id              string `json:"id,omitempty"`
	ExtensionNumber string `json:"extensionNumber,omitempty"`
}

type MonitoringExtensionsResource ¶ 

type MonitoringExtensionsResource struct {
	Uri        string                        `json:"uri,omitempty"`
	Records    []MonitoringExtensionResource `json:"records,omitempty"`
	Paging     Paging                        `json:"paging,omitempty"`
	Navigation Navigation                    `json:"navigation,omitempty"`
}

type NameInfo ¶ 

type NameInfo struct {
	// User first name
	GivenName string `json:"givenName,omitempty"`
	// User last name
	FamilyName string `json:"familyName,omitempty"`
}

type NameInfoRequest ¶ 

type NameInfoRequest struct {
	// User first name
	GivenName string `json:"givenName,omitempty"`
	// User last name
	FamilyName string `json:"familyName,omitempty"`
}
type NavigableCollectionResourceExtensionIdResource struct {
	Uri        string                `json:"uri,omitempty"`
	Records    []ExtensionIdResource `json:"records,omitempty"`
	Paging     Paging                `json:"paging,omitempty"`
	Navigation Navigation            `json:"navigation,omitempty"`
}
type NavigableCollectionResourceUserGroupResource struct {
	Uri        string              `json:"uri,omitempty"`
	Records    []UserGroupResource `json:"records,omitempty"`
	Paging     Paging              `json:"paging,omitempty"`
	Navigation Navigation          `json:"navigation,omitempty"`
}
type Navigation struct {
	NextPage     ResourceLink `json:"nextPage,omitempty"`
	PreviousPage ResourceLink `json:"previousPage,omitempty"`
	FirstPage    ResourceLink `json:"firstPage,omitempty"`
	LastPage     ResourceLink `json:"lastPage,omitempty"`
}
type NavigationInfo struct {
	FirstPage    NavigationInfoUri `json:"firstPage,omitempty"`
	NextPage     NavigationInfoUri `json:"nextPage,omitempty"`
	PreviousPage NavigationInfoUri `json:"previousPage,omitempty"`
	LastPage     NavigationInfoUri `json:"lastPage,omitempty"`
}
type NavigationInfoUri struct {
	Uri string `json:"uri,omitempty"`
}

type NewCookie ¶ 

type NewCookie struct {
	Name     string    `json:"name,omitempty"`
	Value    string    `json:"value,omitempty"`
	Version  int32     `json:"version,omitempty"`
	Path     string    `json:"path,omitempty"`
	Domain   string    `json:"domain,omitempty"`
	Comment  string    `json:"comment,omitempty"`
	MaxAge   int32     `json:"maxAge,omitempty"`
	Expiry   time.Time `json:"expiry,omitempty"`
	Secure   bool      `json:"secure,omitempty"`
	HttpOnly bool      `json:"httpOnly,omitempty"`
}

type NotificationBlacklistedData ¶ 

type NotificationBlacklistedData struct {
	// Time of adding subscrition to a black list in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example *2016-03-10T18:07:52.534Z*
	BlacklistedAt time.Time `json:"blacklistedAt,omitempty"`
	// Reason of adding subscrition to a black list
	Reason string `json:"reason,omitempty"`
}

Returned if WebHook subscription is blacklisted

type NotificationDeliveryMode ¶ 

type NotificationDeliveryMode struct {
	// Notifications transportation provider name. 'APNS' (Apple Push Notifications Service)
	TransportType string `json:"transportType,omitempty"`
	// Optional parameter. Specifies if the message will be encrypted or not. For APNS transport type the value is always  false
	Encryption bool `json:"encryption,omitempty"`
	// PubNub channel name. For APNS transport type - internal identifier of a device  device_token
	Address string `json:"address,omitempty"`
	// PubNub subscriber credentials required to subscribe to the channel
	SubscriberKey string `json:"subscriberKey,omitempty"`
	// PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)
	SecretKey string `json:"secretKey,omitempty"`
	// Encryption algorithm 'AES' (for PubNub transport type only)
	EncryptionAlgorithm string `json:"encryptionAlgorithm,omitempty"`
	// Key for notification message decryption (for PubNub transport type only)
	EncryptionKey string `json:"encryptionKey,omitempty"`
}

type NotificationDeliveryModeRequest ¶ 

type NotificationDeliveryModeRequest struct {
	// Notifications transportation provider name. 'APNS' (Apple Push Notifications Service)
	TransportType string `json:"transportType,omitempty"`
	// Mandatory for 'APNS' and 'WebHook' transport types. For 'APNS' - internal identifier of a device 'device_token' for 'WebHook' - URL of a consumer service (cannot be changed during subscription update)
	Address string `json:"address,omitempty"`
	// Optional parameter. Specifies if the message will be encrypted or not. If request contains any presence event filter the value by default is 'True' (even if specified as 'false'). If request contains only message event filters the value by default is 'False'
	Encryption bool `json:"encryption,omitempty"`
	// For 'PubNub/APNS' and 'PubNub/GCM' transport types. Name of a certificate
	CertificateName string `json:"certificateName,omitempty"`
	// For 'PubNub/APNS' and 'PubNub/GCM' transport types. Identifier of a registration
	RegistrationId string `json:"registrationId,omitempty"`
}

type NotificationInfo ¶ 

type NotificationInfo struct {
	Alerts AlertInfo `json:"alerts,omitempty"`
	// Number of incoming messages
	Badge string `json:"badge,omitempty"`
	// Message sound
	Sound string `json:"sound,omitempty"`
	// Content availability
	ContentAvailable string `json:"content-available,omitempty"`
	// Category of a message
	Category string `json:"category,omitempty"`
}

type NotificationRecipientInfo ¶ 

type NotificationRecipientInfo struct {
	// Phone number in E.164 (with '+' sign) format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Extension number
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// 'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers
	Target bool `json:"target,omitempty"`
	// Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)
	Location string `json:"location,omitempty"`
	// Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then
	Name string `json:"name,omitempty"`
}

type NotificationSettings ¶ 

type NotificationSettings struct {
	// Canonical URI of notifications settings resource
	Uri string `json:"uri,omitempty"`
	// List of notification recipient email addresses
	EmailAddresses []string `json:"emailAddresses,omitempty"`
	// List of notification recipient email addresses
	SmsEmailAddresses []string `json:"smsEmailAddresses,omitempty"`
	// Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied
	AdvancedMode  bool              `json:"advancedMode,omitempty"`
	Voicemails    VoicemailsInfo    `json:"voicemails,omitempty"`
	InboundFaxes  InboundFaxesInfo  `json:"inboundFaxes,omitempty"`
	OutboundFaxes OutboundFaxesInfo `json:"outboundFaxes,omitempty"`
	InboundTexts  InboundTextsInfo  `json:"inboundTexts,omitempty"`
	MissedCalls   MissedCallsInfo   `json:"missedCalls,omitempty"`
}

type NotificationSettingsUpdateRequest ¶ 

type NotificationSettingsUpdateRequest struct {
	// List of notification recipient email addresses
	EmailAddresses []string `json:"emailAddresses,omitempty"`
	// List of notification recipient email addresses
	SmsEmailAddresses []string `json:"smsEmailAddresses,omitempty"`
	// Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied
	AdvancedMode  bool              `json:"advancedMode,omitempty"`
	Voicemails    VoicemailsInfo    `json:"voicemails,omitempty"`
	InboundFaxes  InboundFaxesInfo  `json:"inboundFaxes,omitempty"`
	OutboundFaxes OutboundFaxesInfo `json:"outboundFaxes,omitempty"`
	InboundTexts  InboundTextsInfo  `json:"inboundTexts,omitempty"`
	MissedCalls   MissedCallsInfo   `json:"missedCalls,omitempty"`
}

type NumberPoolPhoneNumberRequest ¶ 

type NumberPoolPhoneNumberRequest struct {
	// Phone number in E.164 format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Datetime up to which the number is reserved in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. If it is omitted or explicitly set to 'null', the number will be un-reserved if it was reserved previously by the same session. Also the values 'Min' and 'Max' are supported. 'Min' is 30 seconds; and 'Max' is 30 days (for reservation by brand) and 20 minutes (for reservation by account/session)
	ReservedTill time.Time `json:"reservedTill,omitempty"`
	// Internal identifier of a phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time
	ReservationId string `json:"reservationId,omitempty"`
}

type NumberPortingRequest ¶ 

type NumberPortingRequest struct {
	RcAccountId    int64  `json:"rcAccountId,omitempty"`
	RcOrderId      int64  `json:"rcOrderId,omitempty"`
	OrderStatus    string `json:"orderStatus,omitempty"`
	Timestamp      string `json:"timestamp,omitempty"`
	Jcode          string `json:"jcode,omitempty"`
	CompletionDate string `json:"completionDate,omitempty"`
	TransferDate   string `json:"transferDate,omitempty"`
}

type OptionInfo ¶ 

type OptionInfo struct {
	// Specifies if the feature is allowed ('True') or disallowed ('False') for the special number
	Enabled bool             `json:"enabled,omitempty"`
	Reason  OptionInfoReason `json:"reason"`
}

type OptionInfoReason ¶ 

type OptionInfoReason struct {
	// Internal code of the option disallowance reason
	Id string `json:"id,omitempty"`
	// Text description of the option disallowance reason
	Message string `json:"message,omitempty"`
}

type OrderLicensesRequest ¶ 

type OrderLicensesRequest struct {
	// List of licenses to be purchased
	AddedLicenses []LicenseInfoRequest `json:"addedLicenses,omitempty"`
}

type OrderResource ¶ 

type OrderResource struct {
	Id      string           `json:"id,omitempty"`
	Uri     string           `json:"uri,omitempty"`
	Devices []DeviceResource `json:"devices,omitempty"`
}

type OrganizationResource ¶ 

type OrganizationResource struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type OutboundFaxesInfo ¶ 

type OutboundFaxesInfo struct {
	// Email notification flag
	NotifyByEmail bool `json:"notifyByEmail,omitempty"`
	// SMS notification flag
	NotifyBySms bool `json:"notifyBySms,omitempty"`
	// List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedEmailAddresses []string `json:"advancedEmailAddresses,omitempty"`
	// List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedSmsEmailAddresses []string `json:"advancedSmsEmailAddresses,omitempty"`
}

type PagesInfoReporting ¶ 

type PagesInfoReporting struct {
	// Name of a page. CFA application UI predefines a set of possible names and treats them as enum constants to distinguish pages by type. This is not user-visible value, as it might need localization. The maximum value is 255
	Name string `json:"name"`
	// CFA-defined filter values/page parameters
	AttrX string `json:"attrX,omitempty"`
}

type Paging ¶ 

type Paging struct {
	Page          int32 `json:"page,omitempty"`
	TotalPages    int32 `json:"totalPages,omitempty"`
	PerPage       int32 `json:"perPage,omitempty"`
	TotalElements int32 `json:"totalElements,omitempty"`
	PageStart     int32 `json:"pageStart,omitempty"`
	PageEnd       int32 `json:"pageEnd,omitempty"`
}

type PagingDeviceInfo ¶ 

type PagingDeviceInfo struct {
	// Internal identifier of a paging device
	Id string `json:"id,omitempty"`
	// Link to a paging device resource
	Uri string `json:"uri,omitempty"`
	// Name of a paging device
	Name string `json:"name,omitempty"`
}

type PagingGroupExtensionInfo ¶ 

type PagingGroupExtensionInfo struct {
	// Internal identifier of a paging group user extension
	Id string `json:"id,omitempty"`
	// Link to a paging group user extension
	Uri string `json:"uri,omitempty"`
	// Extension number of a paging group user
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Name of a paging group user
	Name string `json:"name,omitempty"`
}

type PagingInfo ¶ 

type PagingInfo struct {
	// The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)
	Page int32 `json:"page,omitempty"`
	// Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied
	PerPage int32 `json:"perPage,omitempty"`
	// The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty
	PageStart int32 `json:"pageStart,omitempty"`
	// The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty
	PageEnd int32 `json:"pageEnd,omitempty"`
	// The total number of pages in a dataset. May be omitted for some resources due to performance reasons
	TotalPages int32 `json:"totalPages,omitempty"`
	// The total number of elements in a dataset. May be omitted for some resource due to performance reasons
	TotalElements int32 `json:"totalElements,omitempty"`
}

type PagingOnlyGroupDevices ¶ 

type PagingOnlyGroupDevices struct {
	// List of paging devices assigned to this group
	Records    []PagingDeviceInfo `json:"records,omitempty"`
	Navigation NavigationInfo     `json:"navigation,omitempty"`
	Paging     PagingInfo         `json:"paging,omitempty"`
}

type PagingOnlyGroupUsers ¶ 

type PagingOnlyGroupUsers struct {
	// List of users allowed to page this group
	Records    []PagingGroupExtensionInfo `json:"records,omitempty"`
	Navigation NavigationInfo             `json:"navigation,omitempty"`
	Paging     PagingInfo                 `json:"paging,omitempty"`
}

type ParameterizedHeader ¶ 

type ParameterizedHeader struct {
	Value string `json:"value,omitempty"`
}

type ParkLocationResponse ¶ 

type ParkLocationResponse struct {
	// List of user extensions allowed to park and unpark calls to/from the extension specified
	Records    []ExtensionInfo `json:"records,omitempty"`
	Navigation NavigationInfo  `json:"navigation,omitempty"`
	Paging     PagingInfo      `json:"paging,omitempty"`
}

type ParsePhoneNumberOpts ¶ 

type ParsePhoneNumberOpts struct {
	HomeCountry        optional.String
	NationalAsPriority optional.Bool
}

type ParsePhoneNumberRequest ¶ 

type ParsePhoneNumberRequest struct {
	// Phone numbers passed in a string. The maximum value of phone numbers is limited to 64. The maximum number of symbols in each phone number in a string is 64
	OriginalStrings string `json:"originalStrings,omitempty"`
}

type ParsePhoneNumberResponse ¶ 

type ParsePhoneNumberResponse struct {
	// Canonical URI of a resource
	Uri string `json:"uri,omitempty"`
	// Information on a user home country
	HomeCountry []GetCountryInfoNumberParser `json:"homeCountry"`
	// Parsed phone numbers data
	PhoneNumbers []PhoneNumberInfoNumberParser `json:"phoneNumbers"`
	// One of the numbers to be parsed, passed as a string in response
	OriginalString string `json:"originalString,omitempty"`
	// Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See North American Numbering Plan for details
	AreaCode string `json:"areaCode,omitempty"`
	// Domestic format of a phone number
	FormattedNational string `json:"formattedNational,omitempty"`
	// International format of a phone number
	FormattedInternational string `json:"formattedInternational,omitempty"`
	// Dialing format of a phone number
	Dialable string `json:"dialable,omitempty"`
	// E.164 (11-digits) format of a phone number
	E164 string `json:"e164,omitempty"`
	//  True  if the number is in a special format (for example N11 code)
	Special bool `json:"special,omitempty"`
	// E.164 (11-digits) format of a phone number without the plus sign ('+')
	Normalized string `json:"normalized,omitempty"`
	// Information on a country the phone number belongs to
	Country []GetCountryInfoNumberParser `json:"country,omitempty"`
}

type ParsedNumberResource ¶ 

type ParsedNumberResource struct {
	Uri                    string          `json:"uri,omitempty"`
	OriginalString         string          `json:"originalString,omitempty"`
	Country                CountryResource `json:"country,omitempty"`
	AreaCode               string          `json:"areaCode,omitempty"`
	SubscriberNumber       string          `json:"subscriberNumber,omitempty"`
	FormattedNational      string          `json:"formattedNational,omitempty"`
	FormattedInternational string          `json:"formattedInternational,omitempty"`
	Dialable               string          `json:"dialable,omitempty"`
	E164                   string          `json:"e164,omitempty"`
	Special                bool            `json:"special,omitempty"`
	Normalized             string          `json:"normalized,omitempty"`
	TollFree               bool            `json:"tollFree,omitempty"`
	SubAddress             string          `json:"subAddress,omitempty"`
	DtmfPostfix            string          `json:"dtmfPostfix,omitempty"`
}

type ParsedPhoneNumbersResource ¶ 

type ParsedPhoneNumbersResource struct {
	Uri          string                 `json:"uri,omitempty"`
	HomeCountry  HomeCountryResource    `json:"homeCountry,omitempty"`
	PhoneNumbers []ParsedNumberResource `json:"phoneNumbers,omitempty"`
}

type PatchOperationInfo ¶ 

type PatchOperationInfo struct {
	Op   string `json:"op"`
	Path string `json:"path,omitempty"`
	// corresponding 'value' of that field specified by 'path'
	Value map[string]interface{} `json:"value,omitempty"`
}

type PatchUserOpts ¶ 

type PatchUserOpts struct {
	ScimUserPatch optional.Interface
}

type PathPattern ¶ 

type PathPattern struct {
	Regex        string      `json:"regex,omitempty"`
	GroupIndexes []int32     `json:"groupIndexes,omitempty"`
	Template     UriTemplate `json:"template,omitempty"`
}

type PatternWithGroups ¶ 

type PatternWithGroups struct {
	Regex        string  `json:"regex,omitempty"`
	GroupIndexes []int32 `json:"groupIndexes,omitempty"`
}

type PaymentInfoAddressResource ¶ 

type PaymentInfoAddressResource struct {
	Country string `json:"country,omitempty"`
	State   string `json:"state,omitempty"`
	City    string `json:"city,omitempty"`
	Street  string `json:"street,omitempty"`
	Zip     string `json:"zip,omitempty"`
}

type PaymentInfoCardHolderResource ¶ 

type PaymentInfoCardHolderResource struct {
	FirstName string                     `json:"firstName,omitempty"`
	LastName  string                     `json:"lastName,omitempty"`
	Address   PaymentInfoAddressResource `json:"address,omitempty"`
}

type PaymentInfoCardResource ¶ 

type PaymentInfoCardResource struct {
	CardType     string                        `json:"cardType,omitempty"`
	Number       string                        `json:"number,omitempty"`
	SecurityCode string                        `json:"securityCode,omitempty"`
	Expiry       string                        `json:"expiry,omitempty"`
	Token        string                        `json:"token,omitempty"`
	Holder       PaymentInfoCardHolderResource `json:"holder,omitempty"`
}

type PaymentInfoResource ¶ 

type PaymentInfoResource struct {
	Uri             string                  `json:"uri,omitempty"`
	PaymentType     string                  `json:"paymentType,omitempty"`
	Card            PaymentInfoCardResource `json:"card,omitempty"`
	InvoiceSettings InvoiceSettingsResource `json:"invoiceSettings,omitempty"`
}

type Permission ¶ 

type Permission struct {
	Enabled bool `json:"enabled,omitempty"`
}

type PermissionCategoryCollectionResource ¶ 

type PermissionCategoryCollectionResource struct {
	Uri        string                       `json:"uri,omitempty"`
	Records    []PermissionCategoryResource `json:"records,omitempty"`
	Paging     Paging                       `json:"paging,omitempty"`
	Navigation Navigation                   `json:"navigation,omitempty"`
}

type PermissionCategoryIdResource ¶ 

type PermissionCategoryIdResource struct {
	Uri string `json:"uri,omitempty"`
	Id  string `json:"id,omitempty"`
}

type PermissionCategoryResource ¶ 

type PermissionCategoryResource struct {
	Uri         string `json:"uri,omitempty"`
	Id          string `json:"id,omitempty"`
	DisplayName string `json:"displayName,omitempty"`
	Description string `json:"description,omitempty"`
}

type PermissionCollectionResource ¶ 

type PermissionCollectionResource struct {
	Uri        string               `json:"uri,omitempty"`
	Records    []PermissionResource `json:"records,omitempty"`
	Paging     Paging               `json:"paging,omitempty"`
	Navigation Navigation           `json:"navigation,omitempty"`
}

type PermissionIdResource ¶ 

type PermissionIdResource struct {
	Uri string `json:"uri,omitempty"`
	Id  string `json:"id,omitempty"`
}

type PermissionInfo ¶ 

type PermissionInfo struct {
	// Specifies if a permission is enabled or not
	Enabled bool `json:"enabled,omitempty"`
}

type PermissionResource ¶ 

type PermissionResource struct {
	Uri                 string                       `json:"uri,omitempty"`
	Id                  string                       `json:"id,omitempty"`
	DisplayName         string                       `json:"displayName,omitempty"`
	Description         string                       `json:"description,omitempty"`
	Assignable          bool                         `json:"assignable,omitempty"`
	ReadOnly            bool                         `json:"readOnly,omitempty"`
	Category            PermissionCategoryIdResource `json:"category,omitempty"`
	IncludedPermissions []PermissionIdResource       `json:"includedPermissions,omitempty"`
}

type PersonalContactResource ¶ 

type PersonalContactResource struct {
	Uri             string             `json:"uri,omitempty"`
	Availability    string             `json:"availability,omitempty"`
	Id              string             `json:"id,omitempty"`
	FirstName       string             `json:"firstName,omitempty"`
	LastName        string             `json:"lastName,omitempty"`
	MiddleName      string             `json:"middleName,omitempty"`
	Birthday        time.Time          `json:"birthday,omitempty"`
	Notes           string             `json:"notes,omitempty"`
	WebPage         string             `json:"webPage,omitempty"`
	Company         string             `json:"company,omitempty"`
	JobTitle        string             `json:"jobTitle,omitempty"`
	NickName        string             `json:"nickName,omitempty"`
	Email           string             `json:"email,omitempty"`
	Email2          string             `json:"email2,omitempty"`
	Email3          string             `json:"email3,omitempty"`
	HomeAddress     ContactAddressInfo `json:"homeAddress,omitempty"`
	OtherAddress    ContactAddressInfo `json:"otherAddress,omitempty"`
	HomePhone       string             `json:"homePhone,omitempty"`
	HomePhone2      string             `json:"homePhone2,omitempty"`
	MobilePhone     string             `json:"mobilePhone,omitempty"`
	BusinessPhone   string             `json:"businessPhone,omitempty"`
	CallbackPhone   string             `json:"callbackPhone,omitempty"`
	CarPhone        string             `json:"carPhone,omitempty"`
	CompanyPhone    string             `json:"companyPhone,omitempty"`
	OtherPhone      string             `json:"otherPhone,omitempty"`
	BusinessFax     string             `json:"businessFax,omitempty"`
	OtherFax        string             `json:"otherFax,omitempty"`
	BusinessAddress ContactAddressInfo `json:"businessAddress,omitempty"`
	AssistantPhone  string             `json:"assistantPhone,omitempty"`
	BusinessPhone2  string             `json:"businessPhone2,omitempty"`
}

type PhoneLineResource ¶ 

type PhoneLineResource struct {
	LineType         string                   `json:"lineType,omitempty"`
	PhoneInfo        PhoneNumberResourceIntId `json:"phoneInfo,omitempty"`
	EmergencyAddress EmergencyAddress         `json:"emergencyAddress,omitempty"`
}

type PhoneLinesInfo ¶ 

type PhoneLinesInfo struct {
	// Type of phone line
	LineType  string               `json:"lineType,omitempty"`
	PhoneInfo PhoneNumberInfoIntId `json:"phoneInfo,omitempty"`
}

type PhoneNumberForProvisioningResource ¶ 

type PhoneNumberForProvisioningResource struct {
	PhoneNumber   string                     `json:"phoneNumber,omitempty"`
	VanityPattern string                     `json:"vanityPattern,omitempty"`
	Source        string                     `json:"source,omitempty"`
	Type          string                     `json:"type,omitempty"`
	UsageType     string                     `json:"usageType,omitempty"`
	Extension     ExtensionReferenceResource `json:"extension,omitempty"`
	ReservationId string                     `json:"reservationId,omitempty"`
}

type PhoneNumberInfo ¶ 

type PhoneNumberInfo struct {
	// Internal identifier of a phone number
	Id        string        `json:"id,omitempty"`
	Country   CountryInfo   `json:"country,omitempty"`
	Extension ExtensionInfo `json:"extension,omitempty"`
	// Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'
	Label string `json:"label,omitempty"`
	// Location (City, State). Filled for local US numbers
	Location string `json:"location,omitempty"`
	// Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
	PaymentType string `json:"paymentType,omitempty"`
	// Phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral
	Status string `json:"status,omitempty"`
	// Phone number type
	Type string `json:"type,omitempty"`
	// Usage type of the phone number
	UsageType string `json:"usageType,omitempty"`
}

type PhoneNumberInfoConferencing ¶ 

type PhoneNumberInfoConferencing struct {
	Country GetCountryInfoConferencing `json:"country,omitempty"`
	// 'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed
	Default bool `json:"default,omitempty"`
	// 'True' if the greeting message is played on this number
	HasGreeting bool `json:"hasGreeting,omitempty"`
	// Location (city, region, state) of a conference phone number
	Location string `json:"location,omitempty"`
	// Dial-in phone number to connect to a conference
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type PhoneNumberInfoIntId ¶ 

type PhoneNumberInfoIntId struct {
	// Internal identifier of a phone number
	Id        int64         `json:"id,omitempty"`
	Country   CountryInfo   `json:"country,omitempty"`
	Extension ExtensionInfo `json:"extension,omitempty"`
	// Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'
	Label string `json:"label,omitempty"`
	// Location (City, State). Filled for local US numbers
	Location string `json:"location,omitempty"`
	// Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
	PaymentType string `json:"paymentType,omitempty"`
	// Phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral
	Status string `json:"status,omitempty"`
	// Phone number type
	Type string `json:"type,omitempty"`
	// Usage type of the phone number
	UsageType string `json:"usageType,omitempty"`
}

type PhoneNumberInfoNumberParser ¶ 

type PhoneNumberInfoNumberParser struct {
	// Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See North American Numbering Plan for details
	AreaCode string `json:"areaCode,omitempty"`
	// Information on a country the phone number belongs to
	Country []GetCountryInfoNumberParser `json:"country,omitempty"`
	// Dialing format of a phone number
	Dialable string `json:"dialable,omitempty"`
	// E.164 (11-digits) format of a phone number
	E164 string `json:"e164,omitempty"`
	// International format of a phone number
	FormattedInternational string `json:"formattedInternational,omitempty"`
	// Domestic format of a phone number
	FormattedNational string `json:"formattedNational,omitempty"`
	// One of the numbers to be parsed, passed as a string in response
	OriginalString string `json:"originalString,omitempty"`
	//  True  if the number is in a special format (for example N11 code)
	Special bool `json:"special,omitempty"`
	// E.164 (11-digits) format of a phone number without the plus sign ('+')
	Normalized string `json:"normalized,omitempty"`
}

type PhoneNumberInfoRequest ¶ 

type PhoneNumberInfoRequest struct {
	// Phone number
	Value string `json:"value,omitempty"`
	// Phone number type
	Type string `json:"type,omitempty"`
}

type PhoneNumberResource ¶ 

type PhoneNumberResource struct {
	// Internal identifier of a phone number
	Id        string            `json:"id,omitempty"`
	Country   CountryResource   `json:"country,omitempty"`
	Extension ExtensionResource `json:"extension,omitempty"`
	// Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'
	Label string `json:"label,omitempty"`
	// Location (City, State). Filled for local US numbers
	Location string `json:"location,omitempty"`
	// Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local'],
	PaymentType string `json:"paymentType,omitempty"`
	// Phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral ,
	Status    string `json:"status,omitempty"`
	UsageType string `json:"usageType,omitempty"`
	// Type of a phone number
	Type string `json:"type,omitempty"`
}

type PhoneNumberResourceIntId ¶ 

type PhoneNumberResourceIntId struct {
	// Internal identifier of a phone number
	Id        int64             `json:"id,omitempty"`
	Country   CountryResource   `json:"country,omitempty"`
	Extension ExtensionResource `json:"extension,omitempty"`
	// Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber'
	Label string `json:"label,omitempty"`
	// Location (City, State). Filled for local US numbers
	Location string `json:"location,omitempty"`
	// Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local'],
	PaymentType string `json:"paymentType,omitempty"`
	// Phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral ,
	Status    string `json:"status,omitempty"`
	UsageType string `json:"usageType,omitempty"`
	// Type of a phone number
	Type string `json:"type,omitempty"`
}

type PhoneNumberStringsResource ¶ 

type PhoneNumberStringsResource struct {
	Uri             string   `json:"uri,omitempty"`
	OriginalStrings []string `json:"originalStrings,omitempty"`
}

type PhoneNumbers ¶ 

type PhoneNumbers struct {
	// Canonical URI of the phone numbers resource
	Uri string `json:"uri,omitempty"`
	// List of phone numbers filtered by the specified criteria
	Records []LookupPhoneNumberInfo `json:"records,omitempty"`
}

type PhoneNumbersApiService ¶ 

type PhoneNumbersApiService service

func (*PhoneNumbersApiService) ListExtensionPhoneNumbers ¶ 

func (a *PhoneNumbersApiService) ListExtensionPhoneNumbers(ctx context.Context, accountId string, extensionId string, localVarOptionals *ListExtensionPhoneNumbersOpts) (GetExtensionPhoneNumbersResponse, *http.Response, error)

type PhoneNumbersRecordsResource ¶ 

type PhoneNumbersRecordsResource struct {
	Uri     string                `json:"uri,omitempty"`
	Records []PhoneNumberResource `json:"records,omitempty"`
}

type PhoneNumbersResource ¶ 

type PhoneNumbersResource struct {
	Uri        string                `json:"uri,omitempty"`
	Records    []PhoneNumberResource `json:"records,omitempty"`
	Paging     Paging                `json:"paging,omitempty"`
	Navigation Navigation            `json:"navigation,omitempty"`
}

type PhotoInfo ¶ 

type PhotoInfo struct {
	Value string `json:"value,omitempty"`
	Type  string `json:"type,omitempty"`
}

type PoolRequestResource ¶ 

type PoolRequestResource struct {
	RendererId string `json:"rendererId,omitempty"`
}

type PoolResponseResource ¶ 

type PoolResponseResource struct {
	RendererId      string   `json:"rendererId,omitempty"`
	MessageId       string   `json:"messageId,omitempty"`
	ExtensionId     string   `json:"extensionId,omitempty"`
	ExtensionNumber string   `json:"extensionNumber,omitempty"`
	FirstName       string   `json:"firstName,omitempty"`
	LastName        string   `json:"lastName,omitempty"`
	Street          string   `json:"street,omitempty"`
	City            string   `json:"city,omitempty"`
	State           string   `json:"state,omitempty"`
	Zip             string   `json:"zip,omitempty"`
	Country         string   `json:"country,omitempty"`
	CountryId       string   `json:"countryId,omitempty"`
	CompanyName     string   `json:"companyName,omitempty"`
	FaxNumber       string   `json:"faxNumber,omitempty"`
	ContactPhone    string   `json:"contactPhone,omitempty"`
	Email           string   `json:"email,omitempty"`
	LanguageCode    string   `json:"languageCode,omitempty"`
	LanguageId      string   `json:"languageId,omitempty"`
	FooterType      float32  `json:"footerType,omitempty"`
	CoverIndex      float32  `json:"coverIndex,omitempty"`
	CoverPageText   string   `json:"coverPageText,omitempty"`
	SourceFiles     []File   `json:"sourceFiles,omitempty"`
	MessageServers  []string `json:"messageServers,omitempty"`
	TouchInterval   int64    `json:"touchInterval,omitempty"`
}

type PostGlipFile ¶ 

type PostGlipFile struct {
	// Internal identifier of a file
	Id string `json:"id"`
	// Link to binary content
	ContentUri string `json:"contentUri"`
	// Name of a file
	Name string `json:"name,omitempty"`
}

type PresenceApiService ¶ 

type PresenceApiService service

func (*PresenceApiService) AccountPresence ¶ 

func (a *PresenceApiService) AccountPresence(ctx context.Context, accountId string) (AccountPresenceInfo, *http.Response, error)

PresenceApiService Get all user statuses

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId

@return AccountPresenceInfo

func (*PresenceApiService) GetMonitoringExtensions ¶ 

func (a *PresenceApiService) GetMonitoringExtensions(ctx context.Context, extensionId string, accountId string) (MonitoringExtensionsResource, *http.Response, error)

PresenceApiService Get User Presence Permissions

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param accountId

@return MonitoringExtensionsResource

func (*PresenceApiService) GetPresenceLine ¶ 

func (a *PresenceApiService) GetPresenceLine(ctx context.Context, lineId string, extensionId string, accountId string) (PresenceLineResource, *http.Response, error)

PresenceApiService Get Monitored Extensions by Id

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lineId
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session

@return PresenceLineResource

func (*PresenceApiService) GetPresenceStatus ¶ 

func (a *PresenceApiService) GetPresenceStatus(ctx context.Context, accountId string, extensionId string) (GetPresenceInfo, *http.Response, error)

PresenceApiService Get User Status <p style='font-style:italic;'>Since 1.0.2</p><p>Returns presence status of an extension or several extensions by their ID(s). Batch request is supported, see Batch Requests for details.The presenceStatus is returned as Offline (the parameters telephonyStatus, message, userStatus and dndStatus are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off.Batch request is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message 'Extension Presence Info multipart request is limited to 30 extensions'.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadPresence</td><td>Getting user presence information</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return GetPresenceInfo

func (*PresenceApiService) ListMonitoredExtensions ¶ 

func (a *PresenceApiService) ListMonitoredExtensions(ctx context.Context, accountId string, extensionId string) (GetMonitoredExtensionsResponse, *http.Response, error)

PresenceApiService Get Monitored Extensions <p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns list of lines - extensions which presence status can be indicated and monitored on BLF-enabled (Busy Lamp Field) devices.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadPresence</td><td>Getting user presence information</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return GetMonitoredExtensionsResponse

func (*PresenceApiService) PutMonitoringExtensions ¶ 

func (a *PresenceApiService) PutMonitoringExtensions(ctx context.Context, extensionId string, accountId string, userPresencePermissionsUpdateRequest UserPresencePermissionsUpdateRequest) (MonitoringExtensionsResource, *http.Response, error)

PresenceApiService Update User Presence Permissions

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param accountId
  • @param userPresencePermissionsUpdateRequest

@return MonitoringExtensionsResource

func (*PresenceApiService) UpdatePresenceLines ¶ 

func (a *PresenceApiService) UpdatePresenceLines(ctx context.Context, accountId string, extensionId string, updatePresenceLinesRequest UpdatePresenceLinesRequest) (UpdatePresenceLinesResponse, *http.Response, error)

PresenceApiService Update Monitored Extensions

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param updatePresenceLinesRequest

@return UpdatePresenceLinesResponse

func (*PresenceApiService) UpdatePresenceStatus ¶ 

func (a *PresenceApiService) UpdatePresenceStatus(ctx context.Context, accountId string, extensionId string, presenceInfoResource PresenceInfoResource) (PresenceInfoResource, *http.Response, error)

PresenceApiService Update User Status

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param presenceInfoResource

@return PresenceInfoResource

type PresenceExtensionInfo ¶ 

type PresenceExtensionInfo struct {
	Id string `json:"id,omitempty"`
}

type PresenceInfoResource ¶ 

type PresenceInfoResource struct {
	UserStatus          string           `json:"userStatus,omitempty"`
	DndStatus           string           `json:"dndStatus,omitempty"`
	Message             string           `json:"message,omitempty"`
	AllowSeeMyPresence  bool             `json:"allowSeeMyPresence,omitempty"`
	RingOnMonitoredCall bool             `json:"ringOnMonitoredCall,omitempty"`
	PickUpCallsOnHold   bool             `json:"pickUpCallsOnHold,omitempty"`
	ActiveCalls         []ActiveCallInfo `json:"activeCalls,omitempty"`
}

type PresenceLineInfo ¶ 

type PresenceLineInfo struct {
	Id        string                `json:"id,omitempty"`
	Extension PresenceExtensionInfo `json:"extension,omitempty"`
}

type PresenceLineResource ¶ 

type PresenceLineResource struct {
	Id        string                   `json:"id,omitempty"`
	Extension InlinedExtensionResource `json:"extension,omitempty"`
}

type PresenceLinesNavigationResource ¶ 

type PresenceLinesNavigationResource struct {
	Uri        string                 `json:"uri,omitempty"`
	Records    []PresenceLineResource `json:"records,omitempty"`
	Paging     Paging                 `json:"paging,omitempty"`
	Navigation Navigation             `json:"navigation,omitempty"`
}

type PresencePermissions ¶ 

type PresencePermissions struct {
	TargetExtensionId       string `json:"targetExtensionId,omitempty"`
	SubscriberExtensionId   string `json:"subscriberExtensionId,omitempty"`
	CanReadPresenceStatus   bool   `json:"canReadPresenceStatus,omitempty"`
	CanReadPresenceSettings bool   `json:"canReadPresenceSettings,omitempty"`
	CanPickup               bool   `json:"canPickup,omitempty"`
}

type PresencePermissionsExtensionInfoRequest ¶ 

type PresencePermissionsExtensionInfoRequest struct {
	// Internal identifier of an extension
	Id string `json:"id,omitempty"`
}

type PresetInfo ¶ 

type PresetInfo struct {
	// Link to a greeting resource
	Uri string `json:"uri,omitempty"`
	// Internal identifier of greeting
	Id string `json:"id,omitempty"`
	// Name of a greeting
	Name string `json:"name,omitempty"`
}

type Principal ¶ 

type Principal struct {
	Name string `json:"name,omitempty"`
}

type ProfileImageInfo ¶ 

type ProfileImageInfo struct {
	// Link to a profile image. If an image is not uploaded for an extension, only uri is returned
	Uri string `json:"uri"`
	// Identifier of an image
	Etag string `json:"etag,omitempty"`
	// The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z
	LastModified time.Time `json:"lastModified,omitempty"`
	// The type of an image
	ContentType string `json:"contentType,omitempty"`
	// List of URIs to profile images in different dimensions
	Scales []ProfileImageInfoUri `json:"scales,omitempty"`
}

type ProfileImageInfoUri ¶ 

type ProfileImageInfoUri struct {
	Uri string `json:"uri,omitempty"`
}

type ProfileImageResource ¶ 

type ProfileImageResource struct {
	Uri          string                       `json:"uri,omitempty"`
	Etag         string                       `json:"etag,omitempty"`
	ContentType  string                       `json:"contentType,omitempty"`
	LastModified time.Time                    `json:"lastModified,omitempty"`
	Scales       []ScaledProfileImageResource `json:"scales,omitempty"`
}

type PromotionCodeResource ¶ 

type PromotionCodeResource struct {
	AccountId     string `json:"accountId,omitempty"`
	PromotionCode string `json:"promotionCode,omitempty"`
}

type PromptInfo ¶ 

type PromptInfo struct {
	// Internal identifier of a prompt
	Uri string `json:"uri,omitempty"`
	// Link to a prompt metadata
	Id string `json:"id,omitempty"`
	// Type of a prompt media content
	ContentType string `json:"contentType,omitempty"`
	// Link to a prompt media content
	ContentUri string `json:"contentUri,omitempty"`
	// Name of a prompt
	Filename string `json:"filename,omitempty"`
}

type PromptLanguageInfo ¶ 

type PromptLanguageInfo struct {
	// Link to prompt language
	Uri string `json:"uri,omitempty"`
	// Internal identifier of an language
	Id string `json:"id,omitempty"`
	// Language name
	Name string `json:"name,omitempty"`
	// Language locale code
	LocaleCode string `json:"localeCode,omitempty"`
}

type PronouncedNameInfo ¶ 

type PronouncedNameInfo struct {
	// Voice name typeDefault - default extension name; first name and last name specified in user profileTextToSpeech - custom text; user name spelled the way it sounds and specified by userRecorded - custom audio; user name recorded in user's own voice (supported only for extension retrieval) = ['Default', 'TextToSpeech', 'Recorded']
	Type string `json:"type,omitempty"`
	// Custom text
	Text string `json:"text,omitempty"`
}

type PropertiesDelegate ¶ 

type PropertiesDelegate struct {
	PropertyNames []string `json:"propertyNames,omitempty"`
}

type ProvisionPhoneNumberRequest ¶ 

type ProvisionPhoneNumberRequest struct {
	ExtensionId ExtensionInfoProvisionPhoneNumbers `json:"extensionId,omitempty"`
	// Phone number to purchase returned in E.164 (11-digits) format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Internal identifier of phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time
	ReservationId string `json:"reservationId,omitempty"`
	// Custom user name of a phone number, if any. Supported for numbers assigned to Auto-Receptionist, with usage type 'CompanyNumber
	Label string `json:"label,omitempty"`
	// Usage type of a phone number. The default value is 'DirectNumber'
	UsageType string `json:"usageType,omitempty"`
	// Type of a phone number
	Type string `json:"type,omitempty"`
	//  Vanity pattern that was used to find this number. It should be passed as if it was returned from the Number Lookup call
	VanityPattern string `json:"vanityPattern,omitempty"`
}

type ProvisioningResource ¶ 

type ProvisioningResource struct {
	WebUris WebUrisResource `json:"webUris,omitempty"`
	Hints   HintsResource   `json:"hints,omitempty"`
}

type PushNotificationsApiService ¶ 

type PushNotificationsApiService service

func (*PushNotificationsApiService) CreateSubscription ¶ 

func (a *PushNotificationsApiService) CreateSubscription(ctx context.Context, createSubscriptionRequest CreateSubscriptionRequest) (SubscriptionInfo, *http.Response, error)

PushNotificationsApiService Create Subscription <p style='font-style:italic;'>Since 1.0.6 (Release 5.15)</p><p>Creates a new subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createSubscriptionRequest JSON body

@return SubscriptionInfo

func (*PushNotificationsApiService) DeleteSubscription ¶ 

func (a *PushNotificationsApiService) DeleteSubscription(ctx context.Context, subscriptionId string) (*http.Response, error)

PushNotificationsApiService Cancel Subscription <p style='font-style:italic;'></p><p>Cancels the existent subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Internal identifier of a subscription

func (*PushNotificationsApiService) GetSubscriptions ¶ 

func (a *PushNotificationsApiService) GetSubscriptions(ctx context.Context) (RecordsCollectionResourceSubscriptionResponse, *http.Response, error)

PushNotificationsApiService Get Subscriptions

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RecordsCollectionResourceSubscriptionResponse

func (*PushNotificationsApiService) LoadSubscription ¶ 

func (a *PushNotificationsApiService) LoadSubscription(ctx context.Context, subscriptionId int32) (SubscriptionInfo, *http.Response, error)

PushNotificationsApiService Get Subscription <p style='font-style:italic;'>Since 1.0.6 (Release 5.15)</p><p>Returns the requested subscription.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Internal identifier of a subscription

@return SubscriptionInfo

func (*PushNotificationsApiService) RenewSubscription ¶ 

func (a *PushNotificationsApiService) RenewSubscription(ctx context.Context, subscriptionId string) (SubscriptionInfo, *http.Response, error)

PushNotificationsApiService Renew Subscription <p style='font-style:italic;'>Since 1.0.26 (Release 8.12)</p><p>Renews an existent subscription by ID by posting request with an empty body..</p><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId

@return SubscriptionInfo

func (*PushNotificationsApiService) UpdateSubscription ¶ 

func (a *PushNotificationsApiService) UpdateSubscription(ctx context.Context, subscriptionId string, modifySubscriptionRequest ModifySubscriptionRequest, localVarOptionals *UpdateSubscriptionOpts) (SubscriptionInfo, *http.Response, error)

type PutPresenceResource ¶ 

type PutPresenceResource struct {
	UserStatus          string `json:"userStatus,omitempty"`
	Message             string `json:"message,omitempty"`
	DndStatus           string `json:"dndStatus,omitempty"`
	AllowSeeMyPresence  bool   `json:"allowSeeMyPresence,omitempty"`
	RingOnMonitoredCall bool   `json:"ringOnMonitoredCall,omitempty"`
	PickUpCallsOnHold   bool   `json:"pickUpCallsOnHold,omitempty"`
}

type QueueInfo ¶ 

type QueueInfo struct {
	// Specifies how calls are transferred to group members
	TransferMode string `json:"transferMode,omitempty"`
	// Information on a call forwarding rule
	FixedOrderAgents []FixedOrderAgents `json:"fixedOrderAgents,omitempty"`
	// Connecting audio interruption mode
	HoldAudioInterruptionMode string `json:"holdAudioInterruptionMode,omitempty"`
	// Connecting audio interruption message period in seconds
	HoldAudioInterruptionPeriod int32 `json:"holdAudioInterruptionPeriod,omitempty"`
	// Maximum time in seconds to wait for a call queue member before trying the next member
	AgentTimeout int32 `json:"agentTimeout,omitempty"`
	// Minimum post-call wrap up time in seconds before agent status is automatically set
	WrapUpTime int32 `json:"wrapUpTime,omitempty"`
	// Maximum hold time in seconds to wait for an available call queue member
	HoldTime int32 `json:"holdTime,omitempty"`
	// Maximum count of callers on hold
	MaxCallers int32 `json:"maxCallers,omitempty"`
	// Action which should be taken if count of callers on hold exceeds the maximum
	MaxCallersAction string `json:"maxCallersAction,omitempty"`
}

type RangesInfo ¶ 

type RangesInfo struct {
	// Date and time in format YYYY-MM-DD hh:mm
	From time.Time `json:"from,omitempty"`
	// Date and time in format YYYY-MM-DD hh:mm
	To time.Time `json:"to,omitempty"`
}

type RcVideoNotificationsEvent ¶ 

type RcVideoNotificationsEvent struct {
	// Identifier of a meeting
	Id string `json:"id,omitempty"`
	// Meeting Name
	Name string `json:"name,omitempty"`
	// Datetime of meeting start in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	Start string `json:"start,omitempty"`
	// Meeting duration
	Duration     int32               `json:"duration,omitempty"`
	Participants RcvParticipantsInfo `json:"participants,omitempty"`
	// Specifies whether a meeting is recorded or not
	Recorded  bool             `json:"recorded,omitempty"`
	Recording RcvRecordingInfo `json:"recording,omitempty"`
}

type RcvParticipantsInfo ¶ 

type RcvParticipantsInfo struct {
	// Participant account
	Account string `json:"account,omitempty"`
	// Participant extension
	Extension string `json:"extension,omitempty"`
	// Participant name
	Name string `json:"name,omitempty"`
	// Participant profile image
	Img string `json:"img,omitempty"`
}

type RcvRecordingInfo ¶ 

type RcvRecordingInfo struct {
	// Meeting record size in bytes
	Size int32 `json:"size,omitempty"`
	// Meeting duration in seconds
	Duration int32 `json:"duration,omitempty"`
	// Link to a meeting record
	Url string `json:"url,omitempty"`
}

type Reason ¶ 

type Reason struct {
	Id      string `json:"id,omitempty"`
	Message string `json:"message,omitempty"`
}

type ReassignPhoneNumberByIdOpts ¶ 

type ReassignPhoneNumberByIdOpts struct {
	ReassignPhoneNumberResource optional.Interface
}

type ReassignPhoneNumberResource ¶ 

type ReassignPhoneNumberResource struct {
	Uri       string                     `json:"uri,omitempty"`
	Id        string                     `json:"id,omitempty"`
	UsageType string                     `json:"usageType,omitempty"`
	Extension ExtensionReferenceResource `json:"extension,omitempty"`
}

type RecipientInfo ¶ 

type RecipientInfo struct {
	// Link to a recipient extension resource
	Uri string `json:"uri,omitempty"`
	// Internal identifier of a recipient extension
	Id string `json:"id,omitempty"`
}

type RecordingInfo ¶ 

type RecordingInfo struct {
	// Internal identifier of the call recording
	Id string `json:"id,omitempty"`
	// Link to the call recording metadata resource
	Uri string `json:"uri,omitempty"`
	// Indicates recording mode used
	Type string `json:"type,omitempty"`
	// Link to the call recording binary content
	ContentUri string `json:"contentUri,omitempty"`
}

type RecordsCollectionResourceSubscriptionResponse ¶ 

type RecordsCollectionResourceSubscriptionResponse struct {
	Uri     string                 `json:"uri,omitempty"`
	Records []SubscriptionResponse `json:"records,omitempty"`
}

type RecurrenceInfoReporting ¶ 

type RecurrenceInfoReporting struct {
	// Pattern (frequency) of recurrence
	Pattern string `json:"pattern,omitempty"`
	// Time and dates should be specified in UTC time zone
	Value string `json:"value,omitempty"`
}

type Reference ¶ 

type Reference struct {
	Type string `json:"type,omitempty"`
	Ref  string `json:"ref,omitempty"`
}

type ReferenceInfo ¶ 

type ReferenceInfo struct {
	// Non-RC identifier of an extension
	Ref string `json:"ref,omitempty"`
	// Type of external identifier
	Type string `json:"type,omitempty"`
}

type RegionalSettings ¶ 

type RegionalSettings struct {
	HomeCountry      CountryInfo          `json:"homeCountry,omitempty"`
	Timezone         TimezoneInfo         `json:"timezone,omitempty"`
	Language         LanguageInfo         `json:"language,omitempty"`
	GreetingLanguage GreetingLanguageInfo `json:"greetingLanguage,omitempty"`
	FormattingLocale FormattingLocaleInfo `json:"formattingLocale,omitempty"`
	// Time format setting. The default value is '12h' = ['12h', '24h']
	TimeFormat string `json:"timeFormat,omitempty"`
}

type RegionalSettingsApiService ¶ 

type RegionalSettingsApiService service

func (*RegionalSettingsApiService) ListCountries ¶ 

func (a *RegionalSettingsApiService) ListCountries(ctx context.Context, localVarOptionals *ListCountriesOpts) (GetCountryListResponse, *http.Response, error)

func (*RegionalSettingsApiService) ListLanguages ¶ 

func (a *RegionalSettingsApiService) ListLanguages(ctx context.Context) (LanguageList, *http.Response, error)

RegionalSettingsApiService Get Language List <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Returns the information about supported languages.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LanguageList

func (*RegionalSettingsApiService) ListLocations ¶ 

func (a *RegionalSettingsApiService) ListLocations(ctx context.Context, localVarOptionals *ListLocationsOpts) (GetLocationListResponse, *http.Response, error)

func (*RegionalSettingsApiService) ListTimezones ¶ 

func (a *RegionalSettingsApiService) ListTimezones(ctx context.Context, localVarOptionals *ListTimezonesOpts) (GetTimezoneListResponse, *http.Response, error)

func (*RegionalSettingsApiService) LoadCountry ¶ 

func (a *RegionalSettingsApiService) LoadCountry(ctx context.Context, countryId int32) (GetCountryInfoDictionaryResponse, *http.Response, error)

RegionalSettingsApiService Get Country <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the information on the required country.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param countryId Internal identifier of a country

@return GetCountryInfoDictionaryResponse

func (*RegionalSettingsApiService) LoadLanguage ¶ 

func (a *RegionalSettingsApiService) LoadLanguage(ctx context.Context, languageId int32) (LanguageInfo, *http.Response, error)

RegionalSettingsApiService Get Language <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Returns language by its respective ID.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param languageId Internal identifier of a language

@return LanguageInfo

func (*RegionalSettingsApiService) LoadState ¶ 

func (a *RegionalSettingsApiService) LoadState(ctx context.Context, stateId int32) (GetStateInfoResponse, *http.Response, error)

RegionalSettingsApiService Get State <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the information on the required state.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param stateId Internal identifier of a state

@return GetStateInfoResponse

func (*RegionalSettingsApiService) LoadTimezone ¶ 

func (a *RegionalSettingsApiService) LoadTimezone(ctx context.Context, timezoneId int32, localVarOptionals *LoadTimezoneOpts) (GetTimezoneInfoResponse, *http.Response, error)

func (*RegionalSettingsApiService) LoadlistStates ¶ 

func (a *RegionalSettingsApiService) LoadlistStates(ctx context.Context, localVarOptionals *LoadlistStatesOpts) (GetStateListResponse, *http.Response, error)

type RegionalSettingsResource ¶ 

type RegionalSettingsResource struct {
	Timezone         TimezoneResource `json:"timezone,omitempty"`
	HomeCountry      CountryResource  `json:"homeCountry,omitempty"`
	Language         LanguageResource `json:"language,omitempty"`
	GreetingLanguage LanguageResource `json:"greetingLanguage,omitempty"`
	FormattingLocale LanguageResource `json:"formattingLocale,omitempty"`
}

type RegistrationRequest ¶ 

type RegistrationRequest struct {
	Device  DeviceToRegister       `json:"device,omitempty"`
	SipInfo []SipDetailsToRegister `json:"sipInfo,omitempty"`
}

type RegistrationResponse ¶ 

type RegistrationResponse struct {
	Uri      string         `json:"uri,omitempty"`
	Device   DeviceResource `json:"device,omitempty"`
	SipInfo  []SipInfo      `json:"sipInfo,omitempty"`
	SipFlags SipFlags       `json:"sipFlags,omitempty"`
}

type ReportingApiService ¶ 

type ReportingApiService service

func (*ReportingApiService) LoadReportingSettings ¶ 

func (a *ReportingApiService) LoadReportingSettings(ctx context.Context, accountId string, extensionId string) (ReportingSettings, *http.Response, error)

ReportingApiService Get Reporting Settings <p style='font-style:italic;'>Since 1.0.17 (Release 7.2)</p><p>Returns user-defined configuration of CFA (Customer Facing Analytics) reports.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return ReportingSettings

func (*ReportingApiService) UpdateReportingSettings ¶ 

func (a *ReportingApiService) UpdateReportingSettings(ctx context.Context, accountId string, extensionId string, setReportingSettingsRequest SetReportingSettingsRequest) (ReportingSettings, *http.Response, error)

ReportingApiService Update Reporting Settings <p style='font-style:italic;'></p><p>Sets user-defined configuration of CFA (Customer Facing Analytics) reports.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param setReportingSettingsRequest JSON body

@return ReportingSettings

type ReportingAttachmentInfo ¶ 

type ReportingAttachmentInfo struct {
	// Specifies whether to include CSV version of the report
	Csv bool `json:"csv,omitempty"`
	// Specifies whether to include PDF version of the report
	Pdf bool `json:"pdf,omitempty"`
}

type ReportingPagesInfo ¶ 

type ReportingPagesInfo struct {
	// Name of a page. CFA application UI predefines a set of possible names and treats them as enum constants to distinguish pages by type. This is not user-visible value, as it might need localization. The maximum value is 255
	Name string `json:"name"`
	// CFA-defined filter values/page parameters
	AttrX string `json:"attrX,omitempty"`
}

type ReportingRecurrenceInfo ¶ 

type ReportingRecurrenceInfo struct {
	// Pattern (frequency) of recurrence
	Pattern string `json:"pattern,omitempty"`
	// Time and dates should be specified in UTC time zone
	Value string `json:"value,omitempty"`
}

type ReportingSchedulesInfo ¶ 

type ReportingSchedulesInfo struct {
	// Unique schedule identifier
	ScheduleId string `json:"scheduleId,omitempty"`
	// Recurrence pattern of a schedule
	Recurrence []ReportingRecurrenceInfo `json:"recurrence,omitempty"`
	// Type of report. Detailed reports include tables with data. Simple reports only include charts
	ViewType string `json:"viewType,omitempty"`
	// Set of optional attachments. Basically, every report email is in HTML format. Optionally, it can contain PDF or CSV files
	Attachments []ReportingAttachmentInfo `json:"attachments,omitempty"`
	// List of pages to include to the report. If empty, all pages are included. Otherwise, only specified pages are included. API doesn't check validity of page names. Client application is responsible to do that
	Pages []string `json:"pages,omitempty"`
	// List of emails to which to send rendered reports
	Recipients []string `json:"recipients,omitempty"`
}

type ReportingSettings ¶ 

type ReportingSettings struct {
	// List of 'View' structures with a tuple of filter values, pages and schedules
	Views []ReportingViewInfo `json:"views"`
}

type ReportingViewInfo ¶ 

type ReportingViewInfo struct {
	// User-defined name of a 'View'. The maximum value is 255
	Name string `json:"name"`
	// List of pages, the max amount is 10
	Pages []ReportingPagesInfo `json:"pages"`
	// List of schedules, the max amount is 5. Each 'View' may have several schedules for reporting. For example, customer may want to get daily and weekly reports with the same set of settings
	Schedules []ReportingSchedulesInfo `json:"schedules,omitempty"`
}

type Request ¶ 

type Request struct {
	Method string `json:"method,omitempty"`
}

type ReservationDate ¶ 

type ReservationDate struct {
	Date time.Time `json:"date,omitempty"`
	Max  bool      `json:"max,omitempty"`
	Min  bool      `json:"min,omitempty"`
}

type ReservePhoneNumberResource ¶ 

type ReservePhoneNumberResource struct {
	// Phone number in E.164
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Domestic format of a phone number
	FormattedNumber string `json:"formattedNumber,omitempty"`
	//  Datetime up to which the number is reserved in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. No value means that number is not reserved anymore
	ReservedTill string `json:"reservedTill,omitempty"`
	// nternal identifier of phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time
	ReservationId string `json:"reservationId,omitempty"`
	// Phone number status = ['Enabled', 'Pending', 'Disabled'],
	Status string `json:"status,omitempty"`
	// The error code in case of reservation/un-reservation failure = ['NumberIsAlreadyProvisioned', 'NumberReserved', 'NumberNotAvailable']
	Error string `json:"error,omitempty"`
}

type ReservePhoneNumbersRecordsResource ¶ 

type ReservePhoneNumbersRecordsResource struct {
	Records []ReservePhoneNumberResource `json:"records,omitempty"`
}
type ResourceLink struct {
	Uri string `json:"uri,omitempty"`
}

type ResourceModelComponent ¶ 

type ResourceModelComponent struct {
	Components []ResourceModelComponent `json:"components,omitempty"`
}

type RingOutApiService ¶ 

type RingOutApiService service

func (*RingOutApiService) CancelRingOutCall ¶ 

func (a *RingOutApiService) CancelRingOutCall(ctx context.Context, accountId string, extensionId string, ringoutId int32) (*http.Response, error)

RingOutApiService Cancel RingOut Call <p style='font-style:italic;'></p><p>Cancels the 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param ringoutId Internal identifier of a RingOut call

func (*RingOutApiService) CancelRingOutCallNew ¶ 

func (a *RingOutApiService) CancelRingOutCallNew(ctx context.Context, accountId string, extensionId string, ringoutId int32) (*http.Response, error)

RingOutApiService Cancel RingOut Call <p style='font-style:italic;'></p><p>Cancels the 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param ringoutId Internal identifier of a RingOut call

func (*RingOutApiService) CreateDirectRingOut ¶ 

func (a *RingOutApiService) CreateDirectRingOut(ctx context.Context, accountId string, extensionId string, ringOutResource RingOutResource) (*http.Response, error)

RingOutApiService

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param extensionId
  • @param ringOutResource

func (*RingOutApiService) CreateDirectRingOutNew ¶ 

func (a *RingOutApiService) CreateDirectRingOutNew(ctx context.Context, accountId string, extensionId string, ringOutResource RingOutResource) (*http.Response, error)

RingOutApiService Make Direct RingOut Call

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId
  • @param extensionId
  • @param ringOutResource

func (*RingOutApiService) GetRingOutCallStatus ¶ 

func (a *RingOutApiService) GetRingOutCallStatus(ctx context.Context, accountId string, extensionId string, ringoutId int32) (GetRingOutStatusResponse, *http.Response, error)

RingOutApiService Get Status of RingOut Call <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Returns the status of a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param ringoutId Internal identifier of a RingOut call

@return GetRingOutStatusResponse

func (*RingOutApiService) GetRingOutCallStatusNew ¶ 

func (a *RingOutApiService) GetRingOutCallStatusNew(ctx context.Context, accountId string, extensionId string, ringoutId int32) (GetRingOutStatusResponse, *http.Response, error)

RingOutApiService Get Status of RingOut Call <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Returns the status of a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param ringoutId Internal identifier of a RingOut call

@return GetRingOutStatusResponse

func (*RingOutApiService) MakeRingOutCall ¶ 

func (a *RingOutApiService) MakeRingOutCall(ctx context.Context, accountId string, extensionId string, makeRingOutRequest MakeRingOutRequest) (GetRingOutStatusResponseIntId, *http.Response, error)

RingOutApiService Make RingOut Call <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Makes a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param makeRingOutRequest JSON body

@return GetRingOutStatusResponseIntId

func (*RingOutApiService) MakeRingOutCallNew ¶ 

func (a *RingOutApiService) MakeRingOutCallNew(ctx context.Context, accountId string, extensionId string, makeRingOutRequest MakeRingOutRequest) (GetRingOutStatusResponse, *http.Response, error)

RingOutApiService Make RingOut Call <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Makes a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param makeRingOutRequest JSON body

@return GetRingOutStatusResponse

type RingOutCountry ¶ 

type RingOutCountry struct {
	Id string `json:"id,omitempty"`
}

type RingOutFromInfo ¶ 

type RingOutFromInfo struct {
	PhoneNumber        string `json:"phoneNumber,omitempty"`
	ForwardingNumberId string `json:"forwardingNumberId,omitempty"`
}

type RingOutPhoneNumberInfo ¶ 

type RingOutPhoneNumberInfo struct {
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type RingOutResource ¶ 

type RingOutResource struct {
	From       RingOutFromInfo        `json:"from,omitempty"`
	To         RingOutPhoneNumberInfo `json:"to,omitempty"`
	CallerId   RingOutPhoneNumberInfo `json:"callerId,omitempty"`
	PlayPrompt bool                   `json:"playPrompt,omitempty"`
	Country    RingOutCountry         `json:"country,omitempty"`
}

type RingOutStatusInfo ¶ 

type RingOutStatusInfo struct {
	// Status of a call
	CallStatus string `json:"callStatus,omitempty"`
	// Status of a calling party
	CallerStatus string `json:"callerStatus,omitempty"`
	// Status of a called party
	CalleeStatus string `json:"calleeStatus,omitempty"`
}

type RoleIdResource ¶ 

type RoleIdResource struct {
	Uri string `json:"uri,omitempty"`
	Id  string `json:"id,omitempty"`
}

type RoleResource ¶ 

type RoleResource struct {
	Uri         string                 `json:"uri,omitempty"`
	Id          string                 `json:"id,omitempty"`
	DisplayName string                 `json:"displayName,omitempty"`
	Description string                 `json:"description,omitempty"`
	Custom      bool                   `json:"custom,omitempty"`
	Scope       string                 `json:"scope,omitempty"`
	Hidden      bool                   `json:"hidden,omitempty"`
	LastUpdated time.Time              `json:"lastUpdated,omitempty"`
	Permissions []PermissionIdResource `json:"permissions,omitempty"`
}

type RolesAndPermissionsApiService ¶ 

type RolesAndPermissionsApiService service

func (*RolesAndPermissionsApiService) CheckPermission ¶ 

func (a *RolesAndPermissionsApiService) CheckPermission(ctx context.Context, extensionId string, accountId string, localVarOptionals *CheckPermissionOpts) (AuthProfileCheckResource, *http.Response, error)

func (*RolesAndPermissionsApiService) GetPermission ¶ 

func (a *RolesAndPermissionsApiService) GetPermission(ctx context.Context, permissionId string) (PermissionResource, *http.Response, error)

RolesAndPermissionsApiService Get Permission Info

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param permissionId

@return PermissionResource

func (*RolesAndPermissionsApiService) GetPermissionCategory ¶ 

func (a *RolesAndPermissionsApiService) GetPermissionCategory(ctx context.Context, permissionCategoryId string) (PermissionCategoryResource, *http.Response, error)

RolesAndPermissionsApiService Get Permission Category

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param permissionCategoryId

@return PermissionCategoryResource

func (*RolesAndPermissionsApiService) GetProfile ¶ 

func (a *RolesAndPermissionsApiService) GetProfile(ctx context.Context, extensionId string, accountId string) (AuthProfileResource, *http.Response, error)

RolesAndPermissionsApiService Get User Permissions

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param extensionId
  • @param accountId

@return AuthProfileResource

func (*RolesAndPermissionsApiService) GetSystemRole ¶ 

func (a *RolesAndPermissionsApiService) GetSystemRole(ctx context.Context, roleId string) (RoleResource, *http.Response, error)

RolesAndPermissionsApiService Get User Role

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId

@return RoleResource

func (*RolesAndPermissionsApiService) ListPermissionCategories ¶ 

func (a *RolesAndPermissionsApiService) ListPermissionCategories(ctx context.Context, localVarOptionals *ListPermissionCategoriesOpts) (PermissionCategoryCollectionResource, *http.Response, error)

func (*RolesAndPermissionsApiService) ListPermissions ¶ 

func (a *RolesAndPermissionsApiService) ListPermissions(ctx context.Context, localVarOptionals *ListPermissionsOpts) (PermissionCollectionResource, *http.Response, error)

func (*RolesAndPermissionsApiService) ListSystemRoles ¶ 

func (a *RolesAndPermissionsApiService) ListSystemRoles(ctx context.Context, localVarOptionals *ListSystemRolesOpts) (RolesCollectionResource, *http.Response, error)

func (*RolesAndPermissionsApiService) LoadUserRole ¶ 

func (a *RolesAndPermissionsApiService) LoadUserRole(ctx context.Context, accountId string) (*http.Response, error)

RolesAndPermissionsApiService Get Default User Role <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns account default user role.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RoleManagement</td><td>Editing and assignment of user roles</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of an account

func (*RolesAndPermissionsApiService) UpdateUserRole ¶ 

func (a *RolesAndPermissionsApiService) UpdateUserRole(ctx context.Context, accountId string, defaultUserRoleRequest DefaultUserRoleRequest) (*http.Response, error)

RolesAndPermissionsApiService Set Default User Role <p style='font-style:italic;'>Since 1.0.30 (Release 9.1)</p><p>Updates account default user role.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RoleManagement</td><td>Editing and assignment of user roles</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of an account
  • @param defaultUserRoleRequest JSON body

type RolesCollectionResource ¶ 

type RolesCollectionResource struct {
	Uri        string         `json:"uri,omitempty"`
	Records    []RoleResource `json:"records,omitempty"`
	Paging     Paging         `json:"paging,omitempty"`
	Navigation Navigation     `json:"navigation,omitempty"`
}

type RuleInfo ¶ 

type RuleInfo struct {
	// Forwarding number (or group) ordinal
	Index int32 `json:"index,omitempty"`
	// Number of rings for a forwarding number (or group)
	RingCount int32 `json:"ringCount,omitempty"`
	// Forwarding number (or group) data
	ForwardingNumbers []ForwardingNumberInfoRules `json:"forwardingNumbers,omitempty"`
}

type RuleInfoCreateRuleRequest ¶ 

type RuleInfoCreateRuleRequest struct {
	// Forwarding number (or group) ordinal
	Index int32 `json:"index,omitempty"`
	// Number of rings for a forwarding number (or group)
	RingCount int32 `json:"ringCount,omitempty"`
	// Forwarding number (or group) data
	ForwardingNumbers []ForwardingNumberInfoRulesCreateRuleRequest `json:"forwardingNumbers,omitempty"`
}

type SCIMApiService ¶ 

type SCIMApiService service

func (*SCIMApiService) CreateUser ¶ 

func (a *SCIMApiService) CreateUser(ctx context.Context, userCreationRequest UserCreationRequest) (UserInfo, *http.Response, error)

SCIMApiService Create User <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Creates a user.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userCreationRequest a new user without 'id'

@return UserInfo

func (*SCIMApiService) DeleteUser ¶ 

func (a *SCIMApiService) DeleteUser(ctx context.Context, id string) (*http.Response, error)

SCIMApiService Delete User <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Deleting User using scim</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Internal identifier of a user

func (*SCIMApiService) GetServiceProviderConfig ¶ 

func (a *SCIMApiService) GetServiceProviderConfig(ctx context.Context) (ServiceProviderConfig, *http.Response, error)

SCIMApiService Get Service Provider Config <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns the list of users requested.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing Service Provider confiog</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ServiceProviderConfig

func (*SCIMApiService) GetUserById ¶ 

func (a *SCIMApiService) GetUserById(ctx context.Context, id string) (UserInfo, *http.Response, error)

SCIMApiService Get User <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a user by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Internal identifier of a user

@return UserInfo

func (*SCIMApiService) ListUsers ¶ 

func (a *SCIMApiService) ListUsers(ctx context.Context, localVarOptionals *ListUsersOpts) (GetUserListResponse, *http.Response, error)

func (*SCIMApiService) PatchUser ¶ 

func (a *SCIMApiService) PatchUser(ctx context.Context, id string, localVarOptionals *PatchUserOpts) (UserInfo, *http.Response, error)

func (*SCIMApiService) SearchUsersViaPost ¶ 

func (a *SCIMApiService) SearchUsersViaPost(ctx context.Context, localVarOptionals *SearchUsersViaPostOpts) (GetUserListResponse, *http.Response, error)

func (*SCIMApiService) UpdateUser ¶ 

func (a *SCIMApiService) UpdateUser(ctx context.Context, id string, userUpdateRequest UserUpdateRequest) (UserInfo, *http.Response, error)

SCIMApiService Update or replace user <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Updating User using SCIM</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Internal identifier of a user
  • @param userUpdateRequest An Exisiting User

@return UserInfo

type SaveRequestResource ¶ 

type SaveRequestResource struct {
	RendererId string `json:"rendererId,omitempty"`
	MessageId  string `json:"messageId,omitempty"`
	Status     string `json:"status,omitempty"`
	ResultFile string `json:"resultFile,omitempty"`
}

type ScaledProfileImageResource ¶ 

type ScaledProfileImageResource struct {
	Uri string `json:"uri,omitempty"`
}

type ScheduleInfo ¶ 

type ScheduleInfo struct {
	WeeklyRanges WeeklyScheduleInfo `json:"weeklyRanges,omitempty"`
	Ranges       RangesInfo         `json:"ranges,omitempty"`
	// The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method
	Ref string `json:"ref,omitempty"`
}

type ScheduleInfoUserBusinessHours ¶ 

type ScheduleInfoUserBusinessHours struct {
	WeeklyRanges WeeklyScheduleInfo `json:"weeklyRanges,omitempty"`
}

type ScheduleResource ¶ 

type ScheduleResource struct {
	Ranges []DateTimeIntervalResource `json:"ranges,omitempty"`
	Ref    string                     `json:"ref,omitempty"`
}

type SchedulesInfoReporting ¶ 

type SchedulesInfoReporting struct {
	// Unique schedule identifier
	ScheduleId string `json:"scheduleId,omitempty"`
	// Recurrence pattern of a schedule
	Recurrence []RecurrenceInfoReporting `json:"recurrence,omitempty"`
	// Type of report. Detailed reports include tables with data. Simple reports only include charts
	ViewType string `json:"viewType,omitempty"`
	// Set of optional attachments. Basically, every report email is in HTML format. Optionally, it can contain PDF or CSV files
	Attachments []AttachmentInfoReporting `json:"attachments,omitempty"`
	// List of pages to include to the report. If empty, all pages are included. Otherwise, only specified pages are included. API doesn't check validity of page names. Client application is responsible to do that
	Pages []string `json:"pages,omitempty"`
	// List of emails to which to send rendered reports
	Recipients []string `json:"recipients,omitempty"`
}

type ScimErrorResponse ¶ 

type ScimErrorResponse struct {
	// detail error message
	Detail  string   `json:"detail,omitempty"`
	Schemas []string `json:"schemas,omitempty"`
	// bad request type when status code is 400
	ScimType string `json:"scimType,omitempty"`
	// same as HTTP status code, e.g. 400, 401, etc.
	Status string `json:"status,omitempty"`
}

type ScimSearchRequestInfo ¶ 

type ScimSearchRequestInfo struct {
	// page size
	Count int32 `json:"count,omitempty"`
	// only support 'userName' or 'email' filter expressions for now
	Filter  string   `json:"filter,omitempty"`
	Schemas []string `json:"schemas,omitempty"`
	// start index (1-based)
	StartIndex int32 `json:"startIndex,omitempty"`
}

type ScimUserPatch ¶ 

type ScimUserPatch struct {
	// patch operations list
	Operations []PatchOperationInfo `json:"Operations"`
	Schemas    []string             `json:"schemas"`
}

type SearchUsersViaPostOpts ¶ 

type SearchUsersViaPostOpts struct {
	ScimSearchRequestInfo optional.Interface
}

type SecretQuestionInfo ¶ 

type SecretQuestionInfo struct {
	// Internal identifier of a question
	Id string `json:"id,omitempty"`
	// Internal identifier of a question type
	QuestionType int32 `json:"questionType,omitempty"`
	// Internal identifier of a question language
	LanguageId string `json:"languageId,omitempty"`
	// Text of a secret question shown to the end user
	QuestionText string `json:"questionText,omitempty"`
	// Specifies if the question is used during signup
	ShowInSignUp bool `json:"showInSignUp,omitempty"`
}

type SecretQuestionInfoResource ¶ 

type SecretQuestionInfoResource struct {
	Uri          string `json:"uri,omitempty"`
	Id           string `json:"id,omitempty"`
	QuestionType int32  `json:"questionType,omitempty"`
	LanguageId   int32  `json:"languageId,omitempty"`
	QuestionText string `json:"questionText,omitempty"`
	ShowInSignUp bool   `json:"showInSignUp,omitempty"`
}

type SecretQuestionInfoValidationRequest ¶ 

type SecretQuestionInfoValidationRequest struct {
	// Internal identifier of a secret question
	Id string `json:"id,omitempty"`
	// Answer to a secret question
	Answer string `json:"answer,omitempty"`
}

type SecretQuestionInfoVerificationRequest ¶ 

type SecretQuestionInfoVerificationRequest struct {
	// Internal identifier of a secret question
	Id string `json:"id,omitempty"`
	// Answer to a secret question
	Answer string `json:"answer,omitempty"`
}

type SecretQuestionsInfoResource ¶ 

type SecretQuestionsInfoResource struct {
	Uri        string                       `json:"uri,omitempty"`
	Records    []SecretQuestionInfoResource `json:"records,omitempty"`
	Paging     Paging                       `json:"paging,omitempty"`
	Navigation Navigation                   `json:"navigation,omitempty"`
}

type SecurityContext ¶ 

type SecurityContext struct {
	UserPrincipal        Principal `json:"userPrincipal,omitempty"`
	Secure               bool      `json:"secure,omitempty"`
	AuthenticationScheme string    `json:"authenticationScheme,omitempty"`
}

type SendFaxMessageOpts ¶ 

type SendFaxMessageOpts struct {
	Attachment    optional.Interface
	FaxResolution optional.String
	SendTime      optional.Time
	IsoCode       optional.String
	CoverIndex    optional.Int32
	CoverPageText optional.String
}

type SenderInfo ¶ 

type SenderInfo struct {
	// Phone number in E.164 (with '+' sign) format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Extension number
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	// Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)
	Location string `json:"location,omitempty"`
	// Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then
	Name string `json:"name,omitempty"`
}

type ServiceFeatureInfo ¶ 

type ServiceFeatureInfo struct {
	// Feature name, see all available values in Service Feature List
	FeatureName string `json:"featureName,omitempty"`
	// Feature status, shows feature availability for the extension
	Enabled bool `json:"enabled,omitempty"`
}

type ServiceFeatureValue ¶ 

type ServiceFeatureValue struct {
	FeatureName string `json:"featureName,omitempty"`
	Enabled     bool   `json:"enabled,omitempty"`
	Reason      string `json:"reason,omitempty"`
}

type ServiceInfo ¶ 

type ServiceInfo struct {
	// Canonical URI of a service info resource
	Uri               string                `json:"uri,omitempty"`
	BillingPlan       BillingPlanInfo       `json:"billingPlan,omitempty"`
	Brand             BrandInfo             `json:"brand,omitempty"`
	ServicePlan       ServicePlanInfo       `json:"servicePlan,omitempty"`
	TargetServicePlan TargetServicePlanInfo `json:"targetServicePlan,omitempty"`
}

type ServiceInfoRequest ¶ 

type ServiceInfoRequest struct {
	Limits AccountLimits `json:"limits,omitempty"`
}

type ServiceParameterResource ¶ 

type ServiceParameterResource struct {
	Id        string `json:"id,omitempty"`
	Value     string `json:"value,omitempty"`
	AccountId string `json:"accountId,omitempty"`
}

type ServicePlan ¶ 

type ServicePlan struct {
	Id      string `json:"id,omitempty"`
	Name    string `json:"name,omitempty"`
	Edition string `json:"edition,omitempty"`
}

type ServicePlanInfo ¶ 

type ServicePlanInfo struct {
	// Internal identifier of a service plan
	Id string `json:"id,omitempty"`
	// Name of a service plan
	Name string `json:"name,omitempty"`
	// Edition of a service plan
	Edition string `json:"edition,omitempty"`
}

type ServicePlanResource ¶ 

type ServicePlanResource struct {
	Uri             string                `json:"uri,omitempty"`
	Id              string                `json:"id,omitempty"`
	Name            string                `json:"name,omitempty"`
	Edition         string                `json:"edition,omitempty"`
	Brand           BrandResource         `json:"brand,omitempty"`
	Type            string                `json:"type,omitempty"`
	ServiceFeatures []ServiceFeatureValue `json:"serviceFeatures,omitempty"`
	Limits          AccountLimitsResource `json:"limits,omitempty"`
}

type ServiceProviderConfig ¶ 

type ServiceProviderConfig struct {
	AuthenticationSchemes AuthenticationSchemes `json:"authenticationSchemes,omitempty"`
	Bulk                  BulkSupported         `json:"bulk,omitempty"`
	ChangePassword        Supported             `json:"changePassword,omitempty"`
	Etag                  Supported             `json:"etag,omitempty"`
	Filter                FilterSupported       `json:"filter,omitempty"`
	Patch                 Supported             `json:"patch,omitempty"`
	Schemas               []string              `json:"schemas,omitempty"`
	Sort                  Supported             `json:"sort,omitempty"`
}

type SessionResource ¶ 

type SessionResource struct {
	Uri          string              `json:"uri,omitempty"`
	Id           string              `json:"id,omitempty"`
	AccountId    string              `json:"accountId,omitempty"`
	ExtensionId  string              `json:"extensionId,omitempty"`
	CreationTime time.Time           `json:"creationTime,omitempty"`
	ClientId     string              `json:"clientId,omitempty"`
	Application  ApplicationResource `json:"application,omitempty"`
}

type SessionsResource ¶ 

type SessionsResource struct {
	Uri     string              `json:"uri,omitempty"`
	Records []VersionedResource `json:"records,omitempty"`
}

type SetReportingSettingsRequest ¶ 

type SetReportingSettingsRequest struct {
	// List of 'View' structures with a tuple of filter values, pages and schedules
	Views []ViewInfoReporting `json:"views"`
}

type ShippingAddressInfo ¶ 

type ShippingAddressInfo struct {
	// Name of a receiver
	CustomerName string `json:"customerName,omitempty"`
	// Street address, line 1 - street address, P.O. box, company name, c/o
	Street string `json:"street,omitempty"`
	// Street address, line 2 - apartment, suite, unit, building, floor, etc.
	Street2 string `json:"street2,omitempty"`
	// City name
	City string `json:"city,omitempty"`
	// State/province name
	State string `json:"state,omitempty"`
	// Zip code
	Zip string `json:"zip,omitempty"`
	// Country name
	Country string `json:"country,omitempty"`
}

type ShippingInfo ¶ 

type ShippingInfo struct {
	// Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally it is changed to Shipped which means that distributor has shipped the device.
	Status string `json:"status,omitempty"`
	// Shipping carrier name. Appears only if the device status is  Shipped
	Carrier string `json:"carrier,omitempty"`
	// Carrier-specific tracking number. Appears only if the device status is  Shipped
	TrackingNumber string              `json:"trackingNumber,omitempty"`
	Method         MethodInfo          `json:"method"`
	Address        ShippingAddressInfo `json:"address"`
}

type ShippingMethod ¶ 

type ShippingMethod struct {
	// Internal identifier of the shipping method
	Id string `json:"id,omitempty"`
	// Name/description of the shipping method
	Name string `json:"name,omitempty"`
}

type ShippingOptionResource ¶ 

type ShippingOptionResource struct {
	Uri      string         `json:"uri,omitempty"`
	Method   ShippingMethod `json:"method,omitempty"`
	Quantity int32          `json:"quantity,omitempty"`
	Price    float64        `json:"price,omitempty"`
}

type ShippingOptionsResource ¶ 

type ShippingOptionsResource struct {
	Uri        string                   `json:"uri,omitempty"`
	Records    []ShippingOptionResource `json:"records,omitempty"`
	Paging     Paging                   `json:"paging,omitempty"`
	Navigation Navigation               `json:"navigation,omitempty"`
}

type ShippingResource ¶ 

type ShippingResource struct {
	Address        EmergencyServiceAddressResource `json:"address,omitempty"`
	Method         MethodResource                  `json:"method,omitempty"`
	Status         string                          `json:"status,omitempty"`
	Carrier        string                          `json:"carrier,omitempty"`
	TrackingNumber string                          `json:"trackingNumber,omitempty"`
}

type SignupInfoResource ¶ 

type SignupInfoResource struct {
	TosAccepted        bool     `json:"tosAccepted,omitempty"`
	SignupState        []string `json:"signupState,omitempty"`
	VerificationReason string   `json:"verificationReason,omitempty"`
}

type SimpleResource ¶ 

type SimpleResource struct {
	Uri                 string             `json:"uri,omitempty"`
	ResourceDescription string             `json:"resourceDescription,omitempty"`
	Id                  string             `json:"id,omitempty"`
	Ver                 ApiVersionResource `json:"ver,omitempty"`
}

type SipDetailsToRegister ¶ 

type SipDetailsToRegister struct {
	Transport string `json:"transport,omitempty"`
}

type SipFlags ¶ 

type SipFlags struct {
	VoipFeatureEnabled   bool `json:"voipFeatureEnabled,omitempty"`
	VoipCountryBlocked   bool `json:"voipCountryBlocked,omitempty"`
	OutboundCallsEnabled bool `json:"outboundCallsEnabled,omitempty"`
}

type SipFlagsRespones ¶ 

type SipFlagsRespones struct {
	// If 'True' VoIP calling feature is enabled
	VoipFeatureEnabled string `json:"voipFeatureEnabled,omitempty"`
	// If 'True' the request is sent from IP address of a country blocked for VoIP calling
	VoipCountryBlocked string `json:"voipCountryBlocked,omitempty"`
	// If 'True' outbound calls are enabled
	OutboundCallsEnabled string `json:"outboundCallsEnabled,omitempty"`
}

type SipInfo ¶ 

type SipInfo struct {
	Transport       string `json:"transport,omitempty"`
	Certificate     string `json:"certificate,omitempty"`
	Username        string `json:"username,omitempty"`
	Password        string `json:"password,omitempty"`
	AuthorizationId string `json:"authorizationId,omitempty"`
	Domain          string `json:"domain,omitempty"`
	OutboundProxy   string `json:"outboundProxy,omitempty"`
	WsProxy         string `json:"wsProxy,omitempty"`
}

type SipInfoRequest ¶ 

type SipInfoRequest struct {
	// Supported transport. SIP info will be returned for this transport if supported
	Transport string `json:"transport,omitempty"`
}

type SipInfoResource ¶ 

type SipInfoResource struct {
	Uri             string `json:"uri,omitempty"`
	Domain          string `json:"domain,omitempty"`
	OutboundProxy   string `json:"outboundProxy,omitempty"`
	UserName        string `json:"userName,omitempty"`
	Password        string `json:"password,omitempty"`
	AuthorizationId string `json:"authorizationId,omitempty"`
}

type SipInfoResponse ¶ 

type SipInfoResponse struct {
	// User credentials
	Username string `json:"username,omitempty"`
	// User password
	Password string `json:"password,omitempty"`
	// Identifier for SIP authorization
	AuthorizationId string `json:"authorizationId,omitempty"`
	// SIP domain
	Domain string `json:"domain,omitempty"`
	// SIP outbound proxy
	OutboundProxy string `json:"outboundProxy,omitempty"`
	// Preferred transport. SIP info will be returned for this transport if supported
	Transport string `json:"transport,omitempty"`
	// For TLS transport only Base64 encoded certificate
	Certificate string `json:"certificate,omitempty"`
}

type SiteInfo ¶ 

type SiteInfo struct {
	// Internal Identifier of a site
	Id string `json:"id,omitempty"`
	// custom name of a site
	Name string `json:"name,omitempty"`
}

type SmsResource ¶ 

type SmsResource struct {
	Country CountryResource `json:"country,omitempty"`
	To      []CallerInfo    `json:"to,omitempty"`
	From    CallerInfo      `json:"from,omitempty"`
	Text    string          `json:"text,omitempty"`
}

type SpecialNumberFeaturesInfo ¶ 

type SpecialNumberFeaturesInfo struct {
	Voip    OptionInfo `json:"voip,omitempty"`
	RingOut OptionInfo `json:"ringOut,omitempty"`
	Sms     OptionInfo `json:"sms,omitempty"`
	FaxOut  OptionInfo `json:"faxOut,omitempty"`
}

type SpecialNumberInfo ¶ 

type SpecialNumberInfo struct {
	// Service phone number in N11 code format
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Description of a special number
	Description string                    `json:"description,omitempty"`
	Features    SpecialNumberFeaturesInfo `json:"features"`
}

type StackTraceElement ¶ 

type StackTraceElement struct {
	MethodName   string `json:"methodName,omitempty"`
	FileName     string `json:"fileName,omitempty"`
	LineNumber   int32  `json:"lineNumber,omitempty"`
	ClassName    string `json:"className,omitempty"`
	NativeMethod bool   `json:"nativeMethod,omitempty"`
}

type StateResource ¶ 

type StateResource struct {
	Uri     string            `json:"uri,omitempty"`
	Id      string            `json:"id,omitempty"`
	Name    string            `json:"name,omitempty"`
	IsoCode string            `json:"isoCode,omitempty"`
	Country VersionedResource `json:"country,omitempty"`
}

type StatesResource ¶ 

type StatesResource struct {
	Uri        string          `json:"uri,omitempty"`
	Records    []StateResource `json:"records,omitempty"`
	Paging     Paging          `json:"paging,omitempty"`
	Navigation Navigation      `json:"navigation,omitempty"`
}

type StatusInfo ¶ 

type StatusInfo struct {
	Reason  string    `json:"reason,omitempty"`
	Till    time.Time `json:"till,omitempty"`
	Comment string    `json:"comment,omitempty"`
}

type StatusType ¶ 

type StatusType struct {
	Family       string `json:"family,omitempty"`
	StatusCode   int32  `json:"statusCode,omitempty"`
	ReasonPhrase string `json:"reasonPhrase,omitempty"`
}

type SubResource ¶ 

type SubResource struct {
	Uri                 string             `json:"uri,omitempty"`
	ResourceDescription string             `json:"resourceDescription,omitempty"`
	ParentId            int64              `json:"parentId,omitempty"`
	SubId               int64              `json:"subId,omitempty"`
	SubVer              ApiVersionResource `json:"subVer,omitempty"`
}

type SubscriptionInfo ¶ 

type SubscriptionInfo struct {
	// Internal identifier of a subscription
	Id string `json:"id,omitempty"`
	// Canonical URI of a subscription
	Uri string `json:"uri,omitempty"`
	// Collection of URIs to API resources (message-store/presence/detailed presence)
	EventFilters []string `json:"eventFilters,omitempty"`
	// Subscription expiration datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	ExpirationTime time.Time `json:"expirationTime,omitempty"`
	// Subscription lifetime in seconds. The default value is 900
	ExpiresIn int32 `json:"expiresIn,omitempty"`
	// Subscription status
	Status string `json:"status,omitempty"`
	// Subscription creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	CreationTime time.Time                `json:"creationTime,omitempty"`
	DeliveryMode NotificationDeliveryMode `json:"deliveryMode"`
}

type SubscriptionRequest ¶ 

type SubscriptionRequest struct {
	EventFilters []string             `json:"eventFilters,omitempty"`
	DeliveryMode DeliveryModeResource `json:"deliveryMode,omitempty"`
	ExpiresIn    int64                `json:"expiresIn,omitempty"`
}

type SubscriptionResponse ¶ 

type SubscriptionResponse struct {
	Uri             string                      `json:"uri,omitempty"`
	Id              string                      `json:"id,omitempty"`
	CreationTime    time.Time                   `json:"creationTime,omitempty"`
	Status          string                      `json:"status,omitempty"`
	EventFilters    []string                    `json:"eventFilters,omitempty"`
	ExpirationTime  time.Time                   `json:"expirationTime,omitempty"`
	ExpiresIn       int64                       `json:"expiresIn,omitempty"`
	DeliveryMode    DeliveryModeResource        `json:"deliveryMode,omitempty"`
	BlacklistedData NotificationBlacklistedData `json:"blacklistedData,omitempty"`
}

type Supported ¶ 

type Supported struct {
	Supported bool `json:"supported,omitempty"`
}

type SyncAccountCallLogOpts ¶ 

type SyncAccountCallLogOpts struct {
	SyncType    optional.Interface
	SyncToken   optional.String
	DateFrom    optional.String
	RecordCount optional.Int32
	StatusGroup optional.Interface
}

type SyncAddressBookOpts ¶ 

type SyncAddressBookOpts struct {
	SyncType  optional.Interface
	SyncToken optional.String
	PerPage   optional.Int32
	PageId    optional.Int32
}

type SyncCallLogRecords ¶ 

type SyncCallLogRecords struct {
	Uri      string                  `json:"uri,omitempty"`
	Records  []CallLogRecordResource `json:"records,omitempty"`
	SyncInfo SyncInfo                `json:"syncInfo,omitempty"`
}

type SyncExtensionCallLogOpts ¶ 

type SyncExtensionCallLogOpts struct {
	SyncType    optional.Interface
	SyncToken   optional.String
	DateFrom    optional.String
	RecordCount optional.Int32
	StatusGroup optional.Interface
}

type SyncInfo ¶ 

type SyncInfo struct {
	SyncType          string    `json:"syncType,omitempty"`
	SyncToken         string    `json:"syncToken,omitempty"`
	SyncTime          time.Time `json:"syncTime,omitempty"`
	OlderRecordsExist bool      `json:"olderRecordsExist,omitempty"`
}

type SyncInfoCallLog ¶ 

type SyncInfoCallLog struct {
	// Type of synchronization
	SyncType string `json:"syncType,omitempty"`
	// Synchronization token
	SyncToken string `json:"syncToken,omitempty"`
	// The last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	SyncTime time.Time `json:"syncTime,omitempty"`
}

type SyncInfoMessages ¶ 

type SyncInfoMessages struct {
	// Type of synchronization
	SyncType string `json:"syncType,omitempty"`
	// Synchronization token
	SyncToken string `json:"syncToken,omitempty"`
	// Last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	SyncTime time.Time `json:"syncTime,omitempty"`
}

type SyncMessages ¶ 

type SyncMessages struct {
	Uri      string                `json:"uri,omitempty"`
	Records  []MessageInfoResource `json:"records,omitempty"`
	SyncInfo SyncInfo              `json:"syncInfo,omitempty"`
}

type SyncMessagesOpts ¶ 

type SyncMessagesOpts struct {
	ConversationId        optional.Int32
	DateFrom              optional.String
	DateTo                optional.String
	Direction             optional.Interface
	DistinctConversations optional.Bool
	MessageType           optional.Interface
	RecordCount           optional.Int32
	SyncToken             optional.String
	SyncType              optional.Interface
}

type TargetServicePlanInfo ¶ 

type TargetServicePlanInfo struct {
	// Internal identifier of a target service plan
	Id string `json:"id,omitempty"`
	// Name of a target service plan
	Name string `json:"name,omitempty"`
}

type TaskInfo ¶ 

type TaskInfo struct {
	// Internal identifier of a task
	Id string `json:"id,omitempty"`
	// Link to a task resource
	Uri string `json:"uri,omitempty"`
	// Device order status
	Status string `json:"status,omitempty"`
	// Task creation time
	CreationTime time.Time `json:"creationTime,omitempty"`
	// Time of task last modification
	LastModifiedTime time.Time `json:"lastModifiedTime,omitempty"`
}

type TesterFlagsResource ¶ 

type TesterFlagsResource struct {
	Tester         bool `json:"tester,omitempty"`
	AutoDelete     bool `json:"autoDelete,omitempty"`
	NoBilling      bool `json:"noBilling,omitempty"`
	NoBillingLimit bool `json:"noBillingLimit,omitempty"`
}

type TimeInterval ¶ 

type TimeInterval struct {
	// Time in format hh:mm
	From time.Time `json:"from,omitempty"`
	// Time in format hh:mm
	To time.Time `json:"to,omitempty"`
}

type TimezoneInfo ¶ 

type TimezoneInfo struct {
	// Internal identifier of a timezone
	Id string `json:"id,omitempty"`
	// Canonical URI of a timezone
	Uri string `json:"uri,omitempty"`
	// Short name of a timezone
	Name string `json:"name,omitempty"`
	// Meaningful description of the timezone
	Description string `json:"description,omitempty"`
}

type TimezoneResource ¶ 

type TimezoneResource struct {
	Uri         string `json:"uri,omitempty"`
	Id          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

type TimezonesResource ¶ 

type TimezonesResource struct {
	Uri        string             `json:"uri,omitempty"`
	Records    []TimezoneResource `json:"records,omitempty"`
	Paging     Paging             `json:"paging,omitempty"`
	Navigation Navigation         `json:"navigation,omitempty"`
}

type TouchRequestResource ¶ 

type TouchRequestResource struct {
	RendererId string `json:"rendererId,omitempty"`
	MessageId  string `json:"messageId,omitempty"`
}

type TranscriptionResult ¶ 

type TranscriptionResult struct {
	STTId             string `json:"STTId,omitempty"`
	ExternalId        string `json:"ExternalId,omitempty"`
	Status            int32  `json:"Status,omitempty"`
	Mailbox           string `json:"Mailbox,omitempty"`
	TranscriptionText string `json:"TranscriptionText,omitempty"`
	Message           string `json:"Message,omitempty"`
	MessageLength     string `json:"MessageLength,omitempty"`
	Confidence        string `json:"Confidence,omitempty"`
}

type TransferredExtensionInfo ¶ 

type TransferredExtensionInfo struct {
	Extension ExtensionInfo `json:"extension,omitempty"`
}

type TransitionInfo ¶ 

type TransitionInfo struct {
	// Supported for account confirmation. Specifies whether welcome email is sent. The default value is 'True'
	SendWelcomeEmail bool `json:"sendWelcomeEmail,omitempty"`
	// Supported for account activation. Specifies whether confirmation email is sent. The default value is 'True'
	SendConfirmationEmail bool `json:"sendConfirmationEmail,omitempty"`
	// Specifies whether devices are shipped after successful account confirmation. The default value is 'True'
	ShipDevices bool `json:"shipDevices,omitempty"`
	// Supported for account confirmation. Activation email hash code
	ActivationEmailHash string `json:"activationEmailHash,omitempty"`
}

type Type ¶ 

type Type struct {
	TypeName string `json:"typeName,omitempty"`
}

type UnconditionalForwardingInfo ¶ 

type UnconditionalForwardingInfo struct {
	// Phone number to which the call is forwarded
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type UnconditionalForwardingResource ¶ 

type UnconditionalForwardingResource struct {
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type UpdateAccountRequest ¶ 

type UpdateAccountRequest struct {
	// Target account status. For account activation - 'Unconfirmed'. For account confirmation - 'Confirmed'. For changing account status - 'Confirmed' or 'Disabled' = ['Unconfirmed', 'Confirmed', 'Disabled'],
	Status         string            `json:"status,omitempty"`
	StatusInfo     AccountStatusInfo `json:"statusInfo,omitempty"`
	TransitionInfo TransitionInfo    `json:"transitionInfo,omitempty"`
	// Additional account identifier, developed and applied on the client side
	PartnerId        string             `json:"partnerId,omitempty"`
	ServiceInfo      AccountServiceInfo `json:"serviceInfo,omitempty"`
	RegionalSettings RegionalSettings   `json:"regionalSettings,omitempty"`
	// Identifier of extension to be set as operator for account
	OperatorId string             `json:"operatorId,omitempty"`
	SignupInfo SignupInfoResource `json:"signupInfo,omitempty"`
}

type UpdateAnsweringRuleRequest ¶ 

type UpdateAnsweringRuleRequest struct {
	// Name of an answering rule specified by user
	Name string `json:"name,omitempty"`
	// Specifies if an answering rule is active or inactive
	Enabled bool `json:"enabled,omitempty"`
	// Answering rules are applied when calls are received from specified caller(s)
	Callers []CallersInfo `json:"callers,omitempty"`
	// Answering rules are applied when calling to selected number(s)
	CalledNumbers []CalledNumberInfo `json:"calledNumbers,omitempty"`
	Schedule      ScheduleInfo       `json:"schedule,omitempty"`
	// Specifies how incoming calls are forwarded
	CallHandlingAction      string                      `json:"callHandlingAction,omitempty"`
	Forwarding              ForwardingInfo              `json:"forwarding,omitempty"`
	UnconditionalForwarding UnconditionalForwardingInfo `json:"unconditionalForwarding,omitempty"`
	Queue                   QueueInfo                   `json:"queue,omitempty"`
	Voicemail               VoicemailInfo               `json:"voicemail,omitempty"`
	// Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List
	Greetings []GreetingInfo `json:"greetings,omitempty"`
}

type UpdateBlockedNumberOpts ¶ 

type UpdateBlockedNumberOpts struct {
	BlockedNumberInfo optional.Interface
}

type UpdateConferencingInfoRequest ¶ 

type UpdateConferencingInfoRequest struct {
	// Multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic
	PhoneNumbers []ConferencePhoneNumberInfo `json:"phoneNumbers,omitempty"`
	// Determines if host user allows conference participants to join before the host
	AllowJoinBeforeHost bool `json:"allowJoinBeforeHost,omitempty"`
}

type UpdateContactOpts ¶ 

type UpdateContactOpts struct {
	PersonalContactResource optional.Interface
}

type UpdateForwardingNumberRequest ¶ 

type UpdateForwardingNumberRequest struct {
	// Forwarding/Call flip phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Forwarding/Call flip number title
	Label string `json:"label,omitempty"`
	// Number assigned to the call flip phone number, corresponds to the shortcut dial number
	FlipNumber string `json:"flipNumber,omitempty"`
}

type UpdateMessageRequest ¶ 

type UpdateMessageRequest struct {
	// Read status of a message to be changed. Multiple values are accepted
	ReadStatus string `json:"readStatus,omitempty"`
}

type UpdatePagingOnlyGroupUsersAndDevicesOpts ¶ 

type UpdatePagingOnlyGroupUsersAndDevicesOpts struct {
	EditPagingGroupRequest optional.Interface
}

type UpdateParkLocationUsersOpts ¶ 

type UpdateParkLocationUsersOpts struct {
	EditParkLocationRequest optional.Interface
}

type UpdatePresenceLinesRequest ¶ 

type UpdatePresenceLinesRequest struct {
	Records []PresenceLineInfo `json:"records,omitempty"`
}

type UpdatePresenceLinesResponse ¶ 

type UpdatePresenceLinesResponse struct {
	// Canonical URI of the monitored lines (extensions) resource
	Uri string `json:"uri,omitempty"`
	// List of lines (extensions) the presence of which is monitored by the user. The first two lines always indicate the user's extension presence, they cannot be changed
	Records    []LineInfo     `json:"records,omitempty"`
	Navigation NavigationInfo `json:"navigation,omitempty"`
	Paging     PagingInfo     `json:"paging,omitempty"`
}

type UpdateSubscriptionOpts ¶ 

type UpdateSubscriptionOpts struct {
	Aggregated optional.Bool
}

type UploadImageByPutFormOpts ¶ 

type UploadImageByPutFormOpts struct {
	Image optional.Interface
}

type UriTemplate ¶ 

type UriTemplate struct {
	Template                   string            `json:"template,omitempty"`
	Pattern                    PatternWithGroups `json:"pattern,omitempty"`
	TemplateVariables          []string          `json:"templateVariables,omitempty"`
	NumberOfExplicitRegexes    int32             `json:"numberOfExplicitRegexes,omitempty"`
	NumberOfRegexGroups        int32             `json:"numberOfRegexGroups,omitempty"`
	NumberOfExplicitCharacters int32             `json:"numberOfExplicitCharacters,omitempty"`
	NumberOfTemplateVariables  int32             `json:"numberOfTemplateVariables,omitempty"`
}

type UrnInfoRequest ¶ 

type UrnInfoRequest struct {
	// Name of department (call queue) member
	Department string `json:"department,omitempty"`
}

type UserBusinessHoursScheduleInfo ¶ 

type UserBusinessHoursScheduleInfo struct {
	WeeklyRanges WeeklyScheduleInfo `json:"weeklyRanges,omitempty"`
}

type UserBusinessHoursUpdate ¶ 

type UserBusinessHoursUpdate struct {
	// Canonical URI of a business-hours resource
	Uri      string                        `json:"uri,omitempty"`
	Schedule UserBusinessHoursScheduleInfo `json:"schedule,omitempty"`
}

type UserBusinessHoursUpdateRequest ¶ 

type UserBusinessHoursUpdateRequest struct {
	Schedule WeeklyScheduleInfo `json:"schedule,omitempty"`
}

type UserCallLogRecord ¶ 

type UserCallLogRecord struct {
	// Internal identifier of a cal log record
	Id string `json:"id,omitempty"`
	// Canonical URI of a call log record
	Uri string `json:"uri,omitempty"`
	// Internal identifier of a call session
	SessionId string            `json:"sessionId,omitempty"`
	From      CallLogCallerInfo `json:"from,omitempty"`
	To        CallLogCallerInfo `json:"to,omitempty"`
	// Call type = ['Voice', 'Fax']
	Type string `json:"type,omitempty"`
	// Call direction = ['Inbound', 'Outbound']
	Direction string `json:"direction,omitempty"`
	// The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
	StartTime string `json:"startTime,omitempty"`
	// Call duration in seconds
	Duration  int32         `json:"duration,omitempty"`
	Recording RecordingInfo `json:"recording,omitempty"`
}

type UserContactsApiService ¶ 

type UserContactsApiService service

func (*UserContactsApiService) ContactFavorite ¶ 

func (a *UserContactsApiService) ContactFavorite(ctx context.Context, accountId string, extensionId string) (*http.Response, error)

UserContactsApiService Get Favorite Contacts

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

func (*UserContactsApiService) CreateContact ¶ 

func (a *UserContactsApiService) CreateContact(ctx context.Context, accountId string, extensionId string, localVarOptionals *CreateContactOpts) (PersonalContactResource, *http.Response, error)

func (*UserContactsApiService) CreateContacts ¶ 

func (a *UserContactsApiService) CreateContacts(ctx context.Context, accountId string, extensionId string, localVarOptionals *CreateContactsOpts) (*http.Response, error)

func (*UserContactsApiService) DeleteContact ¶ 

func (a *UserContactsApiService) DeleteContact(ctx context.Context, accountId string, extensionId string, contactId int32) (*http.Response, error)

UserContactsApiService Delete Contact(s) by ID <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Contacts</td><td>Creating, viewing, editing and deleting user personal contacts</td></tr><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param contactId Internal identifier of a contact record in the RingCentral database

func (*UserContactsApiService) ListContacts ¶ 

func (a *UserContactsApiService) ListContacts(ctx context.Context, accountId string, extensionId string, localVarOptionals *ListContactsOpts) (ContactList, *http.Response, error)

func (*UserContactsApiService) LoadContact ¶ 

func (a *UserContactsApiService) LoadContact(ctx context.Context, accountId string, extensionId string, contactId int32) (PersonalContactResource, *http.Response, error)

UserContactsApiService Get Contact(s) by ID <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param contactId Internal identifier of a contact record in the RingCentral database

@return PersonalContactResource

func (*UserContactsApiService) SyncAddressBook ¶ 

func (a *UserContactsApiService) SyncAddressBook(ctx context.Context, accountId string, extensionId string, localVarOptionals *SyncAddressBookOpts) (AddressBookSync, *http.Response, error)

func (*UserContactsApiService) UpdateContact ¶ 

func (a *UserContactsApiService) UpdateContact(ctx context.Context, accountId string, extensionId string, contactId int32, localVarOptionals *UpdateContactOpts) (PersonalContactResource, *http.Response, error)

type UserCreationRequest ¶ 

type UserCreationRequest struct {
	// Status of a user
	Active bool `json:"active,omitempty"`
	// User addresses
	Addresses []AddressInfo `json:"addresses,omitempty"`
	// User email addresses
	Emails []EmailInfo `json:"emails"`
	// External identifier of a user
	ExternalId string `json:"externalId,omitempty"`
	// Internal identifier of a user
	Id   string   `json:"id,omitempty"`
	Name NameInfo `json:"name"`
	// User phone numbers
	PhoneNumbers []PhoneNumberInfoRequest `json:"phoneNumbers,omitempty"`
	Photos       []PhotoInfo              `json:"photos,omitempty"`
	// Specification links
	Schemas                                           []string       `json:"schemas"`
	Urnietfparamsscimschemasextensionenterprise20User EnterpriseUser `json:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,omitempty"`
	// User mailbox. Must be same as work type email address
	UserName string `json:"userName"`
}

type UserGroupBulkAssignResource ¶ 

type UserGroupBulkAssignResource struct {
	Items []BulkAssignItem `json:"items,omitempty"`
}

type UserGroupIdResource ¶ 

type UserGroupIdResource struct {
	Uri string `json:"uri,omitempty"`
	Id  string `json:"id,omitempty"`
}

type UserGroupManagerResource ¶ 

type UserGroupManagerResource struct {
	Uri             string `json:"uri,omitempty"`
	Id              string `json:"id,omitempty"`
	ExtensionNumber string `json:"extensionNumber,omitempty"`
	FirstName       string `json:"firstName,omitempty"`
	LastName        string `json:"lastName,omitempty"`
}

type UserGroupResource ¶ 

type UserGroupResource struct {
	Uri         string                     `json:"uri,omitempty"`
	Id          string                     `json:"id,omitempty"`
	DisplayName string                     `json:"displayName,omitempty"`
	Description string                     `json:"description,omitempty"`
	Managers    []UserGroupManagerResource `json:"managers,omitempty"`
	Members     []ExtensionIdResource      `json:"members,omitempty"`
}

type UserInfo ¶ 

type UserInfo struct {
	// Status of a user
	Active bool `json:"active,omitempty"`
	// User addresses
	Addresses []AddressInfo `json:"addresses,omitempty"`
	// User email addresses
	Emails []EmailInfo `json:"emails,omitempty"`
	// External identifier of a user
	ExternalId string `json:"externalId,omitempty"`
	// Internal identifier of a user
	Id   string   `json:"id,omitempty"`
	Name NameInfo `json:"name,omitempty"`
	// User phone numbers
	PhoneNumbers []PhoneNumberInfoRequest `json:"phoneNumbers,omitempty"`
	Photos       []PhotoInfo              `json:"photos,omitempty"`
	// Specification links
	Schemas                                           []string       `json:"schemas,omitempty"`
	Urnietfparamsscimschemasextensionenterprise20User EnterpriseUser `json:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,omitempty"`
	// User mailbox. Must be same as work type email address
	UserName string   `json:"userName,omitempty"`
	Meta     MetaInfo `json:"meta,omitempty"`
}

type UserPresencePermissionsUpdateRequest ¶ 

type UserPresencePermissionsUpdateRequest struct {
	Extensions []PresencePermissionsExtensionInfoRequest `json:"extensions,omitempty"`
}

type UserSettingsApiService ¶ 

type UserSettingsApiService service

func (*UserSettingsApiService) DeleteExtension ¶ 

func (a *UserSettingsApiService) DeleteExtension(ctx context.Context, extensionId string, accountId string) (*http.Response, error)

UserSettingsApiService Delete Extension <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Deletes extension(s) by ID(s).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param extensionId
  • @param accountId

func (*UserSettingsApiService) DownloadImage ¶ 

func (a *UserSettingsApiService) DownloadImage(ctx context.Context, extensionId string, accountId string) (Binary, *http.Response, error)

UserSettingsApiService Get User Profile Image <p style='font-style:italic;'>Since 1.0.20 (Release 7.4)</p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param extensionId
  • @param accountId

@return Binary

func (*UserSettingsApiService) GetNotificationSettings ¶ 

func (a *UserSettingsApiService) GetNotificationSettings(ctx context.Context, accountId string, extensionId string) (NotificationSettings, *http.Response, error)

UserSettingsApiService Get Notification Settings <p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Returns notification settings for the current extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return NotificationSettings

func (*UserSettingsApiService) ListExtensionGrants ¶ 

func (a *UserSettingsApiService) ListExtensionGrants(ctx context.Context, accountId string, extensionId string, localVarOptionals *ListExtensionGrantsOpts) (GetExtensionGrantListResponse, *http.Response, error)

func (*UserSettingsApiService) ListSecretQuestions ¶ 

func (a *UserSettingsApiService) ListSecretQuestions(ctx context.Context, localVarOptionals *ListSecretQuestionsOpts) (GetSecretQuestionListResponse, *http.Response, error)

func (*UserSettingsApiService) LoadConferencingInfo ¶ 

func (a *UserSettingsApiService) LoadConferencingInfo(ctx context.Context, accountId string, extensionId string, localVarOptionals *LoadConferencingInfoOpts) (GetConferencingInfoResponse, *http.Response, error)

func (*UserSettingsApiService) LoadExtensionCallerId ¶ 

func (a *UserSettingsApiService) LoadExtensionCallerId(ctx context.Context, accountId string, extensionId string) (ExtensionCallerIdInfo, *http.Response, error)

UserSettingsApiService Get Extension Caller ID <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns information on an outbound caller ID of an extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return ExtensionCallerIdInfo

func (*UserSettingsApiService) LoadExtensionInfo ¶ 

func (a *UserSettingsApiService) LoadExtensionInfo(ctx context.Context, accountId string, extensionId string) (GetExtensionInfoResponse, *http.Response, error)

UserSettingsApiService Get Extension Info <p style='font-style:italic;'>Since 1.0.0</p><p>Returns basic information about a particular extension of an account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return GetExtensionInfoResponse

func (*UserSettingsApiService) LoadExtensionProfileImage ¶ 

func (a *UserSettingsApiService) LoadExtensionProfileImage(ctx context.Context, accountId string, extensionId string, scaleSize string) (Binary, *http.Response, error)

UserSettingsApiService Get Extension Profile Image (Scaled) <p style='font-style:italic;'></p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param scaleSize Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then

@return Binary

func (*UserSettingsApiService) LoadExtensionUserCredentials ¶ 

func (a *UserSettingsApiService) LoadExtensionUserCredentials(ctx context.Context, accountId string, extensionId string) (ExtensionUserCredentials, *http.Response, error)

UserSettingsApiService Get User Credentials <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Returns extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

@return ExtensionUserCredentials

func (*UserSettingsApiService) LoadSecretQuestion ¶ 

func (a *UserSettingsApiService) LoadSecretQuestion(ctx context.Context, questionId int32) (SecretQuestionInfo, *http.Response, error)

UserSettingsApiService Get Secret Question <p style='font-style:italic;'>Since 1.0.20 (Release 7.4)</p><p>Returns a particular secret question in specific language by question ID.</p><h4>Usage Plan Group</h4><p>Light</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param questionId Internal identifier of a question

@return SecretQuestionInfo

func (*UserSettingsApiService) UpdateConferencingInfo ¶ 

func (a *UserSettingsApiService) UpdateConferencingInfo(ctx context.Context, accountId string, extensionId string, updateConferencingInfoRequest UpdateConferencingInfoRequest) (GetConferencingInfoResponse, *http.Response, error)

UserSettingsApiService Update User Conferencing Settings <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param updateConferencingInfoRequest JSON body

@return GetConferencingInfoResponse

func (*UserSettingsApiService) UpdateExtension ¶ 

func (a *UserSettingsApiService) UpdateExtension(ctx context.Context, accountId string, extensionId string, extensionUpdateRequest ExtensionUpdateRequest) (GetExtensionInfoResponse, *http.Response, error)

UserSettingsApiService Update Extension <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param extensionUpdateRequest JSON body

@return GetExtensionInfoResponse

func (*UserSettingsApiService) UpdateExtensionCallerId ¶ 

func (a *UserSettingsApiService) UpdateExtensionCallerId(ctx context.Context, accountId string, extensionId string, extensionCallerIdInfo ExtensionCallerIdInfo) (ExtensionCallerIdInfo, *http.Response, error)

UserSettingsApiService Update Extension Caller ID <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates outbound caller ID information of an extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param extensionCallerIdInfo JSON body

@return ExtensionCallerIdInfo

func (*UserSettingsApiService) UpdateExtensionUserCredentials ¶ 

func (a *UserSettingsApiService) UpdateExtensionUserCredentials(ctx context.Context, accountId string, extensionId string, extensionUserCredentailsRequest ExtensionUserCredentailsRequest) (ExtensionUserCredentials, *http.Response, error)

UserSettingsApiService Update User Credentials <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Updates extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param extensionUserCredentailsRequest JSON body

@return ExtensionUserCredentials

func (*UserSettingsApiService) UpdateNotificationSettings ¶ 

func (a *UserSettingsApiService) UpdateNotificationSettings(ctx context.Context, accountId string, extensionId int32, notificationSettingsUpdateRequest NotificationSettingsUpdateRequest) (NotificationSettings, *http.Response, error)

UserSettingsApiService Update Notification Settings <p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Updates notification settings for the current extension.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param notificationSettingsUpdateRequest

@return NotificationSettings

func (*UserSettingsApiService) UploadImageByPostForm ¶ 

func (a *UserSettingsApiService) UploadImageByPostForm(ctx context.Context, extensionId string, accountId string, image *os.File) (Binary, *http.Response, error)

UserSettingsApiService Upload User Profile Image <p style='font-style:italic;'>Since 1.0.26 (Release 8.2)</p><p>Returns the extension profile image.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param extensionId
  • @param accountId
  • @param image

@return Binary

func (*UserSettingsApiService) UploadImageByPutForm ¶ 

func (a *UserSettingsApiService) UploadImageByPutForm(ctx context.Context, extensionId string, accountId string, localVarOptionals *UploadImageByPutFormOpts) (Binary, *http.Response, error)

func (*UserSettingsApiService) ValidateExtensionUserCredentials ¶ 

func (a *UserSettingsApiService) ValidateExtensionUserCredentials(ctx context.Context, accountId string, extensionId string, validateExtensionUserCredentials ValidateExtensionUserCredentials) (*http.Response, error)

UserSettingsApiService Validate User Credentials <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Validates if extension user credentials specified can be applied.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param validateExtensionUserCredentials JSON body

func (*UserSettingsApiService) VerifyExtensionUserCredentials ¶ 

func (a *UserSettingsApiService) VerifyExtensionUserCredentials(ctx context.Context, accountId string, extensionId string, verifyExtensionUserCredentials VerifyExtensionUserCredentials) (*http.Response, error)

UserSettingsApiService Verify Extension User Credentials <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Verifies current extension user credentials.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditExtensions</td><td>Viewing and updating my extension info (includes extension name, number, email and phone number)</td></tr></tbody></table><h4>API Group</h4><p>Medium</p>

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
  • @param extensionId Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
  • @param verifyExtensionUserCredentials JSON body

type UserUpdateRequest ¶ 

type UserUpdateRequest struct {
	// Status of a user
	Active bool `json:"active,omitempty"`
	// User addresses
	Addresses []AddressInfo `json:"addresses,omitempty"`
	// User email addresses
	Emails []EmailInfo `json:"emails"`
	// External identifier of a user
	ExternalId string `json:"externalId,omitempty"`
	// Internal identifier of a user
	Id   string   `json:"id,omitempty"`
	Name NameInfo `json:"name"`
	// User phone numbers
	PhoneNumbers []PhoneNumberInfoRequest `json:"phoneNumbers,omitempty"`
	Photos       []PhotoInfo              `json:"photos,omitempty"`
	// Specification links
	Schemas                                           []string       `json:"schemas"`
	Urnietfparamsscimschemasextensionenterprise20User EnterpriseUser `json:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,omitempty"`
	// User mailbox. Must be same as work type email address
	UserName string `json:"userName"`
}

type ValidateExtensionUserCredentials ¶ 

type ValidateExtensionUserCredentials struct {
	// User password of an extension
	Password string `json:"password,omitempty"`
	// User pin of an extension
	IvrPin         string                              `json:"ivrPin,omitempty"`
	SecretQuestion SecretQuestionInfoValidationRequest `json:"secretQuestion,omitempty"`
}

type VerifyExtensionUserCredentials ¶ 

type VerifyExtensionUserCredentials struct {
	// User password of an extension
	Password string `json:"password,omitempty"`
	// User pin of an extension
	IvrPin         string                                `json:"ivrPin,omitempty"`
	SecretQuestion SecretQuestionInfoVerificationRequest `json:"secretQuestion,omitempty"`
}

type VersionInfo ¶ 

type VersionInfo struct {
	// Canonical URI of API versions
	Uri string `json:"uri,omitempty"`
	// Version of the RingCentral REST API
	VersionString string `json:"versionString,omitempty"`
	// Release date of this version
	ReleaseDate string `json:"releaseDate,omitempty"`
	// URI part determining the current version
	UriString string `json:"uriString,omitempty"`
}

type VersionedResource ¶ 

type VersionedResource struct {
	Uri string `json:"uri,omitempty"`
}

type VersioningResource ¶ 

type VersioningResource struct {
	Uri                 string             `json:"uri,omitempty"`
	ResourceDescription string             `json:"resourceDescription,omitempty"`
	Id                  string             `json:"id,omitempty"`
	Ver                 ApiVersionResource `json:"ver,omitempty"`
}

type ViewInfoReporting ¶ 

type ViewInfoReporting struct {
	// User-defined name of a 'View'. The maximum value is 255
	Name string `json:"name"`
	// List of pages, the max amount is 10
	Pages []PagesInfoReporting `json:"pages"`
	// List of schedules, the max amount is 5. Each 'View' may have several schedules for reporting. For example, customer may want to get daily and weekly reports with the same set of settings
	Schedules []SchedulesInfoReporting `json:"schedules,omitempty"`
}

type VoicemailInfo ¶ 

type VoicemailInfo struct {
	// If 'True' then voicemails are allowed to be received
	Enabled   bool          `json:"enabled,omitempty"`
	Recipient RecipientInfo `json:"recipient,omitempty"`
}

type VoicemailSettingsResource ¶ 

type VoicemailSettingsResource struct {
	Enabled   bool              `json:"enabled,omitempty"`
	Recipient ExtensionResource `json:"recipient,omitempty"`
}

type VoicemailsInfo ¶ 

type VoicemailsInfo struct {
	// Email notification flag
	NotifyByEmail bool `json:"notifyByEmail,omitempty"`
	// SMS notification flag
	NotifyBySms bool `json:"notifyBySms,omitempty"`
	// List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedEmailAddresses []string `json:"advancedEmailAddresses,omitempty"`
	// List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only
	AdvancedSmsEmailAddresses []string `json:"advancedSmsEmailAddresses,omitempty"`
	// Indicates whether voicemail should be attached to email
	IncludeAttachment bool `json:"includeAttachment,omitempty"`
	// Indicates whether email should be automatically marked as read
	MarkAsRead bool `json:"markAsRead,omitempty"`
}

type WebUrisResource ¶ 

type WebUrisResource struct {
	ExpressSetupMobile            string `json:"expressSetupMobile,omitempty"`
	SignUp                        string `json:"signUp,omitempty"`
	Support                       string `json:"support,omitempty"`
	MeetingsAppDownload           string `json:"meetingsAppDownload,omitempty"`
	MobileWebUsers                string `json:"mobileWebUsers,omitempty"`
	MobileWebBilling              string `json:"mobileWebBilling,omitempty"`
	MobileWebPhoneSystem          string `json:"mobileWebPhoneSystem,omitempty"`
	MobileWebUserSettings         string `json:"mobileWebUserSettings,omitempty"`
	MobileWebTellAFriend          string `json:"mobileWebTellAFriend,omitempty"`
	MobileWebChangePassword       string `json:"mobileWebChangePassword,omitempty"`
	MobileWebInternationalCalling string `json:"mobileWebInternationalCalling,omitempty"`
	MobileWebCallHandling         string `json:"mobileWebCallHandling,omitempty"`
	MobileWebNotifications        string `json:"mobileWebNotifications,omitempty"`
	MobileWebReporting            string `json:"mobileWebReporting,omitempty"`
	MobileWebResetPassword        string `json:"mobileWebResetPassword,omitempty"`
	MobileWebTrialUpgrade         string `json:"mobileWebTrialUpgrade,omitempty"`
	ServiceWebHome                string `json:"serviceWebHome,omitempty"`
	ServiceWebPhoneSystem         string `json:"serviceWebPhoneSystem,omitempty"`
	ServiceWebUserSettings        string `json:"serviceWebUserSettings,omitempty"`
	ServiceWebBilling             string `json:"serviceWebBilling,omitempty"`
	ServiceWebTellAFriend         string `json:"serviceWebTellAFriend,omitempty"`
	ServiceWebChangePassword      string `json:"serviceWebChangePassword,omitempty"`
	ServiceWebResetPassword       string `json:"serviceWebResetPassword,omitempty"`
	AppDownload                   string `json:"appDownload,omitempty"`
	AppDownloadFile               string `json:"appDownloadFile,omitempty"`
	ExpiresIn                     int64  `json:"expiresIn,omitempty"`
	Eula                          string `json:"eula,omitempty"`
	EmergencyDisclaimer           string `json:"emergencyDisclaimer,omitempty"`
}

type WeeklyScheduleInfo ¶ 

type WeeklyScheduleInfo struct {
	// Time intervals for a particular day
	Monday []TimeInterval `json:"monday,omitempty"`
	// Time intervals for a particular day
	Tuesday []TimeInterval `json:"tuesday,omitempty"`
	// Time intervals for a particular day
	Wednesday []TimeInterval `json:"wednesday,omitempty"`
	// Time intervals for a particular day
	Thursday []TimeInterval `json:"thursday,omitempty"`
	// Time intervals for a particular day
	Friday []TimeInterval `json:"friday,omitempty"`
	// Time intervals for a particular day
	Saturday []TimeInterval `json:"saturday,omitempty"`
	// Time intervals for a particular day
	Sunday []TimeInterval `json:"sunday,omitempty"`
}

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.