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

     1  # RoomsParticipantsApi
     2  
     3  All URIs are relative to *https://video.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchRoomParticipant**](RoomsParticipantsApi.md#FetchRoomParticipant) | **Get** /v1/Rooms/{RoomSid}/Participants/{Sid} | 
     8  [**ListRoomParticipant**](RoomsParticipantsApi.md#ListRoomParticipant) | **Get** /v1/Rooms/{RoomSid}/Participants | 
     9  [**UpdateRoomParticipant**](RoomsParticipantsApi.md#UpdateRoomParticipant) | **Post** /v1/Rooms/{RoomSid}/Participants/{Sid} | 
    10  
    11  
    12  
    13  ## FetchRoomParticipant
    14  
    15  > VideoV1RoomParticipant FetchRoomParticipant(ctx, RoomSidSid)
    16  
    17  
    18  
    19  
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **RoomSid** | **string** | The SID of the room with the Participant resource to fetch.
    28  **Sid** | **string** | The SID of the RoomParticipant resource to fetch.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a FetchRoomParticipantParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  
    38  ### Return type
    39  
    40  [**VideoV1RoomParticipant**](VideoV1RoomParticipant.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  ## ListRoomParticipant
    57  
    58  > []VideoV1RoomParticipant ListRoomParticipant(ctx, RoomSidoptional)
    59  
    60  
    61  
    62  
    63  
    64  ### Path Parameters
    65  
    66  
    67  Name | Type | Description
    68  ------------- | ------------- | -------------
    69  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    70  **RoomSid** | **string** | The SID of the room with the Participant resources to read.
    71  
    72  ### Other Parameters
    73  
    74  Other parameters are passed through a pointer to a ListRoomParticipantParams struct
    75  
    76  
    77  Name | Type | Description
    78  ------------- | ------------- | -------------
    79  **Status** | **string** | Read only the participants with this status. Can be: `connected` or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned.
    80  **Identity** | **string** | Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value.
    81  **DateCreatedAfter** | **time.Time** | Read only Participants that started after this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format.
    82  **DateCreatedBefore** | **time.Time** | Read only Participants that started before this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format.
    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  [**[]VideoV1RoomParticipant**](VideoV1RoomParticipant.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  ## UpdateRoomParticipant
   105  
   106  > VideoV1RoomParticipant UpdateRoomParticipant(ctx, RoomSidSidoptional)
   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  **RoomSid** | **string** | The SID of the room with the participant to update.
   119  **Sid** | **string** | The SID of the RoomParticipant resource to update.
   120  
   121  ### Other Parameters
   122  
   123  Other parameters are passed through a pointer to a UpdateRoomParticipantParams struct
   124  
   125  
   126  Name | Type | Description
   127  ------------- | ------------- | -------------
   128  **Status** | **string** | 
   129  
   130  ### Return type
   131  
   132  [**VideoV1RoomParticipant**](VideoV1RoomParticipant.md)
   133  
   134  ### Authorization
   135  
   136  [accountSid_authToken](../README.md#accountSid_authToken)
   137  
   138  ### HTTP request headers
   139  
   140  - **Content-Type**: application/x-www-form-urlencoded
   141  - **Accept**: application/json
   142  
   143  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   144  [[Back to Model list]](../README.md#documentation-for-models)
   145  [[Back to README]](../README.md)
   146