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

     1  # ChannelsApi
     2  
     3  All URIs are relative to *https://flex-api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateChannel**](ChannelsApi.md#CreateChannel) | **Post** /v1/Channels | 
     8  [**DeleteChannel**](ChannelsApi.md#DeleteChannel) | **Delete** /v1/Channels/{Sid} | 
     9  [**FetchChannel**](ChannelsApi.md#FetchChannel) | **Get** /v1/Channels/{Sid} | 
    10  [**ListChannel**](ChannelsApi.md#ListChannel) | **Get** /v1/Channels | 
    11  
    12  
    13  
    14  ## CreateChannel
    15  
    16  > FlexV1Channel CreateChannel(ctx, optional)
    17  
    18  
    19  
    20  
    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 CreateChannelParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **FlexFlowSid** | **string** | The SID of the Flex Flow.
    34  **Identity** | **string** | The `identity` value that uniquely identifies the new resource's chat User.
    35  **ChatUserFriendlyName** | **string** | The chat participant's friendly name.
    36  **ChatFriendlyName** | **string** | The chat channel's friendly name.
    37  **Target** | **string** | The Target Contact Identity, for example the phone number of an SMS.
    38  **ChatUniqueName** | **string** | The chat channel's unique name.
    39  **PreEngagementData** | **string** | The pre-engagement data.
    40  **TaskSid** | **string** | The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`
    41  **TaskAttributes** | **string** | The Task attributes to be added for the TaskRouter Task.
    42  **LongLived** | **bool** | Whether to create the channel as long-lived.
    43  
    44  ### Return type
    45  
    46  [**FlexV1Channel**](FlexV1Channel.md)
    47  
    48  ### Authorization
    49  
    50  [accountSid_authToken](../README.md#accountSid_authToken)
    51  
    52  ### HTTP request headers
    53  
    54  - **Content-Type**: application/x-www-form-urlencoded
    55  - **Accept**: application/json
    56  
    57  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    58  [[Back to Model list]](../README.md#documentation-for-models)
    59  [[Back to README]](../README.md)
    60  
    61  
    62  ## DeleteChannel
    63  
    64  > DeleteChannel(ctx, Sid)
    65  
    66  
    67  
    68  
    69  
    70  ### Path Parameters
    71  
    72  
    73  Name | Type | Description
    74  ------------- | ------------- | -------------
    75  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    76  **Sid** | **string** | The SID of the Flex chat channel resource to delete.
    77  
    78  ### Other Parameters
    79  
    80  Other parameters are passed through a pointer to a DeleteChannelParams struct
    81  
    82  
    83  Name | Type | Description
    84  ------------- | ------------- | -------------
    85  
    86  ### Return type
    87  
    88   (empty response body)
    89  
    90  ### Authorization
    91  
    92  [accountSid_authToken](../README.md#accountSid_authToken)
    93  
    94  ### HTTP request headers
    95  
    96  - **Content-Type**: Not defined
    97  - **Accept**: Not defined
    98  
    99  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   100  [[Back to Model list]](../README.md#documentation-for-models)
   101  [[Back to README]](../README.md)
   102  
   103  
   104  ## FetchChannel
   105  
   106  > FlexV1Channel FetchChannel(ctx, Sid)
   107  
   108  
   109  
   110  
   111  
   112  ### Path Parameters
   113  
   114  
   115  Name | Type | Description
   116  ------------- | ------------- | -------------
   117  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   118  **Sid** | **string** | The SID of the Flex chat channel resource to fetch.
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a FetchChannelParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  
   128  ### Return type
   129  
   130  [**FlexV1Channel**](FlexV1Channel.md)
   131  
   132  ### Authorization
   133  
   134  [accountSid_authToken](../README.md#accountSid_authToken)
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144  
   145  
   146  ## ListChannel
   147  
   148  > []FlexV1Channel ListChannel(ctx, optional)
   149  
   150  
   151  
   152  
   153  
   154  ### Path Parameters
   155  
   156  This endpoint does not need any path parameter.
   157  
   158  ### Other Parameters
   159  
   160  Other parameters are passed through a pointer to a ListChannelParams struct
   161  
   162  
   163  Name | Type | Description
   164  ------------- | ------------- | -------------
   165  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   166  **Limit** | **int** | Max number of records to return.
   167  
   168  ### Return type
   169  
   170  [**[]FlexV1Channel**](FlexV1Channel.md)
   171  
   172  ### Authorization
   173  
   174  [accountSid_authToken](../README.md#accountSid_authToken)
   175  
   176  ### HTTP request headers
   177  
   178  - **Content-Type**: Not defined
   179  - **Accept**: application/json
   180  
   181  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   182  [[Back to Model list]](../README.md#documentation-for-models)
   183  [[Back to README]](../README.md)
   184