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

     1  # InteractionsChannelsParticipantsApi
     2  
     3  All URIs are relative to *https://flex-api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateInteractionChannelParticipant**](InteractionsChannelsParticipantsApi.md#CreateInteractionChannelParticipant) | **Post** /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants | 
     8  [**ListInteractionChannelParticipant**](InteractionsChannelsParticipantsApi.md#ListInteractionChannelParticipant) | **Get** /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants | 
     9  [**UpdateInteractionChannelParticipant**](InteractionsChannelsParticipantsApi.md#UpdateInteractionChannelParticipant) | **Post** /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid} | 
    10  
    11  
    12  
    13  ## CreateInteractionChannelParticipant
    14  
    15  > FlexV1InteractionChannelParticipant CreateInteractionChannelParticipant(ctx, InteractionSidChannelSidoptional)
    16  
    17  
    18  
    19  Add a Participant to a Channel.
    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 Interaction Sid for the new Channel Participant.
    28  **ChannelSid** | **string** | The Channel Sid for the new Channel Participant.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateInteractionChannelParticipantParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **Type** | **string** | 
    38  **MediaProperties** | [**interface{}**](interface{}.md) | JSON representing the Media Properties for the new Participant.
    39  **RoutingProperties** | [**interface{}**](interface{}.md) | Object representing the Routing Properties for the new Participant.
    40  
    41  ### Return type
    42  
    43  [**FlexV1InteractionChannelParticipant**](FlexV1InteractionChannelParticipant.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  ## ListInteractionChannelParticipant
    60  
    61  > []FlexV1InteractionChannelParticipant ListInteractionChannelParticipant(ctx, InteractionSidChannelSidoptional)
    62  
    63  
    64  
    65  List all Participants for a Channel.
    66  
    67  ### Path Parameters
    68  
    69  
    70  Name | Type | Description
    71  ------------- | ------------- | -------------
    72  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    73  **InteractionSid** | **string** | The Interaction Sid for this channel.
    74  **ChannelSid** | **string** | The Channel Sid for this Participant.
    75  
    76  ### Other Parameters
    77  
    78  Other parameters are passed through a pointer to a ListInteractionChannelParticipantParams struct
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    84  **Limit** | **int** | Max number of records to return.
    85  
    86  ### Return type
    87  
    88  [**[]FlexV1InteractionChannelParticipant**](FlexV1InteractionChannelParticipant.md)
    89  
    90  ### Authorization
    91  
    92  [accountSid_authToken](../README.md#accountSid_authToken)
    93  
    94  ### HTTP request headers
    95  
    96  - **Content-Type**: Not defined
    97  - **Accept**: application/json
    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  ## UpdateInteractionChannelParticipant
   105  
   106  > FlexV1InteractionChannelParticipant UpdateInteractionChannelParticipant(ctx, InteractionSidChannelSidSidoptional)
   107  
   108  
   109  
   110  Update an existing Channel Participant.
   111  
   112  ### Path Parameters
   113  
   114  
   115  Name | Type | Description
   116  ------------- | ------------- | -------------
   117  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   118  **InteractionSid** | **string** | The Interaction Sid for this channel.
   119  **ChannelSid** | **string** | The Channel Sid for this Participant.
   120  **Sid** | **string** | The unique string created by Twilio to identify an Interaction Channel resource.
   121  
   122  ### Other Parameters
   123  
   124  Other parameters are passed through a pointer to a UpdateInteractionChannelParticipantParams struct
   125  
   126  
   127  Name | Type | Description
   128  ------------- | ------------- | -------------
   129  **Status** | **string** | 
   130  
   131  ### Return type
   132  
   133  [**FlexV1InteractionChannelParticipant**](FlexV1InteractionChannelParticipant.md)
   134  
   135  ### Authorization
   136  
   137  [accountSid_authToken](../README.md#accountSid_authToken)
   138  
   139  ### HTTP request headers
   140  
   141  - **Content-Type**: application/x-www-form-urlencoded
   142  - **Accept**: application/json
   143  
   144  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   145  [[Back to Model list]](../README.md#documentation-for-models)
   146  [[Back to README]](../README.md)
   147