github.com/twilio/twilio-go@v1.20.1/rest/voice/v1/docs/SourceIpMappingsApi.md (about)

     1  # SourceIpMappingsApi
     2  
     3  All URIs are relative to *https://voice.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSourceIpMapping**](SourceIpMappingsApi.md#CreateSourceIpMapping) | **Post** /v1/SourceIpMappings | 
     8  [**DeleteSourceIpMapping**](SourceIpMappingsApi.md#DeleteSourceIpMapping) | **Delete** /v1/SourceIpMappings/{Sid} | 
     9  [**FetchSourceIpMapping**](SourceIpMappingsApi.md#FetchSourceIpMapping) | **Get** /v1/SourceIpMappings/{Sid} | 
    10  [**ListSourceIpMapping**](SourceIpMappingsApi.md#ListSourceIpMapping) | **Get** /v1/SourceIpMappings | 
    11  [**UpdateSourceIpMapping**](SourceIpMappingsApi.md#UpdateSourceIpMapping) | **Post** /v1/SourceIpMappings/{Sid} | 
    12  
    13  
    14  
    15  ## CreateSourceIpMapping
    16  
    17  > VoiceV1SourceIpMapping CreateSourceIpMapping(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 CreateSourceIpMappingParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **IpRecordSid** | **string** | The Twilio-provided string that uniquely identifies the IP Record resource to map from.
    35  **SipDomainSid** | **string** | The SID of the SIP Domain that the IP Record should be mapped to.
    36  
    37  ### Return type
    38  
    39  [**VoiceV1SourceIpMapping**](VoiceV1SourceIpMapping.md)
    40  
    41  ### Authorization
    42  
    43  [accountSid_authToken](../README.md#accountSid_authToken)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: application/x-www-form-urlencoded
    48  - **Accept**: application/json
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53  
    54  
    55  ## DeleteSourceIpMapping
    56  
    57  > DeleteSourceIpMapping(ctx, Sid)
    58  
    59  
    60  
    61  
    62  
    63  ### Path Parameters
    64  
    65  
    66  Name | Type | Description
    67  ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **Sid** | **string** | The Twilio-provided string that uniquely identifies the IP Record resource to delete.
    70  
    71  ### Other Parameters
    72  
    73  Other parameters are passed through a pointer to a DeleteSourceIpMappingParams struct
    74  
    75  
    76  Name | Type | Description
    77  ------------- | ------------- | -------------
    78  
    79  ### Return type
    80  
    81   (empty response body)
    82  
    83  ### Authorization
    84  
    85  [accountSid_authToken](../README.md#accountSid_authToken)
    86  
    87  ### HTTP request headers
    88  
    89  - **Content-Type**: Not defined
    90  - **Accept**: Not defined
    91  
    92  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    93  [[Back to Model list]](../README.md#documentation-for-models)
    94  [[Back to README]](../README.md)
    95  
    96  
    97  ## FetchSourceIpMapping
    98  
    99  > VoiceV1SourceIpMapping FetchSourceIpMapping(ctx, Sid)
   100  
   101  
   102  
   103  
   104  
   105  ### Path Parameters
   106  
   107  
   108  Name | Type | Description
   109  ------------- | ------------- | -------------
   110  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   111  **Sid** | **string** | The Twilio-provided string that uniquely identifies the IP Record resource to fetch.
   112  
   113  ### Other Parameters
   114  
   115  Other parameters are passed through a pointer to a FetchSourceIpMappingParams struct
   116  
   117  
   118  Name | Type | Description
   119  ------------- | ------------- | -------------
   120  
   121  ### Return type
   122  
   123  [**VoiceV1SourceIpMapping**](VoiceV1SourceIpMapping.md)
   124  
   125  ### Authorization
   126  
   127  [accountSid_authToken](../README.md#accountSid_authToken)
   128  
   129  ### HTTP request headers
   130  
   131  - **Content-Type**: Not defined
   132  - **Accept**: application/json
   133  
   134  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   135  [[Back to Model list]](../README.md#documentation-for-models)
   136  [[Back to README]](../README.md)
   137  
   138  
   139  ## ListSourceIpMapping
   140  
   141  > []VoiceV1SourceIpMapping ListSourceIpMapping(ctx, optional)
   142  
   143  
   144  
   145  
   146  
   147  ### Path Parameters
   148  
   149  This endpoint does not need any path parameter.
   150  
   151  ### Other Parameters
   152  
   153  Other parameters are passed through a pointer to a ListSourceIpMappingParams struct
   154  
   155  
   156  Name | Type | Description
   157  ------------- | ------------- | -------------
   158  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   159  **Limit** | **int** | Max number of records to return.
   160  
   161  ### Return type
   162  
   163  [**[]VoiceV1SourceIpMapping**](VoiceV1SourceIpMapping.md)
   164  
   165  ### Authorization
   166  
   167  [accountSid_authToken](../README.md#accountSid_authToken)
   168  
   169  ### HTTP request headers
   170  
   171  - **Content-Type**: Not defined
   172  - **Accept**: application/json
   173  
   174  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   175  [[Back to Model list]](../README.md#documentation-for-models)
   176  [[Back to README]](../README.md)
   177  
   178  
   179  ## UpdateSourceIpMapping
   180  
   181  > VoiceV1SourceIpMapping UpdateSourceIpMapping(ctx, Sidoptional)
   182  
   183  
   184  
   185  
   186  
   187  ### Path Parameters
   188  
   189  
   190  Name | Type | Description
   191  ------------- | ------------- | -------------
   192  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   193  **Sid** | **string** | The Twilio-provided string that uniquely identifies the IP Record resource to update.
   194  
   195  ### Other Parameters
   196  
   197  Other parameters are passed through a pointer to a UpdateSourceIpMappingParams struct
   198  
   199  
   200  Name | Type | Description
   201  ------------- | ------------- | -------------
   202  **SipDomainSid** | **string** | The SID of the SIP Domain that the IP Record should be mapped to.
   203  
   204  ### Return type
   205  
   206  [**VoiceV1SourceIpMapping**](VoiceV1SourceIpMapping.md)
   207  
   208  ### Authorization
   209  
   210  [accountSid_authToken](../README.md#accountSid_authToken)
   211  
   212  ### HTTP request headers
   213  
   214  - **Content-Type**: application/x-www-form-urlencoded
   215  - **Accept**: application/json
   216  
   217  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   218  [[Back to Model list]](../README.md#documentation-for-models)
   219  [[Back to README]](../README.md)
   220