All URIs are relative to https://platform.devtest.ringcentral.com
| Method | HTTP request | Description |
|---|---|---|
| DeleteExtension | Delete /restapi/v1.0/account/{accountId}/extension/{extensionId} | Delete Extension |
| DownloadImage | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Get User Profile Image |
| GetNotificationSettings | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings | Get Notification Settings |
| ListExtensionGrants | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/grant | Get Extension Grants |
| ListSecretQuestions | Get /restapi/v1.0/dictionary/secret-question | Get Secret Questions |
| LoadConferencingInfo | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing | Get User Conferencing Settings |
| LoadExtensionCallerId | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id | Get Extension Caller ID |
| LoadExtensionInfo | Get /restapi/v1.0/account/{accountId}/extension/{extensionId} | Get Extension Info |
| LoadExtensionProfileImage | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize} | Get Extension Profile Image (Scaled) |
| LoadExtensionUserCredentials | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials | Get User Credentials |
| LoadSecretQuestion | Get /restapi/v1.0/dictionary/secret-question/{questionId} | Get Secret Question |
| UpdateConferencingInfo | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing | Update User Conferencing Settings |
| UpdateExtension | Put /restapi/v1.0/account/{accountId}/extension/{extensionId} | Update Extension |
| UpdateExtensionCallerId | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id | Update Extension Caller ID |
| UpdateExtensionUserCredentials | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials | Update User Credentials |
| UpdateNotificationSettings | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings | Update Notification Settings |
| UploadImageByPostForm | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Upload User Profile Image |
| UploadImageByPutForm | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image | Update User Profile Image |
| ValidateExtensionUserCredentials | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/validate | Validate User Credentials |
| VerifyExtensionUserCredentials | Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/credentials/verify | Verify Extension User Credentials |
DeleteExtension(ctx, extensionId, accountId) Delete Extension
Since 1.0.10 (Release 6.2)
Deletes extension(s) by ID(s).
| 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. | |
| extensionId | string | ||
| 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]
Binary DownloadImage(ctx, extensionId, accountId) Get User Profile Image
Since 1.0.20 (Release 7.4)
Returns the extension profile image.
| Permission | Description |
|---|---|
| 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. | |
| extensionId | string | ||
| accountId | string |
- Content-Type: Not defined
- Accept: /, image/png, image/jpeg, image/gif
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NotificationSettings GetNotificationSettings(ctx, accountId, extensionId) Get Notification Settings
Since 1.0.26 (Release 8.2)
Returns notification settings for the current extension.
| 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 ~] |
| extensionId | string | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetExtensionGrantListResponse ListExtensionGrants(ctx, accountId, extensionId, optional) Get Extension Grants
Returns the list of extension grants.
| 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 ~] |
| 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 | *ListExtensionGrantsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListExtensionGrantsOpts 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]
GetSecretQuestionListResponse ListSecretQuestions(ctx, optional) Get Secret Questions
Since 1.0.20 (Release 7.4)
Returns the list of secret questions for a specific language.
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ListSecretQuestionsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListSecretQuestionsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| signupOnly | optional.Bool | [default to false] | |
| page | optional.String | [default to 1] | |
| perPage | optional.String | [default to 100] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetConferencingInfoResponse LoadConferencingInfo(ctx, accountId, extensionId, optional) Get User Conferencing Settings
Since 1.0.4 (Release 5.13)
Returns the information on the Free Conference Calling (FCC) feature for a given extension.
| 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 ~] |
| 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 | *LoadConferencingInfoOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LoadConferencingInfoOpts struct
| Name | Type | Description | Notes |
|---|
countryId | optional.String| Internal identifier of a country. If not specified, the response is returned for the brand country |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExtensionCallerIdInfo LoadExtensionCallerId(ctx, accountId, extensionId) Get Extension Caller ID
Since 1.0.28 (Release 8.4)
Returns information on an outbound caller ID of an extension.
| 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 ~] |
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetExtensionInfoResponse LoadExtensionInfo(ctx, accountId, extensionId) Get Extension Info
Since 1.0.0
Returns basic information about a particular extension of an 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 ~] |
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Binary LoadExtensionProfileImage(ctx, accountId, extensionId, scaleSize) Get Extension Profile Image (Scaled)
Returns the extension profile image.
| Permission | Description |
|---|---|
| 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 ~] |
| 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 ~] |
| scaleSize | string | Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExtensionUserCredentials LoadExtensionUserCredentials(ctx, accountId, extensionId) Get User Credentials
Since 1.0.27 (Release 8.3)
Returns extension user credentials.
| Permission | Description |
|---|---|
| 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 ~] |
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SecretQuestionInfo LoadSecretQuestion(ctx, questionId) Get Secret Question
Since 1.0.20 (Release 7.4)
Returns a particular secret question in specific language by question ID.
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| questionId | int32 | Internal identifier of a question |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetConferencingInfoResponse UpdateConferencingInfo(ctx, accountId, extensionId, updateConferencingInfoRequest) Update User Conferencing Settings
| Permission | Description |
|---|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone 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 ~] |
| 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 ~] |
| updateConferencingInfoRequest | UpdateConferencingInfoRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetExtensionInfoResponse UpdateExtension(ctx, accountId, extensionId, extensionUpdateRequest) Update Extension
| Permission | Description |
|---|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone 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 ~] |
| 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 ~] |
| extensionUpdateRequest | ExtensionUpdateRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExtensionCallerIdInfo UpdateExtensionCallerId(ctx, accountId, extensionId, extensionCallerIdInfo) Update Extension Caller ID
Since 1.0.28 (Release 8.4)
Updates outbound caller ID information of an extension.
| Permission | Description |
|---|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone 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 ~] |
| 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 ~] |
| extensionCallerIdInfo | ExtensionCallerIdInfo | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExtensionUserCredentials UpdateExtensionUserCredentials(ctx, accountId, extensionId, extensionUserCredentailsRequest) Update User Credentials
Since 1.0.27 (Release 8.3)
Updates extension user credentials.
| Permission | Description |
|---|---|
| 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 ~] |
| 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 ~] |
| extensionUserCredentailsRequest | ExtensionUserCredentailsRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NotificationSettings UpdateNotificationSettings(ctx, accountId, extensionId, notificationSettingsUpdateRequest) Update Notification Settings
Since 1.0.26 (Release 8.2)
Updates notification settings for the current extension.
| Permission | Description |
|---|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone 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 ~] |
| extensionId | int32 | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | |
| notificationSettingsUpdateRequest | NotificationSettingsUpdateRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Binary UploadImageByPostForm(ctx, extensionId, accountId, image) Upload User Profile Image
Since 1.0.26 (Release 8.2)
Returns the extension profile image.
| Permission | Description |
|---|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone number) |
Heavy
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| extensionId | string | ||
| accountId | string | ||
| image | os.Fileos.File |
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Binary UploadImageByPutForm(ctx, extensionId, accountId, optional) Update User Profile Image
Since 1.0.26 (Release 8.2)
Updates the extension profile image..
| Permission | Description |
|---|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone number) |
Heavy
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| extensionId | string | ||
| accountId | string | ||
| optional | *UploadImageByPutFormOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UploadImageByPutFormOpts struct
| Name | Type | Description | Notes |
|---|
image | *optional.Interface of os.File***optional.os.File| |
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ValidateExtensionUserCredentials(ctx, accountId, extensionId, validateExtensionUserCredentials) Validate User Credentials
Since 1.0.27 (Release 8.3)
Validates if extension user credentials specified can be applied.
| Permission | Description |
|---|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone 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 ~] |
| 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 ~] |
| validateExtensionUserCredentials | ValidateExtensionUserCredentials | JSON body |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VerifyExtensionUserCredentials(ctx, accountId, extensionId, verifyExtensionUserCredentials) Verify Extension User Credentials
Since 1.0.27 (Release 8.3)
Verifies current extension user credentials.
| Permission | Description |
|---|---|
| EditExtensions | Viewing and updating my extension info (includes extension name, number, email and phone 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 ~] |
| 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 ~] |
| verifyExtensionUserCredentials | VerifyExtensionUserCredentials | JSON body |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]