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

     1  # ServicesApi
     2  
     3  All URIs are relative to *https://conversations.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  
    12  
    13  
    14  ## CreateService
    15  
    16  > ConversationsV1Service CreateService(ctx, optional)
    17  
    18  
    19  
    20  Create a new conversation service on your account
    21  
    22  ### Path Parameters
    23  
    24  This endpoint does not need any path parameter.
    25  
    26  ### Other Parameters
    27  
    28  Other parameters are passed through a pointer to a CreateServiceParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **FriendlyName** | **string** | The human-readable name of this service, limited to 256 characters. Optional.
    34  
    35  ### Return type
    36  
    37  [**ConversationsV1Service**](ConversationsV1Service.md)
    38  
    39  ### Authorization
    40  
    41  [accountSid_authToken](../README.md#accountSid_authToken)
    42  
    43  ### HTTP request headers
    44  
    45  - **Content-Type**: application/x-www-form-urlencoded
    46  - **Accept**: application/json
    47  
    48  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    49  [[Back to Model list]](../README.md#documentation-for-models)
    50  [[Back to README]](../README.md)
    51  
    52  
    53  ## DeleteService
    54  
    55  > DeleteService(ctx, Sid)
    56  
    57  
    58  
    59  Remove a conversation service with all its nested resources from your account
    60  
    61  ### Path Parameters
    62  
    63  
    64  Name | Type | Description
    65  ------------- | ------------- | -------------
    66  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    67  **Sid** | **string** | A 34 character string that uniquely identifies this resource.
    68  
    69  ### Other Parameters
    70  
    71  Other parameters are passed through a pointer to a DeleteServiceParams struct
    72  
    73  
    74  Name | Type | Description
    75  ------------- | ------------- | -------------
    76  
    77  ### Return type
    78  
    79   (empty response body)
    80  
    81  ### Authorization
    82  
    83  [accountSid_authToken](../README.md#accountSid_authToken)
    84  
    85  ### HTTP request headers
    86  
    87  - **Content-Type**: Not defined
    88  - **Accept**: Not defined
    89  
    90  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    91  [[Back to Model list]](../README.md#documentation-for-models)
    92  [[Back to README]](../README.md)
    93  
    94  
    95  ## FetchService
    96  
    97  > ConversationsV1Service FetchService(ctx, Sid)
    98  
    99  
   100  
   101  Fetch a conversation service from your account
   102  
   103  ### Path Parameters
   104  
   105  
   106  Name | Type | Description
   107  ------------- | ------------- | -------------
   108  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   109  **Sid** | **string** | A 34 character string that uniquely identifies this resource.
   110  
   111  ### Other Parameters
   112  
   113  Other parameters are passed through a pointer to a FetchServiceParams struct
   114  
   115  
   116  Name | Type | Description
   117  ------------- | ------------- | -------------
   118  
   119  ### Return type
   120  
   121  [**ConversationsV1Service**](ConversationsV1Service.md)
   122  
   123  ### Authorization
   124  
   125  [accountSid_authToken](../README.md#accountSid_authToken)
   126  
   127  ### HTTP request headers
   128  
   129  - **Content-Type**: Not defined
   130  - **Accept**: application/json
   131  
   132  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   133  [[Back to Model list]](../README.md#documentation-for-models)
   134  [[Back to README]](../README.md)
   135  
   136  
   137  ## ListService
   138  
   139  > []ConversationsV1Service ListService(ctx, optional)
   140  
   141  
   142  
   143  Retrieve a list of all conversation services on your account
   144  
   145  ### Path Parameters
   146  
   147  This endpoint does not need any path parameter.
   148  
   149  ### Other Parameters
   150  
   151  Other parameters are passed through a pointer to a ListServiceParams struct
   152  
   153  
   154  Name | Type | Description
   155  ------------- | ------------- | -------------
   156  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   157  **Limit** | **int** | Max number of records to return.
   158  
   159  ### Return type
   160  
   161  [**[]ConversationsV1Service**](ConversationsV1Service.md)
   162  
   163  ### Authorization
   164  
   165  [accountSid_authToken](../README.md#accountSid_authToken)
   166  
   167  ### HTTP request headers
   168  
   169  - **Content-Type**: Not defined
   170  - **Accept**: application/json
   171  
   172  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   173  [[Back to Model list]](../README.md#documentation-for-models)
   174  [[Back to README]](../README.md)
   175