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, tracing, etc. @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, tracing, etc. @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, tracing, etc. @return

func (*AccountProvisioningApiService) BulkAssign ¶

func (a *AccountProvisioningApiService) BulkAssign(ctx context.Context, accountId string, localVarOptionals map[string]interface{}) (*http.Response, error)

AccountProvisioningApiService Edit Call Queue Members

<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes multiple call queue members.</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, tracing, etc. @param accountId @param optional (nil or map[string]interface{}) with one or more of:

@param "body" (DepartmentBulkAssignResource)

@return

func (*AccountProvisioningApiService) CreateAccount ¶

func (a *AccountProvisioningApiService) CreateAccount(ctx context.Context, body 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, tracing, etc. @param body JSON body @return GetAccountInfoResponse

func (*AccountProvisioningApiService) CreateDeviceOrder ¶

func (a *AccountProvisioningApiService) CreateDeviceOrder(ctx context.Context, accountId string, localVarOptionals map[string]interface{}) (DeviceOrderCreation, *http.Response, error)

AccountProvisioningApiService Create Device Order

<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>Heavy</p> * @param ctx context.Context for authentication, logging, tracing, etc. @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session @param optional (nil or map[string]interface{}) with one or more of:

@param "async" (bool) Specifies whether a client expects order details to be returned or not. If 'True' the server returns a link for tracking order status without waiting for it to be actually created. If 'False' the server returns order details once it is created - it may take some time depending on device count. The default value is 'False'
@param "body" (DeviceResource)

@return DeviceOrderCreation

func (*AccountProvisioningApiService) CreateLicensesOrder ¶

func (a *AccountProvisioningApiService) CreateLicensesOrder(ctx context.Context, accountId string, body 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, tracing, etc. @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session @param body JSON body @return

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, tracing, etc. @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

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, tracing, etc. @param phoneNumberId @param accountId @return

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, tracing, etc. @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, tracing, etc. @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, tracing, etc. @param accountId @return BulkProvisionUnassignedExtensionsResponseResource

func (*AccountProvisioningApiService) GetPagingOnlyGroupDevices ¶

func (a *AccountProvisioningApiService) GetPagingOnlyGroupDevices(ctx context.Context, accountId string, pagingOnlyGroupId string, localVarOptionals map[string]interface{}) (PagingOnlyGroupDevices, *http.Response, error)

AccountProvisioningApiService Get Paging Only Group Devices

<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of paging devices assigned to this group.</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, tracing, etc. @param accountId @param pagingOnlyGroupId @param optional (nil or map[string]interface{}) with one or more of:

@param "page" (int32) Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
@param "perPage" (int32) Indicates the page size (number of items). If not specified, the value is '100' by default

@return PagingOnlyGroupDevices

func (*AccountProvisioningApiService) GetPagingOnlyGroupUsers ¶

func (a *AccountProvisioningApiService) GetPagingOnlyGroupUsers(ctx context.Context, accountId string, pagingOnlyGroupId string, localVarOptionals map[string]interface{}) (PagingOnlyGroupUsers, *http.Response, error)

AccountProvisioningApiService Get Paging Only Group Users

<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of users allowed to page this group.</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, tracing, etc. @param accountId @param pagingOnlyGroupId @param optional (nil or map[string]interface{}) with one or more of:

@param "page" (int32) Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
@param "perPage" (int32) Indicates the page size (number of items). If not specified, the value is '100' by default

@return PagingOnlyGroupUsers

func (*AccountProvisioningApiService) GetParkLocationUsers ¶

func (a *AccountProvisioningApiService) GetParkLocationUsers(ctx context.Context, accountId string, parkLocationId string, localVarOptionals map[string]interface{}) (ParkLocationResponse, *http.Response, error)

AccountProvisioningApiService Get Park Location Users

<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Returns the list of users allowed to park and unpark calls to/from the park location extension specified</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, tracing, etc. @param accountId @param parkLocationId @param optional (nil or map[string]interface{}) with one or more of:

@param "page" (int32) Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
@param "perPage" (int32) Indicates the page size (number of items). If not specified, the value is '100' by default

@return ParkLocationResponse

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, tracing, etc. @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, tracing, etc. @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 map[string]interface{}) (AccountPhoneNumbers, *http.Response, error)

AccountProvisioningApiService Get All Company Phone 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>Heavy</p> * @param ctx context.Context for authentication, logging, tracing, etc. @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session @param optional (nil or map[string]interface{}) with one or more of:

@param "page" (int32) Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
@param "perPage" (int32) Indicates the page size (number of items). If not specified, the value is '100' by default
@param "usageType" ([]string) Usage type of the phone number

@return AccountPhoneNumbers

func (*AccountProvisioningApiService) ListDepartmentMembers ¶

func (a *AccountProvisioningApiService) ListDepartmentMembers(ctx context.Context, accountId string, departmentId int32, localVarOptionals map[string]interface{}) (DepartmentMemberList, *http.Response, error)

AccountProvisioningApiService Get Department Member List

<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, tracing, etc. @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session @param departmentId Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid) @param optional (nil or map[string]interface{}) with one or more of:

