All URIs are relative to https://platform.devtest.ringcentral.com
| Method | HTTP request | Description |
|---|---|---|
| CreateBotExtension | Post /restapi/v1.0/account/{accountId}/bot | Create Bot Extension |
| CreateExtension | Post /restapi/v1.0/account/{accountId}/extension | Create Extension |
| ListCompanyDirectoryContacts | Get /restapi/v1.0/account/{accountId}/directory/contacts | Get Company Directory |
| ListExtensions | Get /restapi/v1.0/account/{accountId}/extension | Get Extensions |
| LoadCompanyDirectoryContact | Get /restapi/v1.0/account/{accountId}/directory/contacts/{contactId} | Get Company Directory Contact |
| LoadCompanyDirectoryExtensionNumbers | Get /restapi/v1.0/account/{accountId}/directory/extension-numbers | Get Existing Extension Numbers |
| LoadCompanyDirectoryFederation | Get /restapi/v1.0/account/{accountId}/directory/federation | Get Account Federation |
| LoadCompanyDirectoryFederationConflicts | Get /restapi/v1.0/account/{accountId}/directory/federation-conflicts | Get Account Federation Conflicts |
BotExtensionCreation CreateBotExtension(ctx, accountId, botExtensionCreationRequest) Create Bot Extension
Since 1.0.32 (Release 9.3)
Creates a bot extension. Please note: Bot extension is always created in Enabled status, no welcome email is sent.
| 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 | Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] |
| botExtensionCreationRequest | BotExtensionCreationRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExtensionInfo CreateExtension(ctx, accountId, extensionCreationRequest) Create Extension
Since 1.0.10 (Release 6.2)
Creates an extension.
| 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 | Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] |
| extensionCreationRequest | ExtensionCreationRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CompanyDirectoryContacts ListCompanyDirectoryContacts(ctx, accountId, optional) Get Company Directory
Returns contact information on corporate users of federated accounts. Please note: 1. User, DigitalUser, VirtualUser and FaxUser types are returned as User type. 2.ApplicationExtension type is not returned. 3. Only extensions in Enabled, Disabled and NotActivated state are returned.
| 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 ~] |
| optional | *ListCompanyDirectoryContactsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListCompanyDirectoryContactsOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int64| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | perPage | optional.Int64| Indicates the page size (number of items). The possible values are: Max, all or a numeric value. If not specified, all records are returned on one page | excludeFederatedContacts | optional.Bool| If 'True' then only contacts of current account are returned, if 'False' then all contacts of all federation accounts are returned |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetExtensionListResponse ListExtensions(ctx, accountId, optional) Get Extensions
Since 1.0.0
Returns the list of extensions created for a particular account. All types of extensions are included in this list.
| 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 ~] |
| optional | *ListExtensionsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListExtensionsOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int64| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | perPage | optional.Int64| Indicates the page size (number of items). If not specified, the value is '100' by default. | status | optional.Interface of []string| Extension current state. Multiple values are supported. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned | type_ | optional.Interface of []string| Extension type. Multiple values are supported |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ContactInfo LoadCompanyDirectoryContact(ctx, accountId, contactId) Get Company Directory Contact
Returns contact information on a particular corporate user of a federated account.
| 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 ~] |
| contactId | string | Internal identifier of an extension |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FederationExtensionNumbers LoadCompanyDirectoryExtensionNumbers(ctx, accountId) Get Existing Extension Numbers
Returns the list of account federation extensions.
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FederationInfo LoadCompanyDirectoryFederation(ctx, accountId) Get Account Federation
Returns information on a federation and associated accounts.
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FederationConflicts LoadCompanyDirectoryFederationConflicts(ctx, accountId) Get Account Federation Conflicts
Returns the list of federation extensions which numbers are conflicting with extension numbers of the requested account.
| 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 ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]