ringcentral

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

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().

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)

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

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