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

     1  # FlexFlowsApi
     2  
     3  All URIs are relative to *https://flex-api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateFlexFlow**](FlexFlowsApi.md#CreateFlexFlow) | **Post** /v1/FlexFlows | 
     8  [**DeleteFlexFlow**](FlexFlowsApi.md#DeleteFlexFlow) | **Delete** /v1/FlexFlows/{Sid} | 
     9  [**FetchFlexFlow**](FlexFlowsApi.md#FetchFlexFlow) | **Get** /v1/FlexFlows/{Sid} | 
    10  [**ListFlexFlow**](FlexFlowsApi.md#ListFlexFlow) | **Get** /v1/FlexFlows | 
    11  [**UpdateFlexFlow**](FlexFlowsApi.md#UpdateFlexFlow) | **Post** /v1/FlexFlows/{Sid} | 
    12  
    13  
    14  
    15  ## CreateFlexFlow
    16  
    17  > FlexV1FlexFlow CreateFlexFlow(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 CreateFlexFlowParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **FriendlyName** | **string** | A descriptive string that you create to describe the Flex Flow resource.
    35  **ChatServiceSid** | **string** | The SID of the chat service.
    36  **ChannelType** | **string** | 
    37  **ContactIdentity** | **string** | The channel contact's Identity.
    38  **Enabled** | **bool** | Whether the new Flex Flow is enabled.
    39  **IntegrationType** | **string** | 
    40  **IntegrationFlowSid** | **string** | The SID of the Studio Flow. Required when `integrationType` is `studio`.
    41  **IntegrationUrl** | **string** | The URL of the external webhook. Required when `integrationType` is `external`.
    42  **IntegrationWorkspaceSid** | **string** | The Workspace SID for a new Task. Required when `integrationType` is `task`.
    43  **IntegrationWorkflowSid** | **string** | The Workflow SID for a new Task. Required when `integrationType` is `task`.
    44  **IntegrationChannel** | **string** | The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.
    45  **IntegrationTimeout** | **int** | The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.
    46  **IntegrationPriority** | **int** | The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.
    47  **IntegrationCreationOnMessage** | **bool** | In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
    48  **LongLived** | **bool** | When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.
    49  **JanitorEnabled** | **bool** | When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
    50  **IntegrationRetryCount** | **int** | The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise.
    51  
    52  ### Return type
    53  
    54  [**FlexV1FlexFlow**](FlexV1FlexFlow.md)
    55  
    56  ### Authorization
    57  
    58  [accountSid_authToken](../README.md#accountSid_authToken)
    59  
    60  ### HTTP request headers
    61  
    62  - **Content-Type**: application/x-www-form-urlencoded
    63  - **Accept**: application/json
    64  
    65  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    66  [[Back to Model list]](../README.md#documentation-for-models)
    67  [[Back to README]](../README.md)
    68  
    69  
    70  ## DeleteFlexFlow
    71  
    72  > DeleteFlexFlow(ctx, Sid)
    73  
    74  
    75  
    76  
    77  
    78  ### Path Parameters
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    84  **Sid** | **string** | The SID of the Flex Flow resource to delete.
    85  
    86  ### Other Parameters
    87  
    88  Other parameters are passed through a pointer to a DeleteFlexFlowParams struct
    89  
    90  
    91  Name | Type | Description
    92  ------------- | ------------- | -------------
    93  
    94  ### Return type
    95  
    96   (empty response body)
    97  
    98  ### Authorization
    99  
   100  [accountSid_authToken](../README.md#accountSid_authToken)
   101  
   102  ### HTTP request headers
   103  
   104  - **Content-Type**: Not defined
   105  - **Accept**: Not defined
   106  
   107  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   108  [[Back to Model list]](../README.md#documentation-for-models)
   109  [[Back to README]](../README.md)
   110  
   111  
   112  ## FetchFlexFlow
   113  
   114  > FlexV1FlexFlow FetchFlexFlow(ctx, Sid)
   115  
   116  
   117  
   118  
   119  
   120  ### Path Parameters
   121  
   122  
   123  Name | Type | Description
   124  ------------- | ------------- | -------------
   125  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   126  **Sid** | **string** | The SID of the Flex Flow resource to fetch.
   127  
   128  ### Other Parameters
   129  
   130  Other parameters are passed through a pointer to a FetchFlexFlowParams struct
   131  
   132  
   133  Name | Type | Description
   134  ------------- | ------------- | -------------
   135  
   136  ### Return type
   137  
   138  [**FlexV1FlexFlow**](FlexV1FlexFlow.md)
   139  
   140  ### Authorization
   141  
   142  [accountSid_authToken](../README.md#accountSid_authToken)
   143  
   144  ### HTTP request headers
   145  
   146  - **Content-Type**: Not defined
   147  - **Accept**: application/json
   148  
   149  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   150  [[Back to Model list]](../README.md#documentation-for-models)
   151  [[Back to README]](../README.md)
   152  
   153  
   154  ## ListFlexFlow
   155  
   156  > []FlexV1FlexFlow ListFlexFlow(ctx, optional)
   157  
   158  
   159  
   160  
   161  
   162  ### Path Parameters
   163  
   164  This endpoint does not need any path parameter.
   165  
   166  ### Other Parameters
   167  
   168  Other parameters are passed through a pointer to a ListFlexFlowParams struct
   169  
   170  
   171  Name | Type | Description
   172  ------------- | ------------- | -------------
   173  **FriendlyName** | **string** | The `friendly_name` of the Flex Flow resources to read.
   174  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   175  **Limit** | **int** | Max number of records to return.
   176  
   177  ### Return type
   178  
   179  [**[]FlexV1FlexFlow**](FlexV1FlexFlow.md)
   180  
   181  ### Authorization
   182  
   183  [accountSid_authToken](../README.md#accountSid_authToken)
   184  
   185  ### HTTP request headers
   186  
   187  - **Content-Type**: Not defined
   188  - **Accept**: application/json
   189  
   190  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   191  [[Back to Model list]](../README.md#documentation-for-models)
   192  [[Back to README]](../README.md)
   193  
   194  
   195  ## UpdateFlexFlow
   196  
   197  > FlexV1FlexFlow UpdateFlexFlow(ctx, Sidoptional)
   198  
   199  
   200  
   201  
   202  
   203  ### Path Parameters
   204  
   205  
   206  Name | Type | Description
   207  ------------- | ------------- | -------------
   208  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   209  **Sid** | **string** | The SID of the Flex Flow resource to update.
   210  
   211  ### Other Parameters
   212  
   213  Other parameters are passed through a pointer to a UpdateFlexFlowParams struct
   214  
   215  
   216  Name | Type | Description
   217  ------------- | ------------- | -------------
   218  **FriendlyName** | **string** | A descriptive string that you create to describe the Flex Flow resource.
   219  **ChatServiceSid** | **string** | The SID of the chat service.
   220  **ChannelType** | **string** | 
   221  **ContactIdentity** | **string** | The channel contact's Identity.
   222  **Enabled** | **bool** | Whether the new Flex Flow is enabled.
   223  **IntegrationType** | **string** | 
   224  **IntegrationFlowSid** | **string** | The SID of the Studio Flow. Required when `integrationType` is `studio`.
   225  **IntegrationUrl** | **string** | The URL of the external webhook. Required when `integrationType` is `external`.
   226  **IntegrationWorkspaceSid** | **string** | The Workspace SID for a new Task. Required when `integrationType` is `task`.
   227  **IntegrationWorkflowSid** | **string** | The Workflow SID for a new Task. Required when `integrationType` is `task`.
   228  **IntegrationChannel** | **string** | The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.
   229  **IntegrationTimeout** | **int** | The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.
   230  **IntegrationPriority** | **int** | The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.
   231  **IntegrationCreationOnMessage** | **bool** | In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
   232  **LongLived** | **bool** | When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.
   233  **JanitorEnabled** | **bool** | When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
   234  **IntegrationRetryCount** | **int** | The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise.
   235  
   236  ### Return type
   237  
   238  [**FlexV1FlexFlow**](FlexV1FlexFlow.md)
   239  
   240  ### Authorization
   241  
   242  [accountSid_authToken](../README.md#accountSid_authToken)
   243  
   244  ### HTTP request headers
   245  
   246  - **Content-Type**: application/x-www-form-urlencoded
   247  - **Accept**: application/json
   248  
   249  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   250  [[Back to Model list]](../README.md#documentation-for-models)
   251  [[Back to README]](../README.md)
   252