AccountProvisioningApi.md

\AccountProvisioningApi

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

Method	HTTP request	Description
BulkAssign	Post /restapi/v1.0/account/{accountId}/department/bulk-assign	Edit Call Queue Members
CreateAccount	Post /restapi/v1.0/account	Create Account
CreateDeviceOrder	Post /restapi/v1.0/account/{accountId}/order	Create Device Order
CreateLicensesOrder	Post /restapi/v1.0/account/{accountId}/licenses/bulk-purchase	Order Licenses
DeleteLicense	Delete /restapi/v1.0/account/{accountId}/licenses/{licenseId}	Delete License
DeletePhoneNumberById	Delete /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}	Delete Phone Number
GetBrandInfo	Get /restapi/v1.0/dictionary/brand/{brandId}	Get Brand Info
GetDeviceModels	Get /restapi/v1.0/dictionary/device	Get Device Catalog
GetExtensionFreeNumbers	Get /restapi/v1.0/account/{accountId}/extension/free-numbers	Get Free Extension Numbers
GetPagingOnlyGroupDevices	Get /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devices	Get Paging Only Group Devices
GetPagingOnlyGroupUsers	Get /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/users	Get Paging Only Group Users
GetParkLocationUsers	Get /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/users	Get Park Location Users
GetServicePlanInfo	Get /restapi/v1.0/dictionary/service-plan/{servicePlanId}	Get Service Plan
ListAccountDevices	Get /restapi/v1.0/account/{accountId}/device	Get Account Devices
ListAccountPhoneNumbers	Get /restapi/v1.0/account/{accountId}/phone-number	Get All Company Phone Numbers
ListDepartmentMembers	Get /restapi/v1.0/account/{accountId}/department/{departmentId}/members	Get Department Member List
ListExtensionDevices	Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/device	Get User Device Info
ListLicenseTypes	Get /restapi/v1.0/dictionary/license-types	Get License Types
ListLicenses	Get /restapi/v1.0/account/{accountId}/licenses	Get License List
ListShippingOptions	Get /restapi/v1.0/dictionary/shipping-options	Get Shipping Options
LoadAccountDevice	Get /restapi/v1.0/account/{accountId}/device/{deviceId}	Get Device Info
LoadAccountPhoneNumber	Get /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}	Get Phone Number
LoadDeviceOrder	Get /restapi/v1.0/account/{accountId}/order/{orderId}	Get Device Order by ID
LoadLicense	Get /restapi/v1.0/account/{accountId}/licenses/{licenseId}	Get License
LookupPhoneNumbers	Post /restapi/v1.0/number-pool/lookup	Get Numbers
ParsePhoneNumber	Post /restapi/v1.0/number-parser/parse	Parse Phone Number
ProvisionPhoneNumber	Post /restapi/v1.0/account/{accountId}/phone-number	Provision Phone Numbers
ReassignPhoneNumberById	Put /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}	Reassign Phone Number
ReservePhoneNumbers	Post /restapi/v1.0/number-pool/reserve	Reserve/ Un-reserve Numbers
UpdateDevice	Put /restapi/v1.0/account/{accountId}/device/{deviceId}	Update Device
UpdatePagingOnlyGroupUsersAndDevices	Post /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign	Edit Paging Group Users & Devices
UpdateParkLocationUsers	Post /restapi/v1.0/account/{accountId}/park-locations/{parkLocationId}/bulk-assign	Adds and/or removes park location users

BulkAssign

BulkAssign(ctx, accountId, optional) Edit Call Queue Members

Since 1.0.32 (Release 9.3)

Adds and/or removes multiple call queue members.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string		[default to ~]
optional	*BulkAssignOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BulkAssignOpts struct

Name	Type	Description	Notes

departmentBulkAssignResource | optional.Interface of DepartmentBulkAssignResource| |

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAccount

GetAccountInfoResponse CreateAccount(ctx, createAccountRequest) Create Account

Since 1.0.10 (Release 6.2)

Creates the account in Initial state.

Required Permissions

