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

     1  # ServicesApi
     2  
     3  All URIs are relative to *https://ip-messaging.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateService**](ServicesApi.md#CreateService) | **Post** /v2/Services | 
     8  [**DeleteService**](ServicesApi.md#DeleteService) | **Delete** /v2/Services/{Sid} | 
     9  [**FetchService**](ServicesApi.md#FetchService) | **Get** /v2/Services/{Sid} | 
    10  [**ListService**](ServicesApi.md#ListService) | **Get** /v2/Services | 
    11  [**UpdateService**](ServicesApi.md#UpdateService) | **Post** /v2/Services/{Sid} | 
    12  
    13  
    14  
    15  ## CreateService
    16  
    17  > IpMessagingV2Service 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** | 
    35  
    36  ### Return type
    37  
    38  [**IpMessagingV2Service**](IpMessagingV2Service.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: application/x-www-form-urlencoded
    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  ## DeleteService
    55  
    56  > DeleteService(ctx, Sid)
    57  
    58  
    59  
    60  
    61  
    62  ### Path Parameters
    63  
    64  
    65  Name | Type | Description
    66  ------------- | ------------- | -------------
    67  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    68  **Sid** | **string** | 
    69  
    70  ### Other Parameters
    71  
    72  Other parameters are passed through a pointer to a DeleteServiceParams struct
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  
    78  ### Return type
    79  
    80   (empty response body)
    81  
    82  ### Authorization
    83  
    84  [accountSid_authToken](../README.md#accountSid_authToken)
    85  
    86  ### HTTP request headers
    87  
    88  - **Content-Type**: Not defined
    89  - **Accept**: Not defined
    90  
    91  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    92  [[Back to Model list]](../README.md#documentation-for-models)
    93  [[Back to README]](../README.md)
    94  
    95  
    96  ## FetchService
    97  
    98  > IpMessagingV2Service FetchService(ctx, Sid)
    99  
   100  
   101  
   102  
   103  
   104  ### Path Parameters
   105  
   106  
   107  Name | Type | Description
   108  ------------- | ------------- | -------------
   109  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   110  **Sid** | **string** | 
   111  
   112  ### Other Parameters
   113  
   114  Other parameters are passed through a pointer to a FetchServiceParams struct
   115  
   116  
   117  Name | Type | Description
   118  ------------- | ------------- | -------------
   119  
   120  ### Return type
   121  
   122  [**IpMessagingV2Service**](IpMessagingV2Service.md)
   123  
   124  ### Authorization
   125  
   126  [accountSid_authToken](../README.md#accountSid_authToken)
   127  
   128  ### HTTP request headers
   129  
   130  - **Content-Type**: Not defined
   131  - **Accept**: application/json
   132  
   133  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   134  [[Back to Model list]](../README.md#documentation-for-models)
   135  [[Back to README]](../README.md)
   136  
   137  
   138  ## ListService
   139  
   140  > []IpMessagingV2Service ListService(ctx, optional)
   141  
   142  
   143  
   144  
   145  
   146  ### Path Parameters
   147  
   148  This endpoint does not need any path parameter.
   149  
   150  ### Other Parameters
   151  
   152  Other parameters are passed through a pointer to a ListServiceParams struct
   153  
   154  
   155  Name | Type | Description
   156  ------------- | ------------- | -------------
   157  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   158  **Limit** | **int** | Max number of records to return.
   159  
   160  ### Return type
   161  
   162  [**[]IpMessagingV2Service**](IpMessagingV2Service.md)
   163  
   164  ### Authorization
   165  
   166  [accountSid_authToken](../README.md#accountSid_authToken)
   167  
   168  ### HTTP request headers
   169  
   170  - **Content-Type**: Not defined
   171  - **Accept**: application/json
   172  
   173  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   174  [[Back to Model list]](../README.md#documentation-for-models)
   175  [[Back to README]](../README.md)
   176  
   177  
   178  ## UpdateService
   179  
   180  > IpMessagingV2Service UpdateService(ctx, Sidoptional)
   181  
   182  
   183  
   184  
   185  
   186  ### Path Parameters
   187  
   188  
   189  Name | Type | Description
   190  ------------- | ------------- | -------------
   191  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   192  **Sid** | **string** | 
   193  
   194  ### Other Parameters
   195  
   196  Other parameters are passed through a pointer to a UpdateServiceParams struct
   197  
   198  
   199  Name | Type | Description
   200  ------------- | ------------- | -------------
   201  **FriendlyName** | **string** | 
   202  **DefaultServiceRoleSid** | **string** | 
   203  **DefaultChannelRoleSid** | **string** | 
   204  **DefaultChannelCreatorRoleSid** | **string** | 
   205  **ReadStatusEnabled** | **bool** | 
   206  **ReachabilityEnabled** | **bool** | 
   207  **TypingIndicatorTimeout** | **int** | 
   208  **ConsumptionReportInterval** | **int** | 
   209  **NotificationsNewMessageEnabled** | **bool** | 
   210  **NotificationsNewMessageTemplate** | **string** | 
   211  **NotificationsNewMessageSound** | **string** | 
   212  **NotificationsNewMessageBadgeCountEnabled** | **bool** | 
   213  **NotificationsAddedToChannelEnabled** | **bool** | 
   214  **NotificationsAddedToChannelTemplate** | **string** | 
   215  **NotificationsAddedToChannelSound** | **string** | 
   216  **NotificationsRemovedFromChannelEnabled** | **bool** | 
   217  **NotificationsRemovedFromChannelTemplate** | **string** | 
   218  **NotificationsRemovedFromChannelSound** | **string** | 
   219  **NotificationsInvitedToChannelEnabled** | **bool** | 
   220  **NotificationsInvitedToChannelTemplate** | **string** | 
   221  **NotificationsInvitedToChannelSound** | **string** | 
   222  **PreWebhookUrl** | **string** | 
   223  **PostWebhookUrl** | **string** | 
   224  **WebhookMethod** | **string** | 
   225  **WebhookFilters** | **[]string** | 
   226  **LimitsChannelMembers** | **int** | 
   227  **LimitsUserChannels** | **int** | 
   228  **MediaCompatibilityMessage** | **string** | 
   229  **PreWebhookRetryCount** | **int** | 
   230  **PostWebhookRetryCount** | **int** | 
   231  **NotificationsLogEnabled** | **bool** | 
   232  
   233  ### Return type
   234  
   235  [**IpMessagingV2Service**](IpMessagingV2Service.md)
   236  
   237  ### Authorization
   238  
   239  [accountSid_authToken](../README.md#accountSid_authToken)
   240  
   241  ### HTTP request headers
   242  
   243  - **Content-Type**: application/x-www-form-urlencoded
   244  - **Accept**: application/json
   245  
   246  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   247  [[Back to Model list]](../README.md#documentation-for-models)
   248  [[Back to README]](../README.md)
   249