@param "page" (int32) Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
@param "perPage" (int32) Indicates the page size (number of items). If not specified, the value is '100' by default

@return DepartmentMemberList

func (*AccountProvisioningApiService) ListExtensionDevices ¶

func (a *AccountProvisioningApiService) ListExtensionDevices(ctx context.Context, accountId string, extensionId string, localVarOptionals map[string]interface{}) (GetExtensionDevicesResponse, *http.Response, error)

AccountProvisioningApiService Get User Device Info

<p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns all the devices for extension(s) by extension 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'>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, tracing, etc. @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 optional (nil or map[string]interface{}) with one or more of:

@param "linePooling" (string) Pooling type of a device

@return GetExtensionDevicesResponse

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, tracing, etc. @return LicenseTypes

func (*AccountProvisioningApiService) ListLicenses ¶

func (a *AccountProvisioningApiService) ListLicenses(ctx context.Context, accountId string, localVarOptionals map[string]interface{}) (LicenseList, *http.Response, error)

AccountProvisioningApiService Get License List

<p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns list of licenses for a specific user.</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, tracing, etc. @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session @param optional (nil or map[string]interface{}) with one or more of:

@param "page" (int64) Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1'
@param "perPage" (int64) Indicates the page size (number of items). If not specified, the value is '25' by default
@param "typeId" (int64) Internal identifier of a license type. If not specified account licenses of all types are returned

@return LicenseList

func (*AccountProvisioningApiService) ListShippingOptions ¶

func (a *AccountProvisioningApiService) ListShippingOptions(ctx context.Context, localVarOptionals map[string]interface{}) (DictionaryShippingOptions, *http.Response, error)

AccountProvisioningApiService Get Shipping Options

<p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Returns the list of device shipping options with their prices, according to brand, tier, number of ordered devices.</p><h4>Usage Plan Group</h4><p>Light</p> * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of:

@param "servicePlanId" (int32)
@param "brandId" (int32)
@param "quantity" (int32)

@return DictionaryShippingOptions

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, tracing, etc. @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, tracing, etc. @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, tracing, etc. @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, tracing, etc. @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 map[string]interface{}) (PhoneNumbers, *http.Response, error)

AccountProvisioningApiService Get Numbers

<p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the required numbers filtered by criteria.</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, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of:

@param "areaCode" (int32) Area code of the location
@param "countryCode" (string) Two-letter country code, complying with the ISO standard
@param "countryId" (string) Internal identifier of a country; '1'- the US; '39' - Canada; '224' - the UK. The default value is '1'
@param "exclude" (string) A string of digits (one and more) that should not appear among the last four digits (line part) of the phone numbers that will be returned. It is possible to specify severalT?exclude parameters. If specified, it is taken into account in all returned phone numbers both in the phone numbers satisfying to parameters of lookup and in alternative phone numbers (in case when extendedSearch is specified)
@param "extendedSearch" (bool) If the value is 'False', then the returned numbers exactly correspond to the specified NXX, NPA and LINE or countryCode, areaCode and numberPattern parameters. If the value is 'True', then the resulting numbers are ranked and returned with the rank attribute values (1-10). The default value is 'False'
@param "line" (string) LINE pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 4 characters)
@param "numberPattern" (string) Phone number pattern (for wildcard or vanity search). For NANP countries (US, Canada) is concatenation of nxx (the first three digits) and line. If the first three characters are specified as not digits (e.g. 5** or CAT) then parameter extendedSearch will be ignored.
@param "nxx" (string) NXX pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 3 characters)
@param "npa" (string) Area code (mandatory). For example, 800, 844, 855, 866, 877, 888 for North America; and 647 for Canada
@param "paymentType" ([]string) Payment type. Default is 'Local' (it should correlate with the npa provided)
@param "perPage" (int32) Indicates the page size (number of items). If not specified, the value is '10' by default
@param "providerId" (int32) Internal identifier of a phone number provider. Supported if brand is specified. If specified, area code and nxx are optional
@param "smsEnabled" (bool) Specifies if SMS activation is available for the number. If specified, it is taken into account in all returned phone numbers both in the phone numbers satisfying to parameters of lookup and in alternative phone numbers (in case when extendedSearch is specified). If not specified, the value is null.

