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

     1  # AccountsSIPIpAccessControlListsIpAddressesApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSipIpAddress**](AccountsSIPIpAccessControlListsIpAddressesApi.md#CreateSipIpAddress) | **Post** /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json | 
     8  [**DeleteSipIpAddress**](AccountsSIPIpAccessControlListsIpAddressesApi.md#DeleteSipIpAddress) | **Delete** /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json | 
     9  [**FetchSipIpAddress**](AccountsSIPIpAccessControlListsIpAddressesApi.md#FetchSipIpAddress) | **Get** /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json | 
    10  [**ListSipIpAddress**](AccountsSIPIpAccessControlListsIpAddressesApi.md#ListSipIpAddress) | **Get** /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json | 
    11  [**UpdateSipIpAddress**](AccountsSIPIpAccessControlListsIpAddressesApi.md#UpdateSipIpAddress) | **Post** /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json | 
    12  
    13  
    14  
    15  ## CreateSipIpAddress
    16  
    17  > ApiV2010SipIpAddress CreateSipIpAddress(ctx, IpAccessControlListSidoptional)
    18  
    19  
    20  
    21  Create a new IpAddress resource.
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **IpAccessControlListSid** | **string** | The IpAccessControlList Sid with which to associate the created IpAddress resource.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreateSipIpAddressParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **PathAccountSid** | **string** | The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.
    39  **FriendlyName** | **string** | A human readable descriptive text for this resource, up to 255 characters long.
    40  **IpAddress** | **string** | An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
    41  **CidrPrefixLength** | **int** | An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
    42  
    43  ### Return type
    44  
    45  [**ApiV2010SipIpAddress**](ApiV2010SipIpAddress.md)
    46  
    47  ### Authorization
    48  
    49  [accountSid_authToken](../README.md#accountSid_authToken)
    50  
    51  ### HTTP request headers
    52  
    53  - **Content-Type**: application/x-www-form-urlencoded
    54  - **Accept**: application/json
    55  
    56  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    57  [[Back to Model list]](../README.md#documentation-for-models)
    58  [[Back to README]](../README.md)
    59  
    60  
    61  ## DeleteSipIpAddress
    62  
    63  > DeleteSipIpAddress(ctx, IpAccessControlListSidSidoptional)
    64  
    65  
    66  
    67  Delete an IpAddress resource.
    68  
    69  ### Path Parameters
    70  
    71  
    72  Name | Type | Description
    73  ------------- | ------------- | -------------
    74  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    75  **IpAccessControlListSid** | **string** | The IpAccessControlList Sid that identifies the IpAddress resources to delete.
    76  **Sid** | **string** | A 34 character string that uniquely identifies the resource to delete.
    77  
    78  ### Other Parameters
    79  
    80  Other parameters are passed through a pointer to a DeleteSipIpAddressParams struct
    81  
    82  
    83  Name | Type | Description
    84  ------------- | ------------- | -------------
    85  **PathAccountSid** | **string** | The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.
    86  
    87  ### Return type
    88  
    89   (empty response body)
    90  
    91  ### Authorization
    92  
    93  [accountSid_authToken](../README.md#accountSid_authToken)
    94  
    95  ### HTTP request headers
    96  
    97  - **Content-Type**: Not defined
    98  - **Accept**: Not defined
    99  
   100  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   101  [[Back to Model list]](../README.md#documentation-for-models)
   102  [[Back to README]](../README.md)
   103  
   104  
   105  ## FetchSipIpAddress
   106  
   107  > ApiV2010SipIpAddress FetchSipIpAddress(ctx, IpAccessControlListSidSidoptional)
   108  
   109  
   110  
   111  Read one IpAddress resource.
   112  
   113  ### Path Parameters
   114  
   115  
   116  Name | Type | Description
   117  ------------- | ------------- | -------------
   118  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   119  **IpAccessControlListSid** | **string** | The IpAccessControlList Sid that identifies the IpAddress resources to fetch.
   120  **Sid** | **string** | A 34 character string that uniquely identifies the IpAddress resource to fetch.
   121  
   122  ### Other Parameters
   123  
   124  Other parameters are passed through a pointer to a FetchSipIpAddressParams struct
   125  
   126  
   127  Name | Type | Description
   128  ------------- | ------------- | -------------
   129  **PathAccountSid** | **string** | The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.
   130  
   131  ### Return type
   132  
   133  [**ApiV2010SipIpAddress**](ApiV2010SipIpAddress.md)
   134  
   135  ### Authorization
   136  
   137  [accountSid_authToken](../README.md#accountSid_authToken)
   138  
   139  ### HTTP request headers
   140  
   141  - **Content-Type**: Not defined
   142  - **Accept**: application/json
   143  
   144  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   145  [[Back to Model list]](../README.md#documentation-for-models)
   146  [[Back to README]](../README.md)
   147  
   148  
   149  ## ListSipIpAddress
   150  
   151  > []ApiV2010SipIpAddress ListSipIpAddress(ctx, IpAccessControlListSidoptional)
   152  
   153  
   154  
   155  Read multiple IpAddress resources.
   156  
   157  ### Path Parameters
   158  
   159  
   160  Name | Type | Description
   161  ------------- | ------------- | -------------
   162  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   163  **IpAccessControlListSid** | **string** | The IpAccessControlList Sid that identifies the IpAddress resources to read.
   164  
   165  ### Other Parameters
   166  
   167  Other parameters are passed through a pointer to a ListSipIpAddressParams struct
   168  
   169  
   170  Name | Type | Description
   171  ------------- | ------------- | -------------
   172  **PathAccountSid** | **string** | The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.
   173  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   174  **Limit** | **int** | Max number of records to return.
   175  
   176  ### Return type
   177  
   178  [**[]ApiV2010SipIpAddress**](ApiV2010SipIpAddress.md)
   179  
   180  ### Authorization
   181  
   182  [accountSid_authToken](../README.md#accountSid_authToken)
   183  
   184  ### HTTP request headers
   185  
   186  - **Content-Type**: Not defined
   187  - **Accept**: application/json
   188  
   189  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   190  [[Back to Model list]](../README.md#documentation-for-models)
   191  [[Back to README]](../README.md)
   192  
   193  
   194  ## UpdateSipIpAddress
   195  
   196  > ApiV2010SipIpAddress UpdateSipIpAddress(ctx, IpAccessControlListSidSidoptional)
   197  
   198  
   199  
   200  Update an IpAddress resource.
   201  
   202  ### Path Parameters
   203  
   204  
   205  Name | Type | Description
   206  ------------- | ------------- | -------------
   207  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   208  **IpAccessControlListSid** | **string** | The IpAccessControlList Sid that identifies the IpAddress resources to update.
   209  **Sid** | **string** | A 34 character string that identifies the IpAddress resource to update.
   210  
   211  ### Other Parameters
   212  
   213  Other parameters are passed through a pointer to a UpdateSipIpAddressParams struct
   214  
   215  
   216  Name | Type | Description
   217  ------------- | ------------- | -------------
   218  **PathAccountSid** | **string** | The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.
   219  **IpAddress** | **string** | An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
   220  **FriendlyName** | **string** | A human readable descriptive text for this resource, up to 255 characters long.
   221  **CidrPrefixLength** | **int** | An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
   222  
   223  ### Return type
   224  
   225  [**ApiV2010SipIpAddress**](ApiV2010SipIpAddress.md)
   226  
   227  ### Authorization
   228  
   229  [accountSid_authToken](../README.md#accountSid_authToken)
   230  
   231  ### HTTP request headers
   232  
   233  - **Content-Type**: application/x-www-form-urlencoded
   234  - **Accept**: application/json
   235  
   236  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   237  [[Back to Model list]](../README.md#documentation-for-models)
   238  [[Back to README]](../README.md)
   239