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

     1  # ServicesConfigurationNotificationsApi
     2  
     3  All URIs are relative to *https://conversations.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchServiceNotification**](ServicesConfigurationNotificationsApi.md#FetchServiceNotification) | **Get** /v1/Services/{ChatServiceSid}/Configuration/Notifications | 
     8  [**UpdateServiceNotification**](ServicesConfigurationNotificationsApi.md#UpdateServiceNotification) | **Post** /v1/Services/{ChatServiceSid}/Configuration/Notifications | 
     9  
    10  
    11  
    12  ## FetchServiceNotification
    13  
    14  > ConversationsV1ServiceNotification FetchServiceNotification(ctx, ChatServiceSid)
    15  
    16  
    17  
    18  Fetch push notification service settings
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.
    27  
    28  ### Other Parameters
    29  
    30  Other parameters are passed through a pointer to a FetchServiceNotificationParams struct
    31  
    32  
    33  Name | Type | Description
    34  ------------- | ------------- | -------------
    35  
    36  ### Return type
    37  
    38  [**ConversationsV1ServiceNotification**](ConversationsV1ServiceNotification.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: Not defined
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## UpdateServiceNotification
    55  
    56  > ConversationsV1ServiceNotification UpdateServiceNotification(ctx, ChatServiceSidoptional)
    57  
    58  
    59  
    60  Update push notification service settings
    61  
    62  ### Path Parameters
    63  
    64  
    65  Name | Type | Description
    66  ------------- | ------------- | -------------
    67  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    68  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.
    69  
    70  ### Other Parameters
    71  
    72  Other parameters are passed through a pointer to a UpdateServiceNotificationParams struct
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  **LogEnabled** | **bool** | Weather the notification logging is enabled.
    78  **NewMessageEnabled** | **bool** | Whether to send a notification when a new message is added to a conversation. The default is `false`.
    79  **NewMessageTemplate** | **string** | The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`.
    80  **NewMessageSound** | **string** | The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`.
    81  **NewMessageBadgeCountEnabled** | **bool** | Whether the new message badge is enabled. The default is `false`.
    82  **AddedToConversationEnabled** | **bool** | Whether to send a notification when a participant is added to a conversation. The default is `false`.
    83  **AddedToConversationTemplate** | **string** | The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
    84  **AddedToConversationSound** | **string** | The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
    85  **RemovedFromConversationEnabled** | **bool** | Whether to send a notification to a user when they are removed from a conversation. The default is `false`.
    86  **RemovedFromConversationTemplate** | **string** | The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
    87  **RemovedFromConversationSound** | **string** | The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
    88  **NewMessageWithMediaEnabled** | **bool** | Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`.
    89  **NewMessageWithMediaTemplate** | **string** | The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`.
    90  
    91  ### Return type
    92  
    93  [**ConversationsV1ServiceNotification**](ConversationsV1ServiceNotification.md)
    94  
    95  ### Authorization
    96  
    97  [accountSid_authToken](../README.md#accountSid_authToken)
    98  
    99  ### HTTP request headers
   100  
   101  - **Content-Type**: application/x-www-form-urlencoded
   102  - **Accept**: application/json
   103  
   104  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   105  [[Back to Model list]](../README.md#documentation-for-models)
   106  [[Back to README]](../README.md)
   107