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

     1  # ServicesChannelsMembersApi
     2  
     3  All URIs are relative to *https://chat.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateMember**](ServicesChannelsMembersApi.md#CreateMember) | **Post** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members | 
     8  [**DeleteMember**](ServicesChannelsMembersApi.md#DeleteMember) | **Delete** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 
     9  [**FetchMember**](ServicesChannelsMembersApi.md#FetchMember) | **Get** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 
    10  [**ListMember**](ServicesChannelsMembersApi.md#ListMember) | **Get** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members | 
    11  [**UpdateMember**](ServicesChannelsMembersApi.md#UpdateMember) | **Post** /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid} | 
    12  
    13  
    14  
    15  ## CreateMember
    16  
    17  > ChatV1Member CreateMember(ctx, ServiceSidChannelSidoptional)
    18  
    19  
    20  
    21  
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.
    30  **ChannelSid** | **string** | The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new member belongs to. Can be the Channel resource's `sid` or `unique_name`.
    31  
    32  ### Other Parameters
    33  
    34  Other parameters are passed through a pointer to a CreateMemberParams struct
    35  
    36  
    37  Name | Type | Description
    38  ------------- | ------------- | -------------
    39  **Identity** | **string** | The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.
    40  **RoleSid** | **string** | The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).
    41  
    42  ### Return type
    43  
    44  [**ChatV1Member**](ChatV1Member.md)
    45  
    46  ### Authorization
    47  
    48  [accountSid_authToken](../README.md#accountSid_authToken)
    49  
    50  ### HTTP request headers
    51  
    52  - **Content-Type**: application/x-www-form-urlencoded
    53  - **Accept**: application/json
    54  
    55  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    56  [[Back to Model list]](../README.md#documentation-for-models)
    57  [[Back to README]](../README.md)
    58  
    59  
    60  ## DeleteMember
    61  
    62  > DeleteMember(ctx, ServiceSidChannelSidSid)
    63  
    64  
    65  
    66  
    67  
    68  ### Path Parameters
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.
    75  **ChannelSid** | **string** | The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message belongs to.  Can be the Channel's `sid` or `unique_name`.
    76  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Member resource to delete.
    77  
    78  ### Other Parameters
    79  
    80  Other parameters are passed through a pointer to a DeleteMemberParams 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  ## FetchMember
   105  
   106  > ChatV1Member FetchMember(ctx, ServiceSidChannelSidSid)
   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  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.
   119  **ChannelSid** | **string** | The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to fetch belongs to. Can be the Channel resource's `sid` or `unique_name` value.
   120  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Member resource to fetch.
   121  
   122  ### Other Parameters
   123  
   124  Other parameters are passed through a pointer to a FetchMemberParams struct
   125  
   126  
   127  Name | Type | Description
   128  ------------- | ------------- | -------------
   129  
   130  ### Return type
   131  
   132  [**ChatV1Member**](ChatV1Member.md)
   133  
   134  ### Authorization
   135  
   136  [accountSid_authToken](../README.md#accountSid_authToken)
   137  
   138  ### HTTP request headers
   139  
   140  - **Content-Type**: Not defined
   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  
   147  
   148  ## ListMember
   149  
   150  > []ChatV1Member ListMember(ctx, ServiceSidChannelSidoptional)
   151  
   152  
   153  
   154  
   155  
   156  ### Path Parameters
   157  
   158  
   159  Name | Type | Description
   160  ------------- | ------------- | -------------
   161  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   162  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.
   163  **ChannelSid** | **string** | The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the members to read belong to. Can be the Channel resource's `sid` or `unique_name` value.
   164  
   165  ### Other Parameters
   166  
   167  Other parameters are passed through a pointer to a ListMemberParams struct
   168  
   169  
   170  Name | Type | Description
   171  ------------- | ------------- | -------------
   172  **Identity** | **[]string** | The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.
   173  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   174  **Limit** | **int** | Max number of records to return.
   175  
   176  ### Return type
   177  
   178  [**[]ChatV1Member**](ChatV1Member.md)
   179  
   180  ### Authorization
   181  
   182  [accountSid_authToken](../README.md#accountSid_authToken)
   183  
   184  ### HTTP request headers
   185  
   186  - **Content-Type**: Not defined
   187  - **Accept**: application/json
   188  
   189  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   190  [[Back to Model list]](../README.md#documentation-for-models)
   191  [[Back to README]](../README.md)
   192  
   193  
   194  ## UpdateMember
   195  
   196  > ChatV1Member UpdateMember(ctx, ServiceSidChannelSidSidoptional)
   197  
   198  
   199  
   200  
   201  
   202  ### Path Parameters
   203  
   204  
   205  Name | Type | Description
   206  ------------- | ------------- | -------------
   207  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   208  **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.
   209  **ChannelSid** | **string** | The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to update belongs to. Can be the Channel resource's `sid` or `unique_name`.
   210  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Member resource to update.
   211  
   212  ### Other Parameters
   213  
   214  Other parameters are passed through a pointer to a UpdateMemberParams struct
   215  
   216  
   217  Name | Type | Description
   218  ------------- | ------------- | -------------
   219  **RoleSid** | **string** | The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).
   220  **LastConsumedMessageIndex** | **int** | The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels).
   221  
   222  ### Return type
   223  
   224  [**ChatV1Member**](ChatV1Member.md)
   225  
   226  ### Authorization
   227  
   228  [accountSid_authToken](../README.md#accountSid_authToken)
   229  
   230  ### HTTP request headers
   231  
   232  - **Content-Type**: application/x-www-form-urlencoded
   233  - **Accept**: application/json
   234  
   235  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   236  [[Back to Model list]](../README.md#documentation-for-models)
   237  [[Back to README]](../README.md)
   238