@return PhoneNumbers

func (*AccountProvisioningApiService) ParsePhoneNumber ¶

func (a *AccountProvisioningApiService) ParsePhoneNumber(ctx context.Context, body ParsePhoneNumberRequest, localVarOptionals map[string]interface{}) (ParsePhoneNumberResponse, *http.Response, error)

AccountProvisioningApiService Parse Phone Number

<p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns one or more parsed and/or formatted phone numbers that are passed as a string.</p><h4>Usage Plan Group</h4><p>Light</p> * @param ctx context.Context for authentication, logging, tracing, etc. @param body JSON body @param optional (nil or map[string]interface{}) with one or more of:

@param "homeCountry" (string) Internal identifier of a home country. The default value is ISO code (ISO 3166) of the user's home country or brand country, if the user is undefined
@param "nationalAsPriority" (bool) The default value is 'False'. If 'True', the numbers that are closer to the home country are given higher priority

@return ParsePhoneNumberResponse

func (*AccountProvisioningApiService) ProvisionPhoneNumber ¶

func (a *AccountProvisioningApiService) ProvisionPhoneNumber(ctx context.Context, accountId string, body 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, tracing, etc. @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session @param body JSON body @return PhoneNumberInfo

func (*AccountProvisioningApiService) ReassignPhoneNumberById ¶

func (a *AccountProvisioningApiService) ReassignPhoneNumberById(ctx context.Context, phoneNumberId int64, accountId string, localVarOptionals map[string]interface{}) (PhoneNumberResource, *http.Response, error)

AccountProvisioningApiService Reassign Phone Number

<p style='font-style:italic;'>Since 1.0.11 (Release 6.3) </p><p>Reassigns the phone number belonging to a certain account/extension. This call reassigns a phone number, currently belonging to some other extension or company (Auto-Receptionist). Please note: numbers with certain usage types 'MainCompanyNumber', 'AdditionalCompanyNumber' and 'CompanyFaxNumber' cannot be reassigned</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, tracing, etc. @param phoneNumberId @param accountId @param optional (nil or map[string]interface{}) with one or more of:

@param "body" (ReassignPhoneNumberResource)

@return PhoneNumberResource

func (*AccountProvisioningApiService) ReservePhoneNumbers ¶

func (a *AccountProvisioningApiService) ReservePhoneNumbers(ctx context.Context, body 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, tracing, etc. @param body JSON body @return ReservePhoneNumbersRecordsResource

func (*AccountProvisioningApiService) UpdateDevice ¶

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

AccountProvisioningApiService Update Device

* @param ctx context.Context for authentication, logging, tracing, etc. @param accountId @param deviceId @param body @return DeviceResource

func (*AccountProvisioningApiService) UpdatePagingOnlyGroupUsersAndDevices ¶

func (a *AccountProvisioningApiService) UpdatePagingOnlyGroupUsersAndDevices(ctx context.Context, accountId string, pagingOnlyGroupId string, localVarOptionals map[string]interface{}) (*http.Response, error)

AccountProvisioningApiService Edit Paging Group Users & Devices

<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes paging group users and devices.</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, tracing, etc. @param accountId @param pagingOnlyGroupId @param optional (nil or map[string]interface{}) with one or more of:

@param "body" (EditPagingGroupRequest)

@return

func (*AccountProvisioningApiService) UpdateParkLocationUsers ¶

func (a *AccountProvisioningApiService) UpdateParkLocationUsers(ctx context.Context, accountId string, parkLocationId string, localVarOptionals map[string]interface{}) (*http.Response, error)

AccountProvisioningApiService Adds and/or removes park location users

<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Adds and/or removes park location users.</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, tracing, etc. @param accountId @param parkLocationId @param optional (nil or map[string]interface{}) with one or more of:

@param "body" (EditParkLocationRequest)

@return

func (*ApplicationSettingsApiService) CreateSipRegistration ¶

func (a *ApplicationSettingsApiService) CreateSipRegistration(ctx context.Context, body 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, tracing, etc. @param body 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, tracing, etc. @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

func (*ApplicationSettingsApiService) GetAttachment ¶

func (a *ApplicationSettingsApiService) GetAttachment(ctx context.Context, key string, localVarOptionals map[string]interface{}) (*http.Response, error)

ApplicationSettingsApiService Get Custom Data Attachment

<p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p>Returns custom data attachment by 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, tracing, etc. @param key @param optional (nil or map[string]interface{}) with one or more of:

@param "range_" (string)

@return

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, tracing, etc. @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, tracing, etc. @param bannerType @return InProductMessages

func (*ApplicationSettingsApiService) GetSpecialNumberRules_ ¶

func (a *ApplicationSettingsApiService) GetSpecialNumberRules_(ctx context.Context, localVarOptionals map[string]interface{}) (NavigationInfo, *http.Response, error)

ApplicationSettingsApiService Get Special Numbers Calling Limitation

<p style='font-style:italic;'>Since 1.0.12 (Release 6.4)</p><p>Returns available special numbers and rules of processing, depending on account brand and application type (mobile/softphone/web/other). A special number rule for each number includes limitations on the options: VoIP, RingOut, outgoing SMS and Fax. If the option is disallowed, the server returns the reason code and text description.</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>Usage Plan Group</h4><p>Light</p> * @param ctx context.Context for authentication, logging, tracing, etc. @param optional (nil or map[string]interface{}) with one or more of:

@param "countryId" (int32) Internal identifier of a country. If not specified, the response is returned for the brand country

@return NavigationInfo

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, tracing, etc. @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, tracing, etc. @return

func (*ApplicationSettingsApiService) UpdateCustomData ¶

func (a *ApplicationSettingsApiService) UpdateCustomData(ctx context.Context, key int32, body 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, tracing, etc. @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 body JSON body @return CustomDataApiResponse

func (*CallHandlingSettingsApiService) BlockNumber ¶

func (a *CallHandlingSettingsApiService) BlockNumber(ctx context.Context, accountId string, extensionId string, localVarOptionals map[string]interface{}) (BlockedNumberInfo, *http.Response, error)

CallHandlingSettingsApiService Add 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'>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, tracing, etc. @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 optional (nil or map[string]interface{}) with one or more of:

@param "body" (BlockedNumberInfo)

@return BlockedNumberInfo

func (*CallHandlingSettingsApiService) CreateAnsweringRuleInfo ¶

func (a *CallHandlingSettingsApiService) CreateAnsweringRuleInfo(ctx context.Context, accountId string, extensionId string, body 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, tracing, etc. @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 body JSON body @return AnsweringRuleInfo

func (*CallHandlingSettingsApiService) CreateCompanyAnsweringRuleInfo ¶

func (a *CallHandlingSettingsApiService) CreateCompanyAnsweringRuleInfo(ctx context.Context, accountId string, body 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, tracing, etc. @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session @param body JSON body @return CompanyAnsweringRuleInfo

func (*CallHandlingSettingsApiService) CreateExtensionForwardingNumber ¶

func (a *CallHandlingSettingsApiService) CreateExtensionForwardingNumber(ctx context.Context, accountId string, extensionId string, body 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, tracing, etc. @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 body JSON body @return ForwardingNumberInfo

func (*CallHandlingSettingsApiService) CreateGreeting ¶

func (a *CallHandlingSettingsApiService) CreateGreeting(ctx context.Context, accountId string, extensionId string, localVarOptionals map[string]interface{}) (CustomCompanyGreetingInfo, *http.Response, error)

CallHandlingSettingsApiService Create User Custom Greeting

* @param ctx context.Context for authentication, logging, tracing, etc. @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 optional (nil or map[string]interface{}) with one or more of:

@param "body" (CustomGreetingRequest)

@return CustomCompanyGreetingInfo

func (*CallHandlingSettingsApiService) CreateIVRMenu ¶

func (a *CallHandlingSettingsApiService) CreateIVRMenu(ctx context.Context, accountId string, body 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, tracing, etc. @param accountId @param body JSON body @return IvrMenuInfo

func (*CallHandlingSettingsApiService) CreatePrompts ¶

func (a *CallHandlingSettingsApiService) CreatePrompts(ctx context.Context, accountId string, localVarFile *os.File, localVarOptionals map[string]interface{}) (PromptInfo, *http.Response, error)

CallHandlingSettingsApiService Create IVR Prompt

<p style='font-style:italic;'>Since 1.0.32 (Release 9.3)</p><p>Creates an IVR prompt.</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, tracing, etc. @param accountId @param attachment Audio file that will be used as a prompt. Attachment cannot be empty, only audio files are supported @param optional (nil or map[string]interface{}) with one or more of:

@param "name" (string) Description of file contents.

@return PromptInfo

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, tracing, etc. @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 @return

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, tracing, etc. @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 @return

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, tracing, etc. @param accountId @param promptId @return

func (*CallHandlingSettingsApiService) GetCompanyGreeting ¶

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

CallHandlingSettingsApiService Create Custom Company Greeting

* @param ctx context.Context for authentication, logging, tracing, etc. @param accountId Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session @param body 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, tracing, etc. @param forwardingNumberId @param extensionId @param accountId @return ForwardingNumberResource

func (*CallHandlingSettingsApiService) GetGreeting ¶

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