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

     1  # ConfigurationAddressesApi
     2  
     3  All URIs are relative to *https://conversations.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateConfigurationAddress**](ConfigurationAddressesApi.md#CreateConfigurationAddress) | **Post** /v1/Configuration/Addresses | 
     8  [**DeleteConfigurationAddress**](ConfigurationAddressesApi.md#DeleteConfigurationAddress) | **Delete** /v1/Configuration/Addresses/{Sid} | 
     9  [**FetchConfigurationAddress**](ConfigurationAddressesApi.md#FetchConfigurationAddress) | **Get** /v1/Configuration/Addresses/{Sid} | 
    10  [**ListConfigurationAddress**](ConfigurationAddressesApi.md#ListConfigurationAddress) | **Get** /v1/Configuration/Addresses | 
    11  [**UpdateConfigurationAddress**](ConfigurationAddressesApi.md#UpdateConfigurationAddress) | **Post** /v1/Configuration/Addresses/{Sid} | 
    12  
    13  
    14  
    15  ## CreateConfigurationAddress
    16  
    17  > ConversationsV1ConfigurationAddress CreateConfigurationAddress(ctx, optional)
    18  
    19  
    20  
    21  Create a new address configuration
    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 CreateConfigurationAddressParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **Type** | **string** | 
    35  **Address** | **string** | The unique address to be configured. The address can be a whatsapp address or phone number
    36  **FriendlyName** | **string** | The human-readable name of this configuration, limited to 256 characters. Optional.
    37  **AutoCreationEnabled** | **bool** | Enable/Disable auto-creating conversations for messages to this address
    38  **AutoCreationType** | **string** | 
    39  **AutoCreationConversationServiceSid** | **string** | Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
    40  **AutoCreationWebhookUrl** | **string** | For type `webhook`, the url for the webhook request.
    41  **AutoCreationWebhookMethod** | **string** | 
    42  **AutoCreationWebhookFilters** | **[]string** | The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
    43  **AutoCreationStudioFlowSid** | **string** | For type `studio`, the studio flow SID where the webhook should be sent to.
    44  **AutoCreationStudioRetryCount** | **int** | For type `studio`, number of times to retry the webhook request
    45  **AddressCountry** | **string** | An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
    46  
    47  ### Return type
    48  
    49  [**ConversationsV1ConfigurationAddress**](ConversationsV1ConfigurationAddress.md)
    50  
    51  ### Authorization
    52  
    53  [accountSid_authToken](../README.md#accountSid_authToken)
    54  
    55  ### HTTP request headers
    56  
    57  - **Content-Type**: application/x-www-form-urlencoded
    58  - **Accept**: application/json
    59  
    60  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    61  [[Back to Model list]](../README.md#documentation-for-models)
    62  [[Back to README]](../README.md)
    63  
    64  
    65  ## DeleteConfigurationAddress
    66  
    67  > DeleteConfigurationAddress(ctx, Sid)
    68  
    69  
    70  
    71  Remove an existing address configuration
    72  
    73  ### Path Parameters
    74  
    75  
    76  Name | Type | Description
    77  ------------- | ------------- | -------------
    78  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    79  **Sid** | **string** | The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
    80  
    81  ### Other Parameters
    82  
    83  Other parameters are passed through a pointer to a DeleteConfigurationAddressParams struct
    84  
    85  
    86  Name | Type | Description
    87  ------------- | ------------- | -------------
    88  
    89  ### Return type
    90  
    91   (empty response body)
    92  
    93  ### Authorization
    94  
    95  [accountSid_authToken](../README.md#accountSid_authToken)
    96  
    97  ### HTTP request headers
    98  
    99  - **Content-Type**: Not defined
   100  - **Accept**: Not defined
   101  
   102  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   103  [[Back to Model list]](../README.md#documentation-for-models)
   104  [[Back to README]](../README.md)
   105  
   106  
   107  ## FetchConfigurationAddress
   108  
   109  > ConversationsV1ConfigurationAddress FetchConfigurationAddress(ctx, Sid)
   110  
   111  
   112  
   113  Fetch an address configuration 
   114  
   115  ### Path Parameters
   116  
   117  
   118  Name | Type | Description
   119  ------------- | ------------- | -------------
   120  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   121  **Sid** | **string** | The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
   122  
   123  ### Other Parameters
   124  
   125  Other parameters are passed through a pointer to a FetchConfigurationAddressParams struct
   126  
   127  
   128  Name | Type | Description
   129  ------------- | ------------- | -------------
   130  
   131  ### Return type
   132  
   133  [**ConversationsV1ConfigurationAddress**](ConversationsV1ConfigurationAddress.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  ## ListConfigurationAddress
   150  
   151  > []ConversationsV1ConfigurationAddress ListConfigurationAddress(ctx, optional)
   152  
   153  
   154  
   155  Retrieve a list of address configurations for an account
   156  
   157  ### Path Parameters
   158  
   159  This endpoint does not need any path parameter.
   160  
   161  ### Other Parameters
   162  
   163  Other parameters are passed through a pointer to a ListConfigurationAddressParams struct
   164  
   165  
   166  Name | Type | Description
   167  ------------- | ------------- | -------------
   168  **Type** | **string** | Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
   169  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   170  **Limit** | **int** | Max number of records to return.
   171  
   172  ### Return type
   173  
   174  [**[]ConversationsV1ConfigurationAddress**](ConversationsV1ConfigurationAddress.md)
   175  
   176  ### Authorization
   177  
   178  [accountSid_authToken](../README.md#accountSid_authToken)
   179  
   180  ### HTTP request headers
   181  
   182  - **Content-Type**: Not defined
   183  - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   186  [[Back to Model list]](../README.md#documentation-for-models)
   187  [[Back to README]](../README.md)
   188  
   189  
   190  ## UpdateConfigurationAddress
   191  
   192  > ConversationsV1ConfigurationAddress UpdateConfigurationAddress(ctx, Sidoptional)
   193  
   194  
   195  
   196  Update an existing address configuration
   197  
   198  ### Path Parameters
   199  
   200  
   201  Name | Type | Description
   202  ------------- | ------------- | -------------
   203  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   204  **Sid** | **string** | The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
   205  
   206  ### Other Parameters
   207  
   208  Other parameters are passed through a pointer to a UpdateConfigurationAddressParams struct
   209  
   210  
   211  Name | Type | Description
   212  ------------- | ------------- | -------------
   213  **FriendlyName** | **string** | The human-readable name of this configuration, limited to 256 characters. Optional.
   214  **AutoCreationEnabled** | **bool** | Enable/Disable auto-creating conversations for messages to this address
   215  **AutoCreationType** | **string** | 
   216  **AutoCreationConversationServiceSid** | **string** | Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
   217  **AutoCreationWebhookUrl** | **string** | For type `webhook`, the url for the webhook request.
   218  **AutoCreationWebhookMethod** | **string** | 
   219  **AutoCreationWebhookFilters** | **[]string** | The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
   220  **AutoCreationStudioFlowSid** | **string** | For type `studio`, the studio flow SID where the webhook should be sent to.
   221  **AutoCreationStudioRetryCount** | **int** | For type `studio`, number of times to retry the webhook request
   222  
   223  ### Return type
   224  
   225  [**ConversationsV1ConfigurationAddress**](ConversationsV1ConfigurationAddress.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