github.com/twilio/twilio-go@v1.20.1/rest/verify/v2/docs/ServicesMessagingConfigurationsApi.md (about)

     1  # ServicesMessagingConfigurationsApi
     2  
     3  All URIs are relative to *https://verify.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateMessagingConfiguration**](ServicesMessagingConfigurationsApi.md#CreateMessagingConfiguration) | **Post** /v2/Services/{ServiceSid}/MessagingConfigurations | 
     8  [**DeleteMessagingConfiguration**](ServicesMessagingConfigurationsApi.md#DeleteMessagingConfiguration) | **Delete** /v2/Services/{ServiceSid}/MessagingConfigurations/{Country} | 
     9  [**FetchMessagingConfiguration**](ServicesMessagingConfigurationsApi.md#FetchMessagingConfiguration) | **Get** /v2/Services/{ServiceSid}/MessagingConfigurations/{Country} | 
    10  [**ListMessagingConfiguration**](ServicesMessagingConfigurationsApi.md#ListMessagingConfiguration) | **Get** /v2/Services/{ServiceSid}/MessagingConfigurations | 
    11  [**UpdateMessagingConfiguration**](ServicesMessagingConfigurationsApi.md#UpdateMessagingConfiguration) | **Post** /v2/Services/{ServiceSid}/MessagingConfigurations/{Country} | 
    12  
    13  
    14  
    15  ## CreateMessagingConfiguration
    16  
    17  > VerifyV2MessagingConfiguration CreateMessagingConfiguration(ctx, ServiceSidoptional)
    18  
    19  
    20  
    21  Create a new MessagingConfiguration for a service.
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreateMessagingConfigurationParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **Country** | **string** | The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
    39  **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
    40  
    41  ### Return type
    42  
    43  [**VerifyV2MessagingConfiguration**](VerifyV2MessagingConfiguration.md)
    44  
    45  ### Authorization
    46  
    47  [accountSid_authToken](../README.md#accountSid_authToken)
    48  
    49  ### HTTP request headers
    50  
    51  - **Content-Type**: application/x-www-form-urlencoded
    52  - **Accept**: application/json
    53  
    54  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    55  [[Back to Model list]](../README.md#documentation-for-models)
    56  [[Back to README]](../README.md)
    57  
    58  
    59  ## DeleteMessagingConfiguration
    60  
    61  > DeleteMessagingConfiguration(ctx, ServiceSidCountry)
    62  
    63  
    64  
    65  Delete a specific MessagingConfiguration.
    66  
    67  ### Path Parameters
    68  
    69  
    70  Name | Type | Description
    71  ------------- | ------------- | -------------
    72  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    73  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with.
    74  **Country** | **string** | The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
    75  
    76  ### Other Parameters
    77  
    78  Other parameters are passed through a pointer to a DeleteMessagingConfigurationParams struct
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  
    84  ### Return type
    85  
    86   (empty response body)
    87  
    88  ### Authorization
    89  
    90  [accountSid_authToken](../README.md#accountSid_authToken)
    91  
    92  ### HTTP request headers
    93  
    94  - **Content-Type**: Not defined
    95  - **Accept**: Not defined
    96  
    97  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    98  [[Back to Model list]](../README.md#documentation-for-models)
    99  [[Back to README]](../README.md)
   100  
   101  
   102  ## FetchMessagingConfiguration
   103  
   104  > VerifyV2MessagingConfiguration FetchMessagingConfiguration(ctx, ServiceSidCountry)
   105  
   106  
   107  
   108  Fetch a specific MessagingConfiguration.
   109  
   110  ### Path Parameters
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with.
   117  **Country** | **string** | The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
   118  
   119  ### Other Parameters
   120  
   121  Other parameters are passed through a pointer to a FetchMessagingConfigurationParams struct
   122  
   123  
   124  Name | Type | Description
   125  ------------- | ------------- | -------------
   126  
   127  ### Return type
   128  
   129  [**VerifyV2MessagingConfiguration**](VerifyV2MessagingConfiguration.md)
   130  
   131  ### Authorization
   132  
   133  [accountSid_authToken](../README.md#accountSid_authToken)
   134  
   135  ### HTTP request headers
   136  
   137  - **Content-Type**: Not defined
   138  - **Accept**: application/json
   139  
   140  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   141  [[Back to Model list]](../README.md#documentation-for-models)
   142  [[Back to README]](../README.md)
   143  
   144  
   145  ## ListMessagingConfiguration
   146  
   147  > []VerifyV2MessagingConfiguration ListMessagingConfiguration(ctx, ServiceSidoptional)
   148  
   149  
   150  
   151  Retrieve a list of all Messaging Configurations for a Service.
   152  
   153  ### Path Parameters
   154  
   155  
   156  Name | Type | Description
   157  ------------- | ------------- | -------------
   158  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   159  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with.
   160  
   161  ### Other Parameters
   162  
   163  Other parameters are passed through a pointer to a ListMessagingConfigurationParams struct
   164  
   165  
   166  Name | Type | Description
   167  ------------- | ------------- | -------------
   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  [**[]VerifyV2MessagingConfiguration**](VerifyV2MessagingConfiguration.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  ## UpdateMessagingConfiguration
   190  
   191  > VerifyV2MessagingConfiguration UpdateMessagingConfiguration(ctx, ServiceSidCountryoptional)
   192  
   193  
   194  
   195  Update a specific MessagingConfiguration
   196  
   197  ### Path Parameters
   198  
   199  
   200  Name | Type | Description
   201  ------------- | ------------- | -------------
   202  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   203  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with.
   204  **Country** | **string** | The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
   205  
   206  ### Other Parameters
   207  
   208  Other parameters are passed through a pointer to a UpdateMessagingConfigurationParams struct
   209  
   210  
   211  Name | Type | Description
   212  ------------- | ------------- | -------------
   213  **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
   214  
   215  ### Return type
   216  
   217  [**VerifyV2MessagingConfiguration**](VerifyV2MessagingConfiguration.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