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

     1  # FlowsEngagementsApi
     2  
     3  All URIs are relative to *https://studio.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateEngagement**](FlowsEngagementsApi.md#CreateEngagement) | **Post** /v1/Flows/{FlowSid}/Engagements | 
     8  [**DeleteEngagement**](FlowsEngagementsApi.md#DeleteEngagement) | **Delete** /v1/Flows/{FlowSid}/Engagements/{Sid} | 
     9  [**FetchEngagement**](FlowsEngagementsApi.md#FetchEngagement) | **Get** /v1/Flows/{FlowSid}/Engagements/{Sid} | 
    10  [**ListEngagement**](FlowsEngagementsApi.md#ListEngagement) | **Get** /v1/Flows/{FlowSid}/Engagements | 
    11  
    12  
    13  
    14  ## CreateEngagement
    15  
    16  > StudioV1Engagement CreateEngagement(ctx, FlowSidoptional)
    17  
    18  
    19  
    20  Triggers a new Engagement for the Flow
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **FlowSid** | **string** | The SID of the Flow.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateEngagementParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **To** | **string** | The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`.
    38  **From** | **string** | The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}`
    39  **Parameters** | [**interface{}**](interface{}.md) | A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.
    40  
    41  ### Return type
    42  
    43  [**StudioV1Engagement**](StudioV1Engagement.md)
    44  
    45  ### Authorization
    46  
    47  [accountSid_authToken](../README.md#accountSid_authToken)
    48  
    49  ### HTTP request headers
    50  
    51  - **Content-Type**: application/x-www-form-urlencoded
    52  - **Accept**: application/json
    53  
    54  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    55  [[Back to Model list]](../README.md#documentation-for-models)
    56  [[Back to README]](../README.md)
    57  
    58  
    59  ## DeleteEngagement
    60  
    61  > DeleteEngagement(ctx, FlowSidSid)
    62  
    63  
    64  
    65  Delete this Engagement and all Steps relating to it.
    66  
    67  ### Path Parameters
    68  
    69  
    70  Name | Type | Description
    71  ------------- | ------------- | -------------
    72  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    73  **FlowSid** | **string** | The SID of the Flow to delete Engagements from.
    74  **Sid** | **string** | The SID of the Engagement resource to delete.
    75  
    76  ### Other Parameters
    77  
    78  Other parameters are passed through a pointer to a DeleteEngagementParams struct
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  
    84  ### Return type
    85  
    86   (empty response body)
    87  
    88  ### Authorization
    89  
    90  [accountSid_authToken](../README.md#accountSid_authToken)
    91  
    92  ### HTTP request headers
    93  
    94  - **Content-Type**: Not defined
    95  - **Accept**: Not defined
    96  
    97  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    98  [[Back to Model list]](../README.md#documentation-for-models)
    99  [[Back to README]](../README.md)
   100  
   101  
   102  ## FetchEngagement
   103  
   104  > StudioV1Engagement FetchEngagement(ctx, FlowSidSid)
   105  
   106  
   107  
   108  Retrieve an Engagement
   109  
   110  ### Path Parameters
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116  **FlowSid** | **string** | The SID of the Flow.
   117  **Sid** | **string** | The SID of the Engagement resource to fetch.
   118  
   119  ### Other Parameters
   120  
   121  Other parameters are passed through a pointer to a FetchEngagementParams struct
   122  
   123  
   124  Name | Type | Description
   125  ------------- | ------------- | -------------
   126  
   127  ### Return type
   128  
   129  [**StudioV1Engagement**](StudioV1Engagement.md)
   130  
   131  ### Authorization
   132  
   133  [accountSid_authToken](../README.md#accountSid_authToken)
   134  
   135  ### HTTP request headers
   136  
   137  - **Content-Type**: Not defined
   138  - **Accept**: application/json
   139  
   140  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   141  [[Back to Model list]](../README.md#documentation-for-models)
   142  [[Back to README]](../README.md)
   143  
   144  
   145  ## ListEngagement
   146  
   147  > []StudioV1Engagement ListEngagement(ctx, FlowSidoptional)
   148  
   149  
   150  
   151  Retrieve a list of all Engagements for the Flow.
   152  
   153  ### Path Parameters
   154  
   155  
   156  Name | Type | Description
   157  ------------- | ------------- | -------------
   158  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   159  **FlowSid** | **string** | The SID of the Flow to read Engagements from.
   160  
   161  ### Other Parameters
   162  
   163  Other parameters are passed through a pointer to a ListEngagementParams struct
   164  
   165  
   166  Name | Type | Description
   167  ------------- | ------------- | -------------
   168  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   169  **Limit** | **int** | Max number of records to return.
   170  
   171  ### Return type
   172  
   173  [**[]StudioV1Engagement**](StudioV1Engagement.md)
   174  
   175  ### Authorization
   176  
   177  [accountSid_authToken](../README.md#accountSid_authToken)
   178  
   179  ### HTTP request headers
   180  
   181  - **Content-Type**: Not defined
   182  - **Accept**: application/json
   183  
   184  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   185  [[Back to Model list]](../README.md#documentation-for-models)
   186  [[Back to README]](../README.md)
   187