github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/PhoneNumbersApi.md (about)

     1  # \PhoneNumbersApi
     2  
     3  All URIs are relative to *https://platform.devtest.ringcentral.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ListExtensionPhoneNumbers**](PhoneNumbersApi.md#ListExtensionPhoneNumbers) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number | Get Extension Phone Number List
     8  
     9  
    10  # **ListExtensionPhoneNumbers**
    11  > GetExtensionPhoneNumbersResponse ListExtensionPhoneNumbers(ctx, accountId, extensionId, optional)
    12  Get Extension Phone Number List
    13  
    14  <p style='font-style:italic;'>Since 1.0.2</p><p>Returns the list of phone numbers that are used by a particular extension, and can be filtered by the phone number type. The returned list contains all numbers which are directly mapped to a given extension plus the features and also company-level numbers which may be used when performing different operations on behalf of this 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>
    15  
    16  ### Required Parameters
    17  
    18  Name | Type | Description  | Notes
    19  ------------- | ------------- | ------------- | -------------
    20   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    21    **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~]
    22    **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 ~]
    23   **optional** | ***ListExtensionPhoneNumbersOpts** | optional parameters | nil if no parameters
    24  
    25  ### Optional Parameters
    26  Optional parameters are passed through a pointer to a ListExtensionPhoneNumbersOpts struct
    27  
    28  Name | Type | Description  | Notes
    29  ------------- | ------------- | ------------- | -------------
    30  
    31  
    32   **usageType** | [**optional.Interface of []string**](string.md)| Usage type of the phone number | 
    33   **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is &#39;1&#39; | 
    34   **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is &#39;100&#39; by default | 
    35  
    36  ### Return type
    37  
    38  [**GetExtensionPhoneNumbersResponse**](GetExtensionPhoneNumbersResponse.md)
    39  
    40  ### Authorization
    41  
    42  [OAuth2](../README.md#OAuth2)
    43  
    44  ### HTTP request headers
    45  
    46   - **Content-Type**: Not defined
    47   - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    50