github.com/twilio/twilio-go@v1.20.1/rest/api/v2010/docs/AccountsOutgoingCallerIdsApi.md (about)

     1  # AccountsOutgoingCallerIdsApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateValidationRequest**](AccountsOutgoingCallerIdsApi.md#CreateValidationRequest) | **Post** /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json | 
     8  [**DeleteOutgoingCallerId**](AccountsOutgoingCallerIdsApi.md#DeleteOutgoingCallerId) | **Delete** /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json | 
     9  [**FetchOutgoingCallerId**](AccountsOutgoingCallerIdsApi.md#FetchOutgoingCallerId) | **Get** /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json | 
    10  [**ListOutgoingCallerId**](AccountsOutgoingCallerIdsApi.md#ListOutgoingCallerId) | **Get** /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json | 
    11  [**UpdateOutgoingCallerId**](AccountsOutgoingCallerIdsApi.md#UpdateOutgoingCallerId) | **Post** /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json | 
    12  
    13  
    14  
    15  ## CreateValidationRequest
    16  
    17  > ApiV2010ValidationRequest CreateValidationRequest(ctx, optional)
    18  
    19  
    20  
    21  
    22  
    23  ### Path Parameters
    24  
    25  This endpoint does not need any path parameter.
    26  
    27  ### Other Parameters
    28  
    29  Other parameters are passed through a pointer to a CreateValidationRequestParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for the new caller ID resource.
    35  **PhoneNumber** | **string** | The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
    36  **FriendlyName** | **string** | A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number.
    37  **CallDelay** | **int** | The number of seconds to delay before initiating the verification call. Can be an integer between `0` and `60`, inclusive. The default is `0`.
    38  **Extension** | **string** | The digits to dial after connecting the verification call.
    39  **StatusCallback** | **string** | The URL we should call using the `status_callback_method` to send status information about the verification process to your application.
    40  **StatusCallbackMethod** | **string** | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`, and the default is `POST`.
    41  
    42  ### Return type
    43  
    44  [**ApiV2010ValidationRequest**](ApiV2010ValidationRequest.md)
    45  
    46  ### Authorization
    47  
    48  [accountSid_authToken](../README.md#accountSid_authToken)
    49  
    50  ### HTTP request headers
    51  
    52  - **Content-Type**: application/x-www-form-urlencoded
    53  - **Accept**: application/json
    54  
    55  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    56  [[Back to Model list]](../README.md#documentation-for-models)
    57  [[Back to README]](../README.md)
    58  
    59  
    60  ## DeleteOutgoingCallerId
    61  
    62  > DeleteOutgoingCallerId(ctx, Sidoptional)
    63  
    64  
    65  
    66  Delete the caller-id specified from the account
    67  
    68  ### Path Parameters
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **Sid** | **string** | The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete.
    75  
    76  ### Other Parameters
    77  
    78  Other parameters are passed through a pointer to a DeleteOutgoingCallerIdParams struct
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to delete.
    84  
    85  ### Return type
    86  
    87   (empty response body)
    88  
    89  ### Authorization
    90  
    91  [accountSid_authToken](../README.md#accountSid_authToken)
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: Not defined
    96  - **Accept**: Not defined
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101  
   102  
   103  ## FetchOutgoingCallerId
   104  
   105  > ApiV2010OutgoingCallerId FetchOutgoingCallerId(ctx, Sidoptional)
   106  
   107  
   108  
   109  Fetch an outgoing-caller-id belonging to the account used to make the request
   110  
   111  ### Path Parameters
   112  
   113  
   114  Name | Type | Description
   115  ------------- | ------------- | -------------
   116  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   117  **Sid** | **string** | The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch.
   118  
   119  ### Other Parameters
   120  
   121  Other parameters are passed through a pointer to a FetchOutgoingCallerIdParams struct
   122  
   123  
   124  Name | Type | Description
   125  ------------- | ------------- | -------------
   126  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resource to fetch.
   127  
   128  ### Return type
   129  
   130  [**ApiV2010OutgoingCallerId**](ApiV2010OutgoingCallerId.md)
   131  
   132  ### Authorization
   133  
   134  [accountSid_authToken](../README.md#accountSid_authToken)
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144  
   145  
   146  ## ListOutgoingCallerId
   147  
   148  > []ApiV2010OutgoingCallerId ListOutgoingCallerId(ctx, optional)
   149  
   150  
   151  
   152  Retrieve a list of outgoing-caller-ids belonging to the account used to make the request
   153  
   154  ### Path Parameters
   155  
   156  This endpoint does not need any path parameter.
   157  
   158  ### Other Parameters
   159  
   160  Other parameters are passed through a pointer to a ListOutgoingCallerIdParams struct
   161  
   162  
   163  Name | Type | Description
   164  ------------- | ------------- | -------------
   165  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to read.
   166  **PhoneNumber** | **string** | The phone number of the OutgoingCallerId resources to read.
   167  **FriendlyName** | **string** | The string that identifies the OutgoingCallerId resources to read.
   168  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   169  **Limit** | **int** | Max number of records to return.
   170  
   171  ### Return type
   172  
   173  [**[]ApiV2010OutgoingCallerId**](ApiV2010OutgoingCallerId.md)
   174  
   175  ### Authorization
   176  
   177  [accountSid_authToken](../README.md#accountSid_authToken)
   178  
   179  ### HTTP request headers
   180  
   181  - **Content-Type**: Not defined
   182  - **Accept**: application/json
   183  
   184  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   185  [[Back to Model list]](../README.md#documentation-for-models)
   186  [[Back to README]](../README.md)
   187  
   188  
   189  ## UpdateOutgoingCallerId
   190  
   191  > ApiV2010OutgoingCallerId UpdateOutgoingCallerId(ctx, Sidoptional)
   192  
   193  
   194  
   195  Updates the caller-id
   196  
   197  ### Path Parameters
   198  
   199  
   200  Name | Type | Description
   201  ------------- | ------------- | -------------
   202  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   203  **Sid** | **string** | The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update.
   204  
   205  ### Other Parameters
   206  
   207  Other parameters are passed through a pointer to a UpdateOutgoingCallerIdParams struct
   208  
   209  
   210  Name | Type | Description
   211  ------------- | ------------- | -------------
   212  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to update.
   213  **FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long.
   214  
   215  ### Return type
   216  
   217  [**ApiV2010OutgoingCallerId**](ApiV2010OutgoingCallerId.md)
   218  
   219  ### Authorization
   220  
   221  [accountSid_authToken](../README.md#accountSid_authToken)
   222  
   223  ### HTTP request headers
   224  
   225  - **Content-Type**: application/x-www-form-urlencoded
   226  - **Accept**: application/json
   227  
   228  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   229  [[Back to Model list]](../README.md#documentation-for-models)
   230  [[Back to README]](../README.md)
   231