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

     1  # WebChannelsApi
     2  
     3  All URIs are relative to *https://flex-api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateWebChannel**](WebChannelsApi.md#CreateWebChannel) | **Post** /v1/WebChannels | 
     8  [**DeleteWebChannel**](WebChannelsApi.md#DeleteWebChannel) | **Delete** /v1/WebChannels/{Sid} | 
     9  [**FetchWebChannel**](WebChannelsApi.md#FetchWebChannel) | **Get** /v1/WebChannels/{Sid} | 
    10  [**ListWebChannel**](WebChannelsApi.md#ListWebChannel) | **Get** /v1/WebChannels | 
    11  [**UpdateWebChannel**](WebChannelsApi.md#UpdateWebChannel) | **Post** /v1/WebChannels/{Sid} | 
    12  
    13  
    14  
    15  ## CreateWebChannel
    16  
    17  > FlexV1WebChannel CreateWebChannel(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 CreateWebChannelParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **FlexFlowSid** | **string** | The SID of the Flex Flow.
    35  **Identity** | **string** | The chat identity.
    36  **CustomerFriendlyName** | **string** | The chat participant's friendly name.
    37  **ChatFriendlyName** | **string** | The chat channel's friendly name.
    38  **ChatUniqueName** | **string** | The chat channel's unique name.
    39  **PreEngagementData** | **string** | The pre-engagement data.
    40  
    41  ### Return type
    42  
    43  [**FlexV1WebChannel**](FlexV1WebChannel.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  ## DeleteWebChannel
    60  
    61  > DeleteWebChannel(ctx, Sid)
    62  
    63  
    64  
    65  
    66  
    67  ### Path Parameters
    68  
    69  
    70  Name | Type | Description
    71  ------------- | ------------- | -------------
    72  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    73  **Sid** | **string** | The SID of the WebChannel resource to delete.
    74  
    75  ### Other Parameters
    76  
    77  Other parameters are passed through a pointer to a DeleteWebChannelParams struct
    78  
    79  
    80  Name | Type | Description
    81  ------------- | ------------- | -------------
    82  
    83  ### Return type
    84  
    85   (empty response body)
    86  
    87  ### Authorization
    88  
    89  [accountSid_authToken](../README.md#accountSid_authToken)
    90  
    91  ### HTTP request headers
    92  
    93  - **Content-Type**: Not defined
    94  - **Accept**: Not defined
    95  
    96  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    97  [[Back to Model list]](../README.md#documentation-for-models)
    98  [[Back to README]](../README.md)
    99  
   100  
   101  ## FetchWebChannel
   102  
   103  > FlexV1WebChannel FetchWebChannel(ctx, Sid)
   104  
   105  
   106  
   107  
   108  
   109  ### Path Parameters
   110  
   111  
   112  Name | Type | Description
   113  ------------- | ------------- | -------------
   114  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   115  **Sid** | **string** | The SID of the WebChannel resource to fetch.
   116  
   117  ### Other Parameters
   118  
   119  Other parameters are passed through a pointer to a FetchWebChannelParams struct
   120  
   121  
   122  Name | Type | Description
   123  ------------- | ------------- | -------------
   124  
   125  ### Return type
   126  
   127  [**FlexV1WebChannel**](FlexV1WebChannel.md)
   128  
   129  ### Authorization
   130  
   131  [accountSid_authToken](../README.md#accountSid_authToken)
   132  
   133  ### HTTP request headers
   134  
   135  - **Content-Type**: Not defined
   136  - **Accept**: application/json
   137  
   138  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   139  [[Back to Model list]](../README.md#documentation-for-models)
   140  [[Back to README]](../README.md)
   141  
   142  
   143  ## ListWebChannel
   144  
   145  > []FlexV1WebChannel ListWebChannel(ctx, optional)
   146  
   147  
   148  
   149  
   150  
   151  ### Path Parameters
   152  
   153  This endpoint does not need any path parameter.
   154  
   155  ### Other Parameters
   156  
   157  Other parameters are passed through a pointer to a ListWebChannelParams struct
   158  
   159  
   160  Name | Type | Description
   161  ------------- | ------------- | -------------
   162  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   163  **Limit** | **int** | Max number of records to return.
   164  
   165  ### Return type
   166  
   167  [**[]FlexV1WebChannel**](FlexV1WebChannel.md)
   168  
   169  ### Authorization
   170  
   171  [accountSid_authToken](../README.md#accountSid_authToken)
   172  
   173  ### HTTP request headers
   174  
   175  - **Content-Type**: Not defined
   176  - **Accept**: application/json
   177  
   178  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   179  [[Back to Model list]](../README.md#documentation-for-models)
   180  [[Back to README]](../README.md)
   181  
   182  
   183  ## UpdateWebChannel
   184  
   185  > FlexV1WebChannel UpdateWebChannel(ctx, Sidoptional)
   186  
   187  
   188  
   189  
   190  
   191  ### Path Parameters
   192  
   193  
   194  Name | Type | Description
   195  ------------- | ------------- | -------------
   196  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   197  **Sid** | **string** | The SID of the WebChannel resource to update.
   198  
   199  ### Other Parameters
   200  
   201  Other parameters are passed through a pointer to a UpdateWebChannelParams struct
   202  
   203  
   204  Name | Type | Description
   205  ------------- | ------------- | -------------
   206  **ChatStatus** | **string** | 
   207  **PostEngagementData** | **string** | The post-engagement data.
   208  
   209  ### Return type
   210  
   211  [**FlexV1WebChannel**](FlexV1WebChannel.md)
   212  
   213  ### Authorization
   214  
   215  [accountSid_authToken](../README.md#accountSid_authToken)
   216  
   217  ### HTTP request headers
   218  
   219  - **Content-Type**: application/x-www-form-urlencoded
   220  - **Accept**: application/json
   221  
   222  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   223  [[Back to Model list]](../README.md#documentation-for-models)
   224  [[Back to README]](../README.md)
   225