Permission	Description
Accounts	Managing accounts: creating new accounts, viewing and updating account information, deleting existing accounts
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
createAccountRequest	CreateAccountRequest	JSON body

Return type

GetAccountInfoResponse

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateDeviceOrder

DeviceOrderCreation CreateDeviceOrder(ctx, accountId, optional) Create Device Order

Required Permissions

Permission	Description
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
optional	*CreateDeviceOrderOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateDeviceOrderOpts struct

Name	Type	Description	Notes

async | optional.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' | [default to false] deviceResource | optional.Interface of DeviceResource| |

Return type

DeviceOrderCreation

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateLicensesOrder

CreateLicensesOrder(ctx, accountId, orderLicensesRequest) Order Licenses

Since 1.0.31 (Release 9.2)

Purchases licenses for add-on features: Rooms, Room Connector, Webinar, Live Reports, etc.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)

API Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
orderLicensesRequest	OrderLicensesRequest	JSON body

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteLicense

DeleteLicense(ctx, accountId, licenseId) Delete License

Since 1.0.31 (Release 9.2)

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

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)

API Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
licenseId	string	Internal identifier of a license

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeletePhoneNumberById

DeletePhoneNumberById(ctx, phoneNumberId, accountId) Delete Phone Number

Since 1.0.11 (Release 6.3)

Deletes a phone number belonging to a certain account/extension.

Required Permissions

Permission	Description
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
phoneNumberId	int64
accountId	string

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBrandInfo

BrandResource GetBrandInfo(ctx, brandId) Get Brand Info

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string

Return type

BrandResource

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDeviceModels

DeviceModelExtsResource GetDeviceModels(ctx, ) Get Device Catalog

Required Parameters

This endpoint does not need any parameter.

Return type

DeviceModelExtsResource

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionFreeNumbers

BulkProvisionUnassignedExtensionsResponseResource GetExtensionFreeNumbers(ctx, accountId) Get Free Extension Numbers

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string

Return type

BulkProvisionUnassignedExtensionsResponseResource

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPagingOnlyGroupDevices

PagingOnlyGroupDevices GetPagingOnlyGroupDevices(ctx, accountId, pagingOnlyGroupId, optional) Get Paging Only Group Devices

Since 1.0.32 (Release 9.3)

Returns the list of paging devices assigned to this group.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
pagingOnlyGroupId	string
optional	*GetPagingOnlyGroupDevicesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetPagingOnlyGroupDevicesOpts struct

Name	Type	Description	Notes

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

Return type

PagingOnlyGroupDevices

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPagingOnlyGroupUsers

PagingOnlyGroupUsers GetPagingOnlyGroupUsers(ctx, accountId, pagingOnlyGroupId, optional) Get Paging Only Group Users

Since 1.0.32 (Release 9.3)

Returns the list of users allowed to page this group.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
pagingOnlyGroupId	string
optional	*GetPagingOnlyGroupUsersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetPagingOnlyGroupUsersOpts struct

Name	Type	Description	Notes

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

Return type

PagingOnlyGroupUsers

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetParkLocationUsers

ParkLocationResponse GetParkLocationUsers(ctx, accountId, parkLocationId, optional) Get Park Location Users

Since 1.0.32 (Release 9.3)

Returns the list of users allowed to park and unpark calls to/from the park location extension specified

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
parkLocationId	string
optional	*GetParkLocationUsersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetParkLocationUsersOpts struct

Name	Type	Description	Notes

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

Return type

ParkLocationResponse

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServicePlanInfo

ServicePlanResource GetServicePlanInfo(ctx, servicePlanId) Get Service Plan

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
servicePlanId	string

Return type

ServicePlanResource

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAccountDevices

GetAccountDevicesResponse ListAccountDevices(ctx, accountId) Get Account Devices

Since 1.0.12 (Release 6.4)

Returns all the devices for a particular extension.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]

Return type

GetAccountDevicesResponse

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAccountPhoneNumbers

AccountPhoneNumbers ListAccountPhoneNumbers(ctx, accountId, optional) Get All Company Phone Numbers

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
optional	*ListAccountPhoneNumbersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListAccountPhoneNumbersOpts struct

