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

     1  # ServicesApi
     2  
     3  All URIs are relative to *https://notify.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateService**](ServicesApi.md#CreateService) | **Post** /v1/Services | 
     8  [**DeleteService**](ServicesApi.md#DeleteService) | **Delete** /v1/Services/{Sid} | 
     9  [**FetchService**](ServicesApi.md#FetchService) | **Get** /v1/Services/{Sid} | 
    10  [**ListService**](ServicesApi.md#ListService) | **Get** /v1/Services | 
    11  [**UpdateService**](ServicesApi.md#UpdateService) | **Post** /v1/Services/{Sid} | 
    12  
    13  
    14  
    15  ## CreateService
    16  
    17  > NotifyV1Service CreateService(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 CreateServiceParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long.
    35  **ApnCredentialSid** | **string** | The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
    36  **GcmCredentialSid** | **string** | The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
    37  **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
    38  **FacebookMessengerPageId** | **string** | Deprecated.
    39  **DefaultApnNotificationProtocolVersion** | **string** | The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
    40  **DefaultGcmNotificationProtocolVersion** | **string** | The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
    41  **FcmCredentialSid** | **string** | The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
    42  **DefaultFcmNotificationProtocolVersion** | **string** | The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
    43  **LogEnabled** | **bool** | Whether to log notifications. Can be: `true` or `false` and the default is `true`.
    44  **AlexaSkillId** | **string** | Deprecated.
    45  **DefaultAlexaNotificationProtocolVersion** | **string** | Deprecated.
    46  **DeliveryCallbackUrl** | **string** | URL to send delivery status callback.
    47  **DeliveryCallbackEnabled** | **bool** | Callback configuration that enables delivery callbacks, default false
    48  
    49  ### Return type
    50  
    51  [**NotifyV1Service**](NotifyV1Service.md)
    52  
    53  ### Authorization
    54  
    55  [accountSid_authToken](../README.md#accountSid_authToken)
    56  
    57  ### HTTP request headers
    58  
    59  - **Content-Type**: application/x-www-form-urlencoded
    60  - **Accept**: application/json
    61  
    62  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    63  [[Back to Model list]](../README.md#documentation-for-models)
    64  [[Back to README]](../README.md)
    65  
    66  
    67  ## DeleteService
    68  
    69  > DeleteService(ctx, Sid)
    70  
    71  
    72  
    73  
    74  
    75  ### Path Parameters
    76  
    77  
    78  Name | Type | Description
    79  ------------- | ------------- | -------------
    80  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    81  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Service resource to delete.
    82  
    83  ### Other Parameters
    84  
    85  Other parameters are passed through a pointer to a DeleteServiceParams struct
    86  
    87  
    88  Name | Type | Description
    89  ------------- | ------------- | -------------
    90  
    91  ### Return type
    92  
    93   (empty response body)
    94  
    95  ### Authorization
    96  
    97  [accountSid_authToken](../README.md#accountSid_authToken)
    98  
    99  ### HTTP request headers
   100  
   101  - **Content-Type**: Not defined
   102  - **Accept**: Not defined
   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  
   108  
   109  ## FetchService
   110  
   111  > NotifyV1Service FetchService(ctx, Sid)
   112  
   113  
   114  
   115  
   116  
   117  ### Path Parameters
   118  
   119  
   120  Name | Type | Description
   121  ------------- | ------------- | -------------
   122  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   123  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Service resource to fetch.
   124  
   125  ### Other Parameters
   126  
   127  Other parameters are passed through a pointer to a FetchServiceParams struct
   128  
   129  
   130  Name | Type | Description
   131  ------------- | ------------- | -------------
   132  
   133  ### Return type
   134  
   135  [**NotifyV1Service**](NotifyV1Service.md)
   136  
   137  ### Authorization
   138  
   139  [accountSid_authToken](../README.md#accountSid_authToken)
   140  
   141  ### HTTP request headers
   142  
   143  - **Content-Type**: Not defined
   144  - **Accept**: application/json
   145  
   146  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   147  [[Back to Model list]](../README.md#documentation-for-models)
   148  [[Back to README]](../README.md)
   149  
   150  
   151  ## ListService
   152  
   153  > []NotifyV1Service ListService(ctx, optional)
   154  
   155  
   156  
   157  
   158  
   159  ### Path Parameters
   160  
   161  This endpoint does not need any path parameter.
   162  
   163  ### Other Parameters
   164  
   165  Other parameters are passed through a pointer to a ListServiceParams struct
   166  
   167  
   168  Name | Type | Description
   169  ------------- | ------------- | -------------
   170  **FriendlyName** | **string** | The string that identifies the Service resources to read.
   171  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   172  **Limit** | **int** | Max number of records to return.
   173  
   174  ### Return type
   175  
   176  [**[]NotifyV1Service**](NotifyV1Service.md)
   177  
   178  ### Authorization
   179  
   180  [accountSid_authToken](../README.md#accountSid_authToken)
   181  
   182  ### HTTP request headers
   183  
   184  - **Content-Type**: Not defined
   185  - **Accept**: application/json
   186  
   187  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   188  [[Back to Model list]](../README.md#documentation-for-models)
   189  [[Back to README]](../README.md)
   190  
   191  
   192  ## UpdateService
   193  
   194  > NotifyV1Service UpdateService(ctx, Sidoptional)
   195  
   196  
   197  
   198  
   199  
   200  ### Path Parameters
   201  
   202  
   203  Name | Type | Description
   204  ------------- | ------------- | -------------
   205  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   206  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Service resource to update.
   207  
   208  ### Other Parameters
   209  
   210  Other parameters are passed through a pointer to a UpdateServiceParams struct
   211  
   212  
   213  Name | Type | Description
   214  ------------- | ------------- | -------------
   215  **FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long.
   216  **ApnCredentialSid** | **string** | The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
   217  **GcmCredentialSid** | **string** | The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
   218  **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
   219  **FacebookMessengerPageId** | **string** | Deprecated.
   220  **DefaultApnNotificationProtocolVersion** | **string** | The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
   221  **DefaultGcmNotificationProtocolVersion** | **string** | The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
   222  **FcmCredentialSid** | **string** | The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
   223  **DefaultFcmNotificationProtocolVersion** | **string** | The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
   224  **LogEnabled** | **bool** | Whether to log notifications. Can be: `true` or `false` and the default is `true`.
   225  **AlexaSkillId** | **string** | Deprecated.
   226  **DefaultAlexaNotificationProtocolVersion** | **string** | Deprecated.
   227  **DeliveryCallbackUrl** | **string** | URL to send delivery status callback.
   228  **DeliveryCallbackEnabled** | **bool** | Callback configuration that enables delivery callbacks, default false
   229  
   230  ### Return type
   231  
   232  [**NotifyV1Service**](NotifyV1Service.md)
   233  
   234  ### Authorization
   235  
   236  [accountSid_authToken](../README.md#accountSid_authToken)
   237  
   238  ### HTTP request headers
   239  
   240  - **Content-Type**: application/x-www-form-urlencoded
   241  - **Accept**: application/json
   242  
   243  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   244  [[Back to Model list]](../README.md#documentation-for-models)
   245  [[Back to README]](../README.md)
   246