All URIs are relative to https://platform.devtest.ringcentral.com
| Method | HTTP request | Description |
|---|---|---|
| DeleteAccount | Delete /restapi/v1.0/account/{accountId} | Delete Account |
| ListDialingPlans | Get /restapi/v1.0/account/{accountId}/dialing-plan | Get Available Dialing Plans |
| LoadAccount | Get /restapi/v1.0/account/{accountId} | Get Company Info |
| LoadAccountBusinessAddress | Get /restapi/v1.0/account/{accountId}/business-address | Get Company Business Address |
| LoadServiceInfo | Get /restapi/v1.0/account/{accountId}/service-info | Get Account Service Info |
| ModifyAccount | Put /restapi/v1.0/account/{accountId} | Update Company |
| UpdateAccountBusinessAddress | Put /restapi/v1.0/account/{accountId}/business-address | Update Company Business Address |
| UpdateServiceInfo | Put /restapi/v1.0/account/{accountId}/service-info | Update Account Service Info [Beta] |
DeleteAccount(ctx, accountId) Delete Account
Since 1.0.0
Updates account information.
| Permission | Description |
|---|---|
| EditAccounts | Viewing and updating user account info (including name, business name, address and phone number/account number) |
Medium
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetDialingPlanInfo ListDialingPlans(ctx, accountId, optional) Get Available Dialing Plans
Returns list of countries which can be selected for a dialing plan (to call short numbers and special services).
| Permission | Description |
|---|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
Heavy
| 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 | *ListDialingPlansOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListDialingPlansOpts 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 |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetAccountInfoResponse LoadAccount(ctx, accountId) Get Company Info
Since 1.0.0
Returns basic information about a particular RingCentral customer account.
| Permission | Description |
|---|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
Light
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetAccountInfoResponse LoadAccountBusinessAddress(ctx, accountId) Get Company Business Address
| Permission | Description |
|---|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
Light
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetServiceInfoResponse LoadServiceInfo(ctx, accountId) Get Account Service Info
| Permission | Description |
|---|---|
| ReadAccounts | Viewing user account info (including name, business name, address and phone number/account number) |
Light
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetAccountInfoResponse ModifyAccount(ctx, accountId, updateAccountRequest) Update Company
Since 1.0.0
Updates account information.
| Permission | Description |
|---|---|
| EditAccounts | Viewing and updating user account info (including name, business name, address and phone number/account number) |
Medium
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | ||
| updateAccountRequest | UpdateAccountRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AccountBusinessAddressResource UpdateAccountBusinessAddress(ctx, accountId, modifyAccountBusinessAddressRequest) Update Company Business Address
| 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) |
Medium
| 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 ~] |
| modifyAccountBusinessAddressRequest | ModifyAccountBusinessAddressRequest | JSON body |
AccountBusinessAddressResource
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AccountServiceInfo UpdateServiceInfo(ctx, accountId, serviceInfoRequest) Update Account Service Info [Beta]
Since 1.0.29 (Release 9.0)
Updates limitations for a particular RingCentral customer account.
| 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) |
Light
| 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 ~] |
| serviceInfoRequest | ServiceInfoRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]