Name	Type	Description	Notes

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

Return type

AccountPhoneNumbers

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListDepartmentMembers

DepartmentMemberList ListDepartmentMembers(ctx, accountId, departmentId, optional) Get Department Member List

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
departmentId	int32	Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid)
optional	*ListDepartmentMembersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListDepartmentMembersOpts struct

Name	Type	Description	Notes

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

Return type

DepartmentMemberList

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListExtensionDevices

GetExtensionDevicesResponse ListExtensionDevices(ctx, accountId, extensionId, optional) Get User Device Info

Since 1.0.12 (Release 6.4)

Returns all the devices for extension(s) by extension ID(s). Batch request is supported, see Batch Requests for details.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
extensionId	string	Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session	[default to ~]
optional	*ListExtensionDevicesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListExtensionDevicesOpts struct

Name	Type	Description	Notes

linePooling | optional.String| Pooling type of a device |

Return type

GetExtensionDevicesResponse

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListLicenseTypes

LicenseTypes ListLicenseTypes(ctx, ) Get License Types

Since 1.0.31 (Release 9.2)

Returns supported license types.

API Group

Light

Required Parameters

This endpoint does not need any parameter.

Return type

LicenseTypes

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListLicenses

LicenseList ListLicenses(ctx, accountId, optional) Get License List

Since 1.0.31 (Release 9.2)

Returns list of licenses for a specific user.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
optional	*ListLicensesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListLicensesOpts struct

Name	Type	Description	Notes

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

Return type

LicenseList

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListShippingOptions

DictionaryShippingOptions ListShippingOptions(ctx, optional) Get Shipping Options

Since 1.0.16 (Release 7.1)

Returns the list of device shipping options with their prices, according to brand, tier, number of ordered devices.

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ListShippingOptionsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListShippingOptionsOpts struct

Name	Type	Description	Notes
servicePlanId	optional.Int32
brandId	optional.Int32
quantity	optional.Int32

Return type

DictionaryShippingOptions

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadAccountDevice

GetDeviceInfoResponse LoadAccountDevice(ctx, accountId, deviceId) Get Device Info

Since 1.0.9 (Release 6.1)

Returns account device(s) by their ID(s).

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
deviceId	string	Internal identifier of a device

Return type

GetDeviceInfoResponse

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadAccountPhoneNumber

PhoneNumberInfo LoadAccountPhoneNumber(ctx, accountId, phoneNumberId) Get Phone Number

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
phoneNumberId	int32	Internal identifier of a phone number

Return type

PhoneNumberInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadDeviceOrder

DeviceOrder LoadDeviceOrder(ctx, accountId, orderId) Get Device Order by ID

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
orderId	int32	Internal identifier of an order

Return type

DeviceOrder

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoadLicense

LicenseInfo LoadLicense(ctx, accountId, licenseId) Get License

Since 1.0.31 (Release 9.2)

Returns license information by its ID.

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

API Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
licenseId	string	Internal identifier of a license

Return type

LicenseInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LookupPhoneNumbers

PhoneNumbers LookupPhoneNumbers(ctx, optional) Get Numbers

Since 1.0.10 (Release 6.2)

Returns the required numbers filtered by criteria.

Required Permissions

Permission	Description
NumberLookup	Looking-up and reserving available phone number

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*LookupPhoneNumbersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a LookupPhoneNumbersOpts struct

Name	Type	Description	Notes
areaCode	optional.Int32	Area code of the location
countryCode	optional.String	Two-letter country code, complying with the ISO standard
countryId	optional.String	Internal identifier of a country; '1'- the US; '39' - Canada; '224' - the UK. The default value is '1'
exclude	optional.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)
extendedSearch	optional.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'
line	optional.String	LINE pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 4 characters)
numberPattern	optional.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.
nxx	optional.String	NXX pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 3 characters)
npa	optional.String	Area code (mandatory). For example, 800, 844, 855, 866, 877, 888 for North America; and 647 for Canada
paymentType	optional.Interface of []string	Payment type. Default is 'Local' (it should correlate with the npa provided)
perPage	optional.Int32	Indicates the page size (number of items). If not specified, the value is '10' by default
providerId	optional.Int32	Internal identifier of a phone number provider. Supported if brand is specified. If specified, area code and nxx are optional
smsEnabled	optional.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 type

