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

     1  # InteractionsChannelsApi
     2  
     3  All URIs are relative to *https://flex-api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchInteractionChannel**](InteractionsChannelsApi.md#FetchInteractionChannel) | **Get** /v1/Interactions/{InteractionSid}/Channels/{Sid} | 
     8  [**ListInteractionChannel**](InteractionsChannelsApi.md#ListInteractionChannel) | **Get** /v1/Interactions/{InteractionSid}/Channels | 
     9  [**UpdateInteractionChannel**](InteractionsChannelsApi.md#UpdateInteractionChannel) | **Post** /v1/Interactions/{InteractionSid}/Channels/{Sid} | 
    10  
    11  
    12  
    13  ## FetchInteractionChannel
    14  
    15  > FlexV1InteractionChannel FetchInteractionChannel(ctx, InteractionSidSid)
    16  
    17  
    18  
    19  Fetch a Channel for an Interaction.
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **InteractionSid** | **string** | The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
    28  **Sid** | **string** | The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a FetchInteractionChannelParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  
    38  ### Return type
    39  
    40  [**FlexV1InteractionChannel**](FlexV1InteractionChannel.md)
    41  
    42  ### Authorization
    43  
    44  [accountSid_authToken](../README.md#accountSid_authToken)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: Not defined
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## ListInteractionChannel
    57  
    58  > []FlexV1InteractionChannel ListInteractionChannel(ctx, InteractionSidoptional)
    59  
    60  
    61  
    62  List all Channels for an Interaction.
    63  
    64  ### Path Parameters
    65  
    66  
    67  Name | Type | Description
    68  ------------- | ------------- | -------------
    69  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    70  **InteractionSid** | **string** | The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
    71  
    72  ### Other Parameters
    73  
    74  Other parameters are passed through a pointer to a ListInteractionChannelParams struct
    75  
    76  
    77  Name | Type | Description
    78  ------------- | ------------- | -------------
    79  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    80  **Limit** | **int** | Max number of records to return.
    81  
    82  ### Return type
    83  
    84  [**[]FlexV1InteractionChannel**](FlexV1InteractionChannel.md)
    85  
    86  ### Authorization
    87  
    88  [accountSid_authToken](../README.md#accountSid_authToken)
    89  
    90  ### HTTP request headers
    91  
    92  - **Content-Type**: Not defined
    93  - **Accept**: application/json
    94  
    95  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    96  [[Back to Model list]](../README.md#documentation-for-models)
    97  [[Back to README]](../README.md)
    98  
    99  
   100  ## UpdateInteractionChannel
   101  
   102  > FlexV1InteractionChannel UpdateInteractionChannel(ctx, InteractionSidSidoptional)
   103  
   104  
   105  
   106  Update an existing Interaction Channel.
   107  
   108  ### Path Parameters
   109  
   110  
   111  Name | Type | Description
   112  ------------- | ------------- | -------------
   113  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   114  **InteractionSid** | **string** | The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
   115  **Sid** | **string** | The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.
   116  
   117  ### Other Parameters
   118  
   119  Other parameters are passed through a pointer to a UpdateInteractionChannelParams struct
   120  
   121  
   122  Name | Type | Description
   123  ------------- | ------------- | -------------
   124  **Status** | **string** | 
   125  **Routing** | [**interface{}**](interface{}.md) | It changes the state of associated tasks. Routing status is required, When the channel status is set to `inactive`. Allowed Value for routing status is `closed`. Otherwise Optional, if not specified, all tasks will be set to `wrapping`.
   126  
   127  ### Return type
   128  
   129  [**FlexV1InteractionChannel**](FlexV1InteractionChannel.md)
   130  
   131  ### Authorization
   132  
   133  [accountSid_authToken](../README.md#accountSid_authToken)
   134  
   135  ### HTTP request headers
   136  
   137  - **Content-Type**: application/x-www-form-urlencoded
   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