PhoneNumbers

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ParsePhoneNumber

ParsePhoneNumberResponse ParsePhoneNumber(ctx, parsePhoneNumberRequest, optional) Parse Phone Number

Since 1.0.13 (Release 6.5)

Returns one or more parsed and/or formatted phone numbers that are passed as a string.

Usage Plan Group

Light

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
parsePhoneNumberRequest	ParsePhoneNumberRequest	JSON body
optional	*ParsePhoneNumberOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ParsePhoneNumberOpts struct

Name	Type	Description	Notes

homeCountry | optional.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 | nationalAsPriority | optional.Bool| The default value is 'False'. If 'True', the numbers that are closer to the home country are given higher priority |

Return type

ParsePhoneNumberResponse

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ProvisionPhoneNumber

PhoneNumberInfo ProvisionPhoneNumber(ctx, accountId, provisionPhoneNumberRequest) Provision Phone Numbers

Since 1.0.11 (Release 6.3)

Provisions a phone number.

Required Permissions

Permission	Description
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session	[default to ~]
provisionPhoneNumberRequest	ProvisionPhoneNumberRequest	JSON body

Return type

PhoneNumberInfo

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReassignPhoneNumberById

PhoneNumberResource ReassignPhoneNumberById(ctx, phoneNumberId, accountId, optional) Reassign Phone Number

Since 1.0.11 (Release 6.3)

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

Required Permissions

Permission	Description
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
phoneNumberId	int64
accountId	string
optional	*ReassignPhoneNumberByIdOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReassignPhoneNumberByIdOpts struct

Name	Type	Description	Notes

reassignPhoneNumberResource | optional.Interface of ReassignPhoneNumberResource| |

Return type

PhoneNumberResource

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReservePhoneNumbers

ReservePhoneNumbersRecordsResource ReservePhoneNumbers(ctx, numberPoolPhoneNumberRequest) Reserve/ Un-reserve Numbers

Since 1.0.10 (Release 6.2)

Required Permissions

Permission	Description
NumberLookup	Looking-up and reserving available phone number

Usage Plan Group

Medium

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
numberPoolPhoneNumberRequest	NumberPoolPhoneNumberRequest	JSON body

Return type

ReservePhoneNumbersRecordsResource

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateDevice

DeviceResource UpdateDevice(ctx, accountId, deviceId, accountDeviceUpdate) Update Device

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
deviceId	string
accountDeviceUpdate	AccountDeviceUpdate

Return type

DeviceResource

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePagingOnlyGroupUsersAndDevices

UpdatePagingOnlyGroupUsersAndDevices(ctx, accountId, pagingOnlyGroupId, optional) Edit Paging Group Users & Devices

Since 1.0.32 (Release 9.3)

Adds and/or removes paging group users and devices.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
pagingOnlyGroupId	string
optional	*UpdatePagingOnlyGroupUsersAndDevicesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdatePagingOnlyGroupUsersAndDevicesOpts struct

Name	Type	Description	Notes

editPagingGroupRequest | optional.Interface of EditPagingGroupRequest| |

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateParkLocationUsers

UpdateParkLocationUsers(ctx, accountId, parkLocationId, optional) Adds and/or removes park location users

Since 1.0.32 (Release 9.3)

Adds and/or removes park location users.

Required Permissions

Permission	Description
EditExtensions	Viewing and updating my extension info (includes extension name, number, email and phone number)

Usage Plan Group

Heavy

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string
parkLocationId	string
optional	*UpdateParkLocationUsersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateParkLocationUsersOpts struct

Name	Type	Description	Notes

editParkLocationRequest | optional.Interface of EditParkLocationRequest